Instructions to use cstr/bge-m3-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use cstr/bge-m3-GGUF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="cstr/bge-m3-GGUF", filename="bge-m3-q4_k.gguf", )
output = llm( "Once upon a time,", max_tokens=512, echo=True ) print(output)
- Notebooks
- Google Colab
- Kaggle
- Local Apps
- llama.cpp
How to use cstr/bge-m3-GGUF with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf cstr/bge-m3-GGUF:Q8_0 # Run inference directly in the terminal: llama-cli -hf cstr/bge-m3-GGUF:Q8_0
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf cstr/bge-m3-GGUF:Q8_0 # Run inference directly in the terminal: llama-cli -hf cstr/bge-m3-GGUF:Q8_0
Use pre-built binary
# Download pre-built binary from: # https://github.com/ggerganov/llama.cpp/releases # Start a local OpenAI-compatible server with a web UI: ./llama-server -hf cstr/bge-m3-GGUF:Q8_0 # Run inference directly in the terminal: ./llama-cli -hf cstr/bge-m3-GGUF:Q8_0
Build from source code
git clone https://github.com/ggerganov/llama.cpp.git cd llama.cpp cmake -B build cmake --build build -j --target llama-server llama-cli # Start a local OpenAI-compatible server with a web UI: ./build/bin/llama-server -hf cstr/bge-m3-GGUF:Q8_0 # Run inference directly in the terminal: ./build/bin/llama-cli -hf cstr/bge-m3-GGUF:Q8_0
Use Docker
docker model run hf.co/cstr/bge-m3-GGUF:Q8_0
- LM Studio
- Jan
- Ollama
How to use cstr/bge-m3-GGUF with Ollama:
ollama run hf.co/cstr/bge-m3-GGUF:Q8_0
- Unsloth Studio new
How to use cstr/bge-m3-GGUF with Unsloth Studio:
Install Unsloth Studio (macOS, Linux, WSL)
curl -fsSL https://unsloth.ai/install.sh | sh # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for cstr/bge-m3-GGUF to start chatting
Install Unsloth Studio (Windows)
irm https://unsloth.ai/install.ps1 | iex # Run unsloth studio unsloth studio -H 0.0.0.0 -p 8888 # Then open http://localhost:8888 in your browser # Search for cstr/bge-m3-GGUF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for cstr/bge-m3-GGUF to start chatting
- Docker Model Runner
How to use cstr/bge-m3-GGUF with Docker Model Runner:
docker model run hf.co/cstr/bge-m3-GGUF:Q8_0
- Lemonade
How to use cstr/bge-m3-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull cstr/bge-m3-GGUF:Q8_0
Run and chat with the model
lemonade run user.bge-m3-GGUF-Q8_0
List all available models
lemonade list
output = llm(
"Once upon a time,",
max_tokens=512,
echo=True
)
print(output)bge-m3 GGUF
GGUF format of BAAI/bge-m3 for use with CrispEmbed.
BGE-M3. Dense + sparse + ColBERT multi-vector retrieval in one model. 100+ languages, 8192 context.
Files
| File | Quantization | Size |
|---|---|---|
| bge-m3-q4_k.gguf | Q4_K | 438 MB |
| bge-m3-q8_0.gguf | Q8_0 | 583 MB |
| bge-m3.gguf | F32 | 2175 MB |
Quick Start
# Download
huggingface-cli download cstr/bge-m3-GGUF bge-m3-q4_k.gguf --local-dir .
# Run with CrispEmbed
./crispembed -m bge-m3-q4_k.gguf "Hello world"
# Or with auto-download
./crispembed -m bge-m3 "Hello world"
Model Details
| Property | Value |
|---|---|
| Architecture | XLM-R |
| Parameters | 568M |
| Embedding Dimension | 1024 |
| Layers | 24 |
| Pooling | mean |
| Tokenizer | SentencePiece |
| Base Model | BAAI/bge-m3 |
Verification
Verified bit-identical to HuggingFace sentence-transformers (cosine similarity >= 0.999 on test texts).
Usage with CrispEmbed
CrispEmbed is a lightweight C/C++ text embedding inference engine using ggml. No Python runtime, no ONNX. Supports BERT, XLM-R, Qwen3, and Gemma3 architectures.
# Build CrispEmbed
git clone https://github.com/CrispStrobe/CrispEmbed
cd CrispEmbed
cmake -S . -B build && cmake --build build -j
# Encode
./build/crispembed -m bge-m3-q4_k.gguf "query text"
# Server mode
./build/crispembed-server -m bge-m3-q4_k.gguf --port 8080
curl -X POST http://localhost:8080/v1/embeddings \
-d '{"input": ["Hello world"], "model": "bge-m3"}'
Credits
- Original model: BAAI/bge-m3
- Inference engine: CrispEmbed (ggml-based)
- Conversion:
convert-bert-embed-to-gguf.py
- Downloads last month
- 729
Hardware compatibility
Log In to add your hardware
8-bit
Model tree for cstr/bge-m3-GGUF
Base model
BAAI/bge-m3
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="cstr/bge-m3-GGUF", filename="", )