Instructions to use mlx-community/Inkling-mlx-4bit with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- MLX
How to use mlx-community/Inkling-mlx-4bit with MLX:
# Make sure mlx-lm is installed # pip install --upgrade mlx-lm # Generate text with mlx-lm from mlx_lm import load, generate model, tokenizer = load("mlx-community/Inkling-mlx-4bit") prompt = "Write a story about Einstein" messages = [{"role": "user", "content": prompt}] prompt = tokenizer.apply_chat_template( messages, add_generation_prompt=True ) text = generate(model, tokenizer, prompt=prompt, verbose=True) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- LM Studio
- Pi
How to use mlx-community/Inkling-mlx-4bit with Pi:
Start the MLX server
# Install MLX LM: uv tool install mlx-lm # Start a local OpenAI-compatible server: mlx_lm.server --model "mlx-community/Inkling-mlx-4bit"
Configure the model in Pi
# Install Pi: npm install -g @mariozechner/pi-coding-agent # Add to ~/.pi/agent/models.json: { "providers": { "mlx-lm": { "baseUrl": "http://localhost:8080/v1", "api": "openai-completions", "apiKey": "none", "models": [ { "id": "mlx-community/Inkling-mlx-4bit" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Hermes Agent new
How to use mlx-community/Inkling-mlx-4bit with Hermes Agent:
Start the MLX server
# Install MLX LM: uv tool install mlx-lm # Start a local OpenAI-compatible server: mlx_lm.server --model "mlx-community/Inkling-mlx-4bit"
Configure Hermes
# Install Hermes: curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash hermes setup # Point Hermes at the local server: hermes config set model.provider custom hermes config set model.base_url http://127.0.0.1:8080/v1 hermes config set model.default mlx-community/Inkling-mlx-4bit
Run Hermes
hermes
- OpenClaw new
How to use mlx-community/Inkling-mlx-4bit with OpenClaw:
Start the MLX server
# Install MLX LM: uv tool install mlx-lm # Start a local OpenAI-compatible server: mlx_lm.server --model "mlx-community/Inkling-mlx-4bit"
Configure OpenClaw
# Install OpenClaw: npm install -g openclaw@latest # Register the local server and set it as the default model: openclaw onboard --non-interactive --mode local \ --auth-choice custom-api-key \ --custom-base-url http://127.0.0.1:8080/v1 \ --custom-model-id "mlx-community/Inkling-mlx-4bit" \ --custom-provider-id mlx-lm \ --custom-compatibility openai \ --custom-text-input \ --accept-risk \ --skip-health
Run OpenClaw
openclaw agent --local --agent main --message "Hello from Hugging Face"
- MLX LM
How to use mlx-community/Inkling-mlx-4bit with MLX LM:
Generate or start a chat session
# Install MLX LM uv tool install mlx-lm # Interactive chat REPL mlx_lm.chat --model "mlx-community/Inkling-mlx-4bit"
Run an OpenAI-compatible server
# Install MLX LM uv tool install mlx-lm # Start the server mlx_lm.server --model "mlx-community/Inkling-mlx-4bit" # Calling the OpenAI-compatible server with curl curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "mlx-community/Inkling-mlx-4bit", "messages": [ {"role": "user", "content": "Hello"} ] }'
| {%- set effort_map = {"none": 0.0, "minimal": 0.1, "low": 0.2, "medium": 0.7, "high": 0.9, "max": 0.99} -%} | |
| {%- set role_token = {"user": "<|message_user|>", "assistant": "<|message_model|>", "system": "<|message_system|>", "tool": "<|message_tool|>"} -%} | |
| {%- macro emit_thinking_effort() -%} | |
| {%- set eff = reasoning_effort if reasoning_effort is defined and reasoning_effort is not none else 0.9 -%} | |
| {%- if eff is string -%} | |
| {%- set key = eff | trim -%} | |
| {%- if key not in effort_map -%} | |
| {{- raise_exception("Unknown reasoning_effort: " ~ eff) -}} | |
| {%- endif -%} | |
| {%- set num = effort_map[key] -%} | |
| {%- else -%} | |
| {%- set num = eff | float -%} | |
| {%- endif -%} | |
| {%- if num < 0.0 or num > 0.99 -%} | |
| {{- raise_exception("reasoning_effort must be in [0.0, 0.99]") -}} | |
| {%- endif -%} | |
| {{- "<|message_system|><|content_text|>Thinking effort level: " -}} | |
| {%- if num == 0.0 -%}0{%- else -%}{{ num }}{%- endif -%} | |
| {{- "<|end_message|>" -}} | |
| {%- endmacro -%} | |
| {%- if tools -%} | |
| {%- set tool_state = namespace(specs=[]) -%} | |
| {%- for tool in tools -%} | |
| {%- set fn = tool.function if tool.function is defined else tool -%} | |
| {%- set spec = { | |
| "description": (fn.description if fn.description is defined and fn.description else ""), | |
| "name": fn.name, | |
| "parameters": (fn.parameters if fn.parameters is defined and fn.parameters else {}), | |
| "type": (tool.type if tool.type is defined and tool.type else "function"), | |
| } -%} | |
| {%- set tool_state.specs = tool_state.specs + [spec] -%} | |
| {%- endfor -%} | |
| {{- "<|message_system|>tool_declare<|content_xml|>" -}} | |
| {{- tool_state.specs | tojson(sort_keys=true, separators=(",", ":")) -}} | |
| {{- "<|end_message|>" -}} | |
| {%- endif -%} | |
| {%- set state = namespace(effort_emitted=false) -%} | |
| {%- for message in messages -%} | |
| {%- if message.role not in role_token -%} | |
| {{- raise_exception("Unknown message role: " ~ message.role) -}} | |
| {%- endif -%} | |
| {%- if not state.effort_emitted and message.role != "system" -%} | |
| {{- emit_thinking_effort() -}} | |
| {%- set state.effort_emitted = true -%} | |
| {%- endif -%} | |
| {%- set rtok = role_token[message.role] -%} | |
| {%- if message.role == "tool" -%} | |
| {%- set tool_name_state = namespace(name="") -%} | |
| {%- if message.name is defined and message.name -%} | |
| {%- set tool_name_state.name = message.name -%} | |
| {%- elif message.tool_call_id is defined and message.tool_call_id -%} | |
| {%- for prev in messages -%} | |
| {%- if prev.role == "assistant" and prev.tool_calls -%} | |
| {%- for tc in prev.tool_calls -%} | |
| {%- if tc.id is defined and tc.id == message.tool_call_id and tc.function.name is defined -%} | |
| {%- set tool_name_state.name = tc.function.name -%} | |
| {%- endif -%} | |
| {%- endfor -%} | |
| {%- endif -%} | |
| {%- endfor -%} | |
| {%- endif -%} | |
| {{- rtok -}} | |
| {%- if tool_name_state.name -%}{{- tool_name_state.name -}}{%- endif -%} | |
| {{- "<|content_text|>" -}} | |
| {%- if message.content is string -%}{{- message.content -}}{%- endif -%} | |
| {{- "<|end_message|>" -}} | |
| {%- else -%} | |
| {%- if message.role == "assistant" and message.reasoning_content is defined and message.reasoning_content -%} | |
| {{- "<|message_model|><|content_thinking|>" ~ message.reasoning_content ~ "<|end_message|>" -}} | |
| {%- endif -%} | |
| {%- if message.content is string -%} | |
| {{- rtok ~ "<|content_text|>" ~ message.content ~ "<|end_message|>" -}} | |
| {%- elif message.content -%} | |
| {%- for part in message.content -%} | |
| {%- if part is string -%} | |
| {{- rtok ~ "<|content_text|>" ~ part ~ "<|end_message|>" -}} | |
| {%- elif part.type is not defined or part.type in ("text", "input_text") -%} | |
| {%- set text_part = (part.text if part.text is defined and part.text is string else "") -%} | |
| {{- rtok ~ "<|content_text|>" ~ text_part ~ "<|end_message|>" -}} | |
| {%- elif part.type in ("image", "input_image", "image_url") -%} | |
| {{- rtok ~ "<|content_image|><|unused_200054|><|end_message|>" -}} | |
| {%- elif part.type in ("audio", "input_audio", "audio_url") -%} | |
| {{- rtok ~ "<|content_audio_input|><|unused_200053|><|audio_end|><|end_message|>" -}} | |
| {%- else -%} | |
| {{- raise_exception("Unsupported content part type: " ~ part.type) -}} | |
| {%- endif -%} | |
| {%- endfor -%} | |
| {%- endif -%} | |
| {%- if message.role == "assistant" and message.tool_calls -%} | |
| {%- for tc in message.tool_calls -%} | |
| {%- set fn = tc.function -%} | |
| {%- if fn.name is not defined or fn.name is not string -%} | |
| {{- raise_exception("tool call function name must be a string") -}} | |
| {%- endif -%} | |
| {%- set args = fn.arguments if fn.arguments is defined and fn.arguments else {} -%} | |
| {%- if args is string -%} | |
| {{- raise_exception("tool call arguments must be a parsed object, not a JSON string; canonicalize upstream") -}} | |
| {%- endif -%} | |
| {%- if args is not mapping -%} | |
| {{- raise_exception("tool call arguments must be an object") -}} | |
| {%- endif -%} | |
| {{- "<|message_model|>" ~ fn.name ~ "<|content_invoke_tool_json|>" -}} | |
| {{- '{"name":' ~ (fn.name | tojson(sort_keys=true, separators=(",", ":"))) ~ ',"args":' -}} | |
| {{- (args | tojson(sort_keys=true, separators=(",", ":"))) -}} | |
| {{- "}<|end_message|>" -}} | |
| {%- endfor -%} | |
| {%- endif -%} | |
| {%- if message.role == "assistant" -%} | |
| {{- "<|content_model_end_sampling|>" -}} | |
| {%- endif -%} | |
| {%- endif -%} | |
| {%- endfor -%} | |
| {%- if not state.effort_emitted -%} | |
| {{- emit_thinking_effort() -}} | |
| {%- endif -%} | |
| {%- if add_generation_prompt -%} | |
| {{- "<|message_model|>" -}} | |
| {%- endif -%} | |