Instructions to use scriptedvn/scriptedvn-models with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use scriptedvn/scriptedvn-models with llama.cpp:
Install (macOS, Linux)
curl -LsSf https://llama.app/install.sh | sh # Start a local OpenAI-compatible server with a web UI: llama serve -hf scriptedvn/scriptedvn-models:Q4_K_M # Run inference directly in the terminal: llama cli -hf scriptedvn/scriptedvn-models:Q4_K_M
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama serve -hf scriptedvn/scriptedvn-models:Q4_K_M # Run inference directly in the terminal: llama cli -hf scriptedvn/scriptedvn-models:Q4_K_M
Build from source code
git clone https://github.com/ggml-org/llama.cpp.git cd llama.cpp cmake -B build cmake --build build -j --target llama-app # Start a local OpenAI-compatible server with a web UI: ./build/bin/llama serve -hf scriptedvn/scriptedvn-models:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama cli -hf scriptedvn/scriptedvn-models:Q4_K_M
Use Docker
docker model run hf.co/scriptedvn/scriptedvn-models:Q4_K_M
- Llama new
- LM Studio
- Jan
- Ollama
How to use scriptedvn/scriptedvn-models with Ollama:
ollama run hf.co/scriptedvn/scriptedvn-models:Q4_K_M
- Unsloth Desktop
- Pi
How to use scriptedvn/scriptedvn-models with Pi:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf scriptedvn/scriptedvn-models:Q4_K_M
Configure the model in Pi
# Install Pi: npm install -g @earendil-works/pi-coding-agent # Add to ~/.pi/agent/models.json: { "providers": { "llama-cpp": { "baseUrl": "http://localhost:9931/v1", "api": "openai-completions", "apiKey": "none", "models": [ { "id": "scriptedvn/scriptedvn-models:Q4_K_M" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Docker Model Runner
How to use scriptedvn/scriptedvn-models with Docker Model Runner:
docker model run hf.co/scriptedvn/scriptedvn-models:Q4_K_M
- Lemonade
How to use scriptedvn/scriptedvn-models with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull scriptedvn/scriptedvn-models:Q4_K_M
Run and chat with the model
lemonade run user.scriptedvn-models-Q4_K_M
List all available models
lemonade list
- Hermes Agent
How to use scriptedvn/scriptedvn-models with Hermes Agent:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf scriptedvn/scriptedvn-models:Q4_K_M
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:9931/v1 hermes config set model.default scriptedvn/scriptedvn-models:Q4_K_M
Run Hermes
hermes
- Atomic Chat
- OpenClaw
How to use scriptedvn/scriptedvn-models with OpenClaw:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf scriptedvn/scriptedvn-models:Q4_K_M
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:9931/v1 \ --custom-model-id "scriptedvn/scriptedvn-models:Q4_K_M" \ --custom-provider-id llama-cpp \ --custom-compatibility openai \ --custom-text-input \ --accept-risk \ --skip-health
Run OpenClaw
openclaw agent --local --agent main --message "Hello from Hugging Face"
Download voxcpm2_model/tokenization_voxcpm2.py from scriptedvn/scriptedvn-models: direct link, hf CLI and curl.
- Browser
- Download file 2.9 kB
-
https://huggingface.co/scriptedvn/scriptedvn-models/resolve/main/voxcpm2_model/tokenization_voxcpm2.py
- Command line
-
hf download hf://scriptedvn/scriptedvn-models/voxcpm2_model/tokenization_voxcpm2.py
-
curl -L -o tokenization_voxcpm2.py https://huggingface.co/scriptedvn/scriptedvn-models/resolve/main/voxcpm2_model/tokenization_voxcpm2.py
2.9 kB
| """Custom tokenizer for VoxCPM2 that splits multi-character Chinese tokens. | |
| VoxCPM2 was trained with ``mask_multichar_chinese_tokens`` which splits | |
| multi-character Chinese tokens (e.g. "你好" -> ["你", "好"]) into individual | |
| character IDs before embedding. The base LlamaTokenizerFast produces | |
| multi-character Chinese tokens that the model has never seen during training, | |
| yielding garbled Chinese audio output in downstream inference frameworks. | |
| This module provides ``VoxCPM2Tokenizer`` which transparently applies the | |
| character splitting inside ``encode()`` and ``__call__()``, so any downstream | |
| consumer (vLLM, vLLM-Omni, Nano-vLLM, etc.) gets correct single-character | |
| IDs without code changes. | |
| """ | |
| from transformers import LlamaTokenizerFast | |
| class VoxCPM2Tokenizer(LlamaTokenizerFast): | |
| def __init__(self, *args, **kwargs): | |
| super().__init__(*args, **kwargs) | |
| self._split_map = self._build_split_map() | |
| def _build_split_map(self) -> dict[int, list[int]]: | |
| vocab = self.get_vocab() | |
| split_map: dict[int, list[int]] = {} | |
| for token, tid in vocab.items(): | |
| clean = token.replace("\u2581", "") | |
| if len(clean) >= 2 and all(self._is_cjk(c) for c in clean): | |
| char_ids = self.convert_tokens_to_ids(list(clean)) | |
| if all(c != self.unk_token_id for c in char_ids): | |
| split_map[tid] = char_ids | |
| return split_map | |
| def _is_cjk(c: str) -> bool: | |
| return ( | |
| "\u4e00" <= c <= "\u9fff" | |
| or "\u3400" <= c <= "\u4dbf" | |
| or "\uf900" <= c <= "\ufaff" | |
| or "\U00020000" <= c <= "\U0002a6df" | |
| ) | |
| def _expand_ids(self, ids: list[int]) -> list[int]: | |
| result: list[int] = [] | |
| for tid in ids: | |
| expansion = self._split_map.get(tid) | |
| if expansion is not None: | |
| result.extend(expansion) | |
| else: | |
| result.append(tid) | |
| return result | |
| def encode(self, text, *args, **kwargs): | |
| ids = super().encode(text, *args, **kwargs) | |
| return self._expand_ids(ids) | |
| def __call__(self, text, *args, **kwargs): | |
| result = super().__call__(text, *args, **kwargs) | |
| if hasattr(result, "input_ids"): | |
| ids = result["input_ids"] | |
| if isinstance(ids, list) and ids and isinstance(ids[0], list): | |
| result["input_ids"] = [self._expand_ids(x) for x in ids] | |
| if "attention_mask" in result: | |
| result["attention_mask"] = [ | |
| [1] * len(x) for x in result["input_ids"] | |
| ] | |
| elif isinstance(ids, list): | |
| result["input_ids"] = self._expand_ids(ids) | |
| if "attention_mask" in result: | |
| result["attention_mask"] = [1] * len(result["input_ids"]) | |
| return result | |