Instructions to use IFM/K2-Chat with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use IFM/K2-Chat with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="IFM/K2-Chat")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("IFM/K2-Chat")
model = AutoModelForCausalLM.from_pretrained("IFM/K2-Chat", device_map="auto")
messages = [
    {"role": "user", "content": "Who are you?"},
]
inputs = tokenizer.apply_chat_template(
	messages,
	add_generation_prompt=True,
	tokenize=True,
	return_dict=True,
	return_tensors="pt",
).to(model.device)

outputs = model.generate(**inputs, max_new_tokens=40)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use IFM/K2-Chat with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "IFM/K2-Chat"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "IFM/K2-Chat",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/IFM/K2-Chat

SGLang

How to use IFM/K2-Chat with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "IFM/K2-Chat" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "IFM/K2-Chat",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "IFM/K2-Chat" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "IFM/K2-Chat",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use IFM/K2-Chat with Docker Model Runner:
```
docker model run hf.co/IFM/K2-Chat
```

K2-Chat / tokenizer_config.json

mylibrar

Upload tokenizer

aaf824f verified about 2 years ago

Raw

History Blame

5.38 kB

	{
	"add_bos_token": false,
	"add_eos_token": false,
	"added_tokens_decoder": {
	"0": {
	"content": "<unk>",
	"lstrip": false,
	"normalized": true,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"1": {
	"content": "<s>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": false
	},
	"2": {
	"content": "<\|endoftext\|>",
	"lstrip": false,
	"normalized": true,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32000": {
	"content": "<fim_prefix>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32001": {
	"content": "<fim_middle>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32002": {
	"content": "<fim_suffix>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32003": {
	"content": "<fim_pad>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32004": {
	"content": "<filename>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32005": {
	"content": "<gh_stars>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32006": {
	"content": "<issue_start>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32007": {
	"content": "<issue_comment>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32008": {
	"content": "<issue_closed>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32009": {
	"content": "<jupyter_start>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32010": {
	"content": "<jupyter_text>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32011": {
	"content": "<jupyter_code>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32012": {
	"content": "<jupyter_output>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32013": {
	"content": "<empty_output>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32014": {
	"content": "<commit_before>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32015": {
	"content": "<commit_msg>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32016": {
	"content": "<commit_after>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32017": {
	"content": "<reponame>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32018": {
	"content": "<\|endofsystemprompt\|>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32019": {
	"content": "<\|beginofsystem\|>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32020": {
	"content": "<\|beginofuser\|>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	},
	"32021": {
	"content": "<\|endofchat\|>",
	"lstrip": false,
	"normalized": false,
	"rstrip": false,
	"single_word": false,
	"special": true
	}
	},
	"additional_special_tokens": [
	"<\|endofsystemprompt\|>",
	"<\|beginofsystem\|>",
	"<\|beginofuser\|>",
	"<\|endofchat\|>"
	],
	"bos_token": "<\|endoftext\|>",
	"chat_template": "{% for message in messages %}{% if message['role'] == 'user' %}{{ '<\|beginofuser\|>' + message['content'] }}{% elif message['role'] == 'system' %}{{ message['content'] + '<\|endofsystemprompt\|>' }}{% elif message['role'] == 'assistant' %}{{ '<\|beginofsystem\|>' + message['content'] }}{% endif %}{% if loop.last and add_generation_prompt %}{{ '<\|beginofsystem\|>' }}{% endif %}{% endfor %}",
	"clean_up_tokenization_spaces": false,
	"eos_token": "<\|endoftext\|>",
	"legacy": true,
	"model_max_length": 8192,
	"pad_token": null,
	"sp_model_kwargs": {},
	"tokenizer_class": "LlamaTokenizer",
	"unk_token": "<unk>",
	"use_default_system_prompt": false
	}