Instructions to use microsoft/bitnet-b1.58-2B-4T-gguf with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use microsoft/bitnet-b1.58-2B-4T-gguf with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="microsoft/bitnet-b1.58-2B-4T-gguf") messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("microsoft/bitnet-b1.58-2B-4T-gguf", dtype="auto") - llama-cpp-python
How to use microsoft/bitnet-b1.58-2B-4T-gguf with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="microsoft/bitnet-b1.58-2B-4T-gguf", filename="ggml-model-i2_s.gguf", )
llm.create_chat_completion( messages = [ { "role": "user", "content": "What is the capital of France?" } ] ) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use microsoft/bitnet-b1.58-2B-4T-gguf with llama.cpp:
Install from brew
brew install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf microsoft/bitnet-b1.58-2B-4T-gguf # Run inference directly in the terminal: llama-cli -hf microsoft/bitnet-b1.58-2B-4T-gguf
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama-server -hf microsoft/bitnet-b1.58-2B-4T-gguf # Run inference directly in the terminal: llama-cli -hf microsoft/bitnet-b1.58-2B-4T-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 microsoft/bitnet-b1.58-2B-4T-gguf # Run inference directly in the terminal: ./llama-cli -hf microsoft/bitnet-b1.58-2B-4T-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 microsoft/bitnet-b1.58-2B-4T-gguf # Run inference directly in the terminal: ./build/bin/llama-cli -hf microsoft/bitnet-b1.58-2B-4T-gguf
Use Docker
docker model run hf.co/microsoft/bitnet-b1.58-2B-4T-gguf
- LM Studio
- Jan
- vLLM
How to use microsoft/bitnet-b1.58-2B-4T-gguf with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "microsoft/bitnet-b1.58-2B-4T-gguf" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "microsoft/bitnet-b1.58-2B-4T-gguf", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/microsoft/bitnet-b1.58-2B-4T-gguf
- SGLang
How to use microsoft/bitnet-b1.58-2B-4T-gguf with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "microsoft/bitnet-b1.58-2B-4T-gguf" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "microsoft/bitnet-b1.58-2B-4T-gguf", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "microsoft/bitnet-b1.58-2B-4T-gguf" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "microsoft/bitnet-b1.58-2B-4T-gguf", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Ollama
How to use microsoft/bitnet-b1.58-2B-4T-gguf with Ollama:
ollama run hf.co/microsoft/bitnet-b1.58-2B-4T-gguf
- Unsloth Studio
How to use microsoft/bitnet-b1.58-2B-4T-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 microsoft/bitnet-b1.58-2B-4T-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 microsoft/bitnet-b1.58-2B-4T-gguf to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for microsoft/bitnet-b1.58-2B-4T-gguf to start chatting
- Atomic Chat new
- Docker Model Runner
How to use microsoft/bitnet-b1.58-2B-4T-gguf with Docker Model Runner:
docker model run hf.co/microsoft/bitnet-b1.58-2B-4T-gguf
- Lemonade
How to use microsoft/bitnet-b1.58-2B-4T-gguf with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull microsoft/bitnet-b1.58-2B-4T-gguf
Run and chat with the model
lemonade run user.bitnet-b1.58-2B-4T-gguf-{{QUANT_TAG}}List all available models
lemonade list
Update README.md (#17)
Browse files- Update README.md (83e82de694b5f7b2f1116ec3878e1b78be3a4d96)
Co-authored-by: Blake S <bsnelling@users.noreply.huggingface.co>
README.md
CHANGED
|
@@ -140,4 +140,7 @@ BitNet b1.58 2B4T was evaluated against leading open-weight full-precision LLMs
|
|
| 140 |
The model weights and code are released under the [MIT License](https://huggingface.co/microsoft/bitnet-b1.58-2B-4T/blob/main/LICENSE).
|
| 141 |
|
| 142 |
## Disclaimer
|
| 143 |
-
This model is intended for research and development purposes. While efforts have been made to align it using SFT and DPO, it may still produce outputs that are unexpected, biased, or inaccurate. Please use responsibly.
|
|
|
|
|
|
|
|
|
|
|
|
| 140 |
The model weights and code are released under the [MIT License](https://huggingface.co/microsoft/bitnet-b1.58-2B-4T/blob/main/LICENSE).
|
| 141 |
|
| 142 |
## Disclaimer
|
| 143 |
+
This model is intended for research and development purposes. While efforts have been made to align it using SFT and DPO, it may still produce outputs that are unexpected, biased, or inaccurate. Please use responsibly.
|
| 144 |
+
|
| 145 |
+
## Data Summary
|
| 146 |
+
https://huggingface.co/microsoft/bitnet-b1.58-2B-4T-gguf/blob/main/data_summary_card.md
|