Instructions to use QuantFactory/bitnet_b1_58-3B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use QuantFactory/bitnet_b1_58-3B-GGUF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="QuantFactory/bitnet_b1_58-3B-GGUF", filename="bitnet_b1_58-3B.Q2_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 QuantFactory/bitnet_b1_58-3B-GGUF with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M # Run inference directly in the terminal: llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
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 QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
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 QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
Use Docker
docker model run hf.co/QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
- LM Studio
- Jan
- Ollama
How to use QuantFactory/bitnet_b1_58-3B-GGUF with Ollama:
ollama run hf.co/QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
- Unsloth Studio new
How to use QuantFactory/bitnet_b1_58-3B-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 QuantFactory/bitnet_b1_58-3B-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 QuantFactory/bitnet_b1_58-3B-GGUF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for QuantFactory/bitnet_b1_58-3B-GGUF to start chatting
- Docker Model Runner
How to use QuantFactory/bitnet_b1_58-3B-GGUF with Docker Model Runner:
docker model run hf.co/QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
- Lemonade
How to use QuantFactory/bitnet_b1_58-3B-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull QuantFactory/bitnet_b1_58-3B-GGUF:Q4_K_M
Run and chat with the model
lemonade run user.bitnet_b1_58-3B-GGUF-Q4_K_M
List all available models
lemonade list
Install from WinGet (Windows)
winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf QuantFactory/bitnet_b1_58-3B-GGUF:# Run inference directly in the terminal:
llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF: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 QuantFactory/bitnet_b1_58-3B-GGUF:# Run inference directly in the terminal:
./llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF: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 QuantFactory/bitnet_b1_58-3B-GGUF:# Run inference directly in the terminal:
./build/bin/llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF:Use Docker
docker model run hf.co/QuantFactory/bitnet_b1_58-3B-GGUF:QuantFactory/bitnet_b1_58-3B-GGUF
This is quantized version of 1bitLLM/bitnet_b1_58-3B created using llama.cpp
Original Model Card
This is a reproduction of the BitNet b1.58 paper. The models are trained with RedPajama dataset for 100B tokens. The hypers, as well as two-stage LR and weight decay, are implemented as suggested in their following paper. All models are open-source in the repo. We will train larger models and/or more tokens when resource is available.
Results
PPL and zero-shot accuracy:
| Models | PPL | ARCe | ARCc | HS | BQ | OQ | PQ | WGe | Avg |
|---|---|---|---|---|---|---|---|---|---|
| FP16 700M (reported) | 12.33 | 54.7 | 23.0 | 37.0 | 60.0 | 20.2 | 68.9 | 54.8 | 45.5 |
| BitNet b1.58 700M (reported) | 12.87 | 51.8 | 21.4 | 35.1 | 58.2 | 20.0 | 68.1 | 55.2 | 44.3 |
| BitNet b1.58 700M (reproduced) | 12.78 | 51.4 | 21.8 | 35.0 | 59.6 | 20.6 | 67.5 | 55.4 | 44.5 |
| FP16 1.3B (reported) | 11.25 | 56.9 | 23.5 | 38.5 | 59.1 | 21.6 | 70.0 | 53.9 | 46.2 |
| BitNet b1.58 1.3B (reported) | 11.29 | 54.9 | 24.2 | 37.7 | 56.7 | 19.6 | 68.8 | 55.8 | 45.4 |
| BitNet b1.58 1.3B (reproduced) | 11.19 | 55.8 | 23.7 | 37.6 | 59.0 | 20.2 | 69.2 | 56.0 | 45.9 |
| FP16 3B (reported) | 10.04 | 62.1 | 25.6 | 43.3 | 61.8 | 24.6 | 72.1 | 58.2 | 49.7 |
| BitNet b1.58 3B (reported) | 9.91 | 61.4 | 28.3 | 42.9 | 61.5 | 26.6 | 71.5 | 59.3 | 50.2 |
| BitNet b1.58 3B (reproduced) | 9.88 | 60.9 | 28.0 | 42.3 | 58.3 | 26.0 | 71.4 | 60.3 | 49.6 |
The differences between the reported numbers and the reproduced results are possibly variances from the training data processing, seeds, or other random factors.
Evaluation
The evaluation pipelines are from the paper authors. Here is the commands to run the evaluation:
pip install lm-eval==0.3.0
python eval_ppl.py --hf_path 1bitLLM/bitnet_b1_58-3B --seqlen 2048
python eval_task.py --hf_path 1bitLLM/bitnet_b1_58-3B \
--batch_size 1 \
--tasks \
--output_path result.json \
--num_fewshot 0 \
--ctx_size 2048
- Downloads last month
- 623
2-bit
3-bit
4-bit
5-bit
6-bit
8-bit
Install from brew
# Start a local OpenAI-compatible server with a web UI: llama-server -hf QuantFactory/bitnet_b1_58-3B-GGUF:# Run inference directly in the terminal: llama-cli -hf QuantFactory/bitnet_b1_58-3B-GGUF: