Instructions to use tiiuae/Falcon-H1-3B-Instruct with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use tiiuae/Falcon-H1-3B-Instruct with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="tiiuae/Falcon-H1-3B-Instruct") messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# Load model directly from transformers import AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("tiiuae/Falcon-H1-3B-Instruct") model = AutoModelForCausalLM.from_pretrained("tiiuae/Falcon-H1-3B-Instruct") messages = [ {"role": "user", "content": "Who are you?"}, ] inputs = tokenizer.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=40) print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use tiiuae/Falcon-H1-3B-Instruct with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "tiiuae/Falcon-H1-3B-Instruct" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "tiiuae/Falcon-H1-3B-Instruct", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/tiiuae/Falcon-H1-3B-Instruct
- SGLang
How to use tiiuae/Falcon-H1-3B-Instruct 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 "tiiuae/Falcon-H1-3B-Instruct" \ --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": "tiiuae/Falcon-H1-3B-Instruct", "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 "tiiuae/Falcon-H1-3B-Instruct" \ --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": "tiiuae/Falcon-H1-3B-Instruct", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Docker Model Runner
How to use tiiuae/Falcon-H1-3B-Instruct with Docker Model Runner:
docker model run hf.co/tiiuae/Falcon-H1-3B-Instruct
Update README.md
Browse files
README.md
CHANGED
|
@@ -38,7 +38,7 @@ For more details about the training protocol of this model, please refer to the
|
|
| 38 |
|
| 39 |
# Usage
|
| 40 |
|
| 41 |
-
Currently to use this model you can either rely on Hugging Face `transformers`, `vLLM` or
|
| 42 |
|
| 43 |
## Inference
|
| 44 |
|
|
@@ -84,8 +84,7 @@ vllm serve tiiuae/Falcon-H1-1B-Instruct --tensor-parallel-size 2 --data-parallel
|
|
| 84 |
|
| 85 |
### `llama.cpp`
|
| 86 |
|
| 87 |
-
|
| 88 |
-
Use the same installing guidelines as `llama.cpp`.
|
| 89 |
|
| 90 |
# Evaluation
|
| 91 |
|
|
|
|
| 38 |
|
| 39 |
# Usage
|
| 40 |
|
| 41 |
+
Currently to use this model you can either rely on Hugging Face `transformers`, `vLLM` or `llama.cpp` library.
|
| 42 |
|
| 43 |
## Inference
|
| 44 |
|
|
|
|
| 84 |
|
| 85 |
### `llama.cpp`
|
| 86 |
|
| 87 |
+
You can find all GGUF files under [our official collection](https://huggingface.co/collections/tiiuae/falcon-h1-6819f2795bc406da60fab8df)
|
|
|
|
| 88 |
|
| 89 |
# Evaluation
|
| 90 |
|