Instructions to use HelpingAI/hai3.1-checkpoint-0002 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use HelpingAI/hai3.1-checkpoint-0002 with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="HelpingAI/hai3.1-checkpoint-0002", trust_remote_code=True) messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# Load model directly from transformers import AutoModelForCausalLM model = AutoModelForCausalLM.from_pretrained("HelpingAI/hai3.1-checkpoint-0002", trust_remote_code=True, device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use HelpingAI/hai3.1-checkpoint-0002 with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "HelpingAI/hai3.1-checkpoint-0002" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "HelpingAI/hai3.1-checkpoint-0002", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/HelpingAI/hai3.1-checkpoint-0002
- SGLang
How to use HelpingAI/hai3.1-checkpoint-0002 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 "HelpingAI/hai3.1-checkpoint-0002" \ --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": "HelpingAI/hai3.1-checkpoint-0002", "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 "HelpingAI/hai3.1-checkpoint-0002" \ --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": "HelpingAI/hai3.1-checkpoint-0002", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Docker Model Runner
How to use HelpingAI/hai3.1-checkpoint-0002 with Docker Model Runner:
docker model run hf.co/HelpingAI/hai3.1-checkpoint-0002
Download chat_template.jinja from HelpingAI/hai3.1-checkpoint-0002: direct link, hf CLI and curl.
- Browser
- Download file 4.84 kB
-
https://huggingface.co/HelpingAI/hai3.1-checkpoint-0002/resolve/main/chat_template.jinja
- Command line
-
hf download hf://HelpingAI/hai3.1-checkpoint-0002/chat_template.jinja
-
curl -L -o chat_template.jinja https://huggingface.co/HelpingAI/hai3.1-checkpoint-0002/resolve/main/chat_template.jinja
4.84 kB
| {%- set model_identity = "You are HelpingAI 3.1, the most emotionally intelligent and human-like AI model created by HelpingAI. Knowledge cutoff: 2024-01\nCurrent date: " + strftime_now("%Y-%m-%d") + "\n" %} | |
| {%- if tools %} | |
| {{- '<|im_start|>system\n' }} | |
| {{- model_identity }} | |
| {%- if messages[0].role == 'system' %} | |
| {{- messages[0].content + '\n\n' }} | |
| {%- endif %} | |
| {{- "# Tools\n\nYou may call one or more functions to assist with the user query.\n\nYou are provided with function signatures within <tools></tools> XML tags:\n<tools>" }} | |
| {%- for tool in tools %} | |
| {{- "\n" }} | |
| {{- tool | tojson }} | |
| {%- endfor %} | |
| {{- "\n</tools>\n\nFor each function call, return a json object with function name and arguments within <tool_call></tool_call> XML tags:\n<tool_call>\n{\"name\": <function-name>, \"arguments\": <args-json-object>}\n</tool_call><|im_end|>\n" }} | |
| {%- else %} | |
| {{- '<|im_start|>system\n' + model_identity }} | |
| {%- if messages[0].role == 'system' %} | |
| {{- messages[0].content + '<|im_end|>\n' }} | |
| {%- else %} | |
| {{- '<|im_end|>\n' }} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- set ns = namespace(multi_step_tool=true, last_query_index=messages|length - 1) %} | |
| {%- set last_tool_call = namespace(name=none) %} | |
| {%- set ns_assistant = namespace(open=false) %} | |
| {%- for forward_message in messages %} | |
| {%- set index = (messages|length - 1) - loop.index0 %} | |
| {%- set message = messages[index] %} | |
| {%- set current_content = message.content if message.content is not none else '' %} | |
| {%- set tool_start = '<tool_response>' %} | |
| {%- set tool_start_length = tool_start|length %} | |
| {%- set start_of_message = current_content[:tool_start_length] %} | |
| {%- set tool_end = '</tool_response>' %} | |
| {%- set tool_end_length = tool_end|length %} | |
| {%- set start_pos = (current_content|length) - tool_end_length %} | |
| {%- if start_pos < 0 %} | |
| {%- set start_pos = 0 %} | |
| {%- endif %} | |
| {%- set end_of_message = current_content[start_pos:] %} | |
| {%- if ns.multi_step_tool and message.role == "user" and not(start_of_message == tool_start and end_of_message == tool_end) %} | |
| {%- set ns.multi_step_tool = false %} | |
| {%- set ns.last_query_index = index %} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- for message in messages %} | |
| {%- if (message.role == "user") or (message.role == "system" and not loop.first) %} | |
| {%- if ns_assistant.open %} | |
| {{- '<|im_end|>\n' }} | |
| {%- set ns_assistant.open = false %} | |
| {%- endif %} | |
| {{- '<|im_start|>' + message.role + '\n' + message.content + '<|im_end|>' + '\n' }} | |
| {%- elif message.role == "assistant" %} | |
| {%- if not ns_assistant.open %} | |
| {{- '<|im_start|>assistant\n' }} | |
| {%- set ns_assistant.open = true %} | |
| {%- endif %} | |
| {%- if message.content %} | |
| {{- message.content }} | |
| {%- endif %} | |
| {%- if message.tool_calls %} | |
| {%- for tool_call in message.tool_calls %} | |
| {%- if (loop.first and content) or (not loop.first) %} | |
| {{- '\n' }} | |
| {%- endif %} | |
| {%- if tool_call.function %} | |
| {%- set tool_call = tool_call.function %} | |
| {%- endif %} | |
| {{- '<tool_call>\n{"name": "' }} | |
| {{- tool_call.name }} | |
| {{- '", "arguments": ' }} | |
| {%- if tool_call.arguments is string %} | |
| {{- tool_call.arguments }} | |
| {%- else %} | |
| {{- tool_call.arguments | tojson }} | |
| {%- endif %} | |
| {{- '}\n</tool_call>' }} | |
| {%- set last_tool_call.name = tool_call.name %} | |
| {%- endfor %} | |
| {%- else %} | |
| {%- set last_tool_call.name = none %} | |
| {%- endif %} | |
| {%- if loop.last or (messages[loop.index0 + 1].role not in ["assistant", "tool"]) %} | |
| {{- '<|im_end|>\n' }} | |
| {%- set ns_assistant.open = false %} | |
| {%- endif %} | |
| {%- elif message.role == "tool" %} | |
| {%- if last_tool_call.name is none %} | |
| {{- raise_exception("Message has tool role, but there was no previous assistant message with a tool call!") }} | |
| {%- endif %} | |
| {%- if not ns_assistant.open %} | |
| {{- '<|im_start|>assistant\n' }} | |
| {%- set ns_assistant.open = true %} | |
| {%- endif %} | |
| {{- '\n<tool_response>\n' }} | |
| {{- message.content }} | |
| {{- '\n</tool_response>' }} | |
| {%- if loop.last or (messages[loop.index0 + 1].role not in ["assistant", "tool"]) %} | |
| {{- '<|im_end|>\n' }} | |
| {%- set ns_assistant.open = false %} | |
| {%- endif %} | |
| {%- endif %} | |
| {%- endfor %} | |
| {%- if add_generation_prompt %} | |
| {{- '<|im_start|>assistant\n' }} | |
| {%- endif %} |