Instructions to use zimengxiong/WeDLM-8B-Instruct-MLX with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- MLX
How to use zimengxiong/WeDLM-8B-Instruct-MLX 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("zimengxiong/WeDLM-8B-Instruct-MLX") 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 zimengxiong/WeDLM-8B-Instruct-MLX with Pi:
Start the MLX server
# Install MLX LM: uv tool install mlx-lm # Start a local OpenAI-compatible server: mlx_lm.server --model "zimengxiong/WeDLM-8B-Instruct-MLX"
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": "zimengxiong/WeDLM-8B-Instruct-MLX" } ] } } }Run Pi
# Start Pi in your project directory: pi
- MLX LM
How to use zimengxiong/WeDLM-8B-Instruct-MLX with MLX LM:
Generate or start a chat session
# Install MLX LM uv tool install mlx-lm # Interactive chat REPL mlx_lm.chat --model "zimengxiong/WeDLM-8B-Instruct-MLX"
Run an OpenAI-compatible server
# Install MLX LM uv tool install mlx-lm # Start the server mlx_lm.server --model "zimengxiong/WeDLM-8B-Instruct-MLX" # Calling the OpenAI-compatible server with curl curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "zimengxiong/WeDLM-8B-Instruct-MLX", "messages": [ {"role": "user", "content": "Hello"} ] }' - Hermes Agent
How to use zimengxiong/WeDLM-8B-Instruct-MLX 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 "zimengxiong/WeDLM-8B-Instruct-MLX"
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 zimengxiong/WeDLM-8B-Instruct-MLX
Run Hermes
hermes
- Atomic Chat
- OpenClaw
How to use zimengxiong/WeDLM-8B-Instruct-MLX with OpenClaw:
Start the MLX server
# Install MLX LM: uv tool install mlx-lm # Start a local OpenAI-compatible server: mlx_lm.server --model "zimengxiong/WeDLM-8B-Instruct-MLX"
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 "zimengxiong/WeDLM-8B-Instruct-MLX" \ --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"
Thanks for your effort
Thanks for the effort. I should note, though, that mlx_lm is still performing text generation using the standard AR approach. It only seems to work right now because our method remains compatible with AR generation, but we aren't actually leveraging our parallel acceleration yet. We will likely need better compatibility integration in the future to unlock the true advantages.
Yes, I understand (I thought my first attempt was working until I realized it was still AR). The readme is kind of incorrect and still uses mlx-lm because I've been meaning to PR mlx-lm (and I didn't realize they were public, I was still testing them), I've edited them now. I added support for the window decoding here: https://github.com/ZimengXiong/WeDLM-MLX, especially https://github.com/ZimengXiong/WeDLM-MLX/blob/main/wedlm_mlx/wedlm_generate.py. It's not perfect because we're still relying on JIT compilation provided by MLX since the growing cache is hard to add @mx .compile, and from my manual attempts to forcing @mx .compile is slower since we're then handwriting attention instead of using optimized MLX ones. Very much still a WIP and I've been trying to follow the paper.
The second run seems to be much faster because its already done compilation, which I'm guessing is a result of that JIT compilation. Main blocker is still the KV-Caching is hard to port over. Only seeing around 1.7-2x speedup in optimal conditions (e.g. from GSMK8) and after warmup with the prompt, which makes it not useful at all.