Instructions to use mlx-community/RakutenAI-3.0-MLX-4bit with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use mlx-community/RakutenAI-3.0-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/RakutenAI-3.0-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

How to use mlx-community/RakutenAI-3.0-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/RakutenAI-3.0-MLX-4bit"

Configure the model in Pi

# Install Pi:
npm install -g @earendil-works/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/RakutenAI-3.0-MLX-4bit"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

MLX LM

How to use mlx-community/RakutenAI-3.0-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/RakutenAI-3.0-MLX-4bit"

Run an OpenAI-compatible server

# Install MLX LM
uv tool install mlx-lm
# Start the server
mlx_lm.server --model "mlx-community/RakutenAI-3.0-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/RakutenAI-3.0-MLX-4bit",
     "messages": [
       {"role": "user", "content": "Hello"}
     ]
   }'

Hermes Agent

How to use mlx-community/RakutenAI-3.0-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/RakutenAI-3.0-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/RakutenAI-3.0-MLX-4bit

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use mlx-community/RakutenAI-3.0-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/RakutenAI-3.0-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/RakutenAI-3.0-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"

RakutenAI-3.0-MLX-4bit / README.md

limegreenpeper1

Update README.md

4bf9e94 verified 8 months ago

preview code

Raw History Blame Contribute Delete

1 kB

metadata

license: apache-2.0
license_link: https://huggingface.co/Rakuten/RakutenAI-3.0/blob/main/NOTICE
tags:
  - mlx
pipeline_tag: text-generation
library_name: mlx
language:
  - en
  - ja
base_model:
  - Rakuten/RakutenAI-3.0

This model was converted to MLX format from Rakuten/RakutenAI-3.0 using mlx-lm version 0.31.0. Refer to the original model card for more details on the model.

Convert:❯ mlx_lm.convert --hf-path ./RakutenAI-3.0 --mlx-path ./lm-studio/models/limegreenpeper1/rakutenai3-mlx-4bit -q --q-bits 4 --trust-remote-code

[INFO] Loading rope_parameters's factor field must be a float >= 1, got 40 rope_parameters's beta_fast field must be a float, got 32 rope_parameters's beta_slow field must be a float, got 1 [INFO] Using dtype: bfloat16 [INFO] Quantizing [INFO] Quantized model with 4.502 bits per weight.

Inference: 20.06 tok/sec M3 Ultra (CTX 128K - LM Studio MLX v1.3.0)