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", device_map="auto") 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
Improve model card: Add pipeline tag, update license, and add project links
#4
by nielsr HF Staff - opened
README.md
CHANGED
|
@@ -1,5 +1,4 @@
|
|
| 1 |
---
|
| 2 |
-
library_name: transformers
|
| 3 |
language:
|
| 4 |
- ar
|
| 5 |
- cs
|
|
@@ -19,18 +18,28 @@ language:
|
|
| 19 |
- sv
|
| 20 |
- ur
|
| 21 |
- zh
|
| 22 |
-
|
| 23 |
-
- falcon-h1
|
| 24 |
license: other
|
| 25 |
license_name: falcon-llm-license
|
| 26 |
-
|
| 27 |
-
|
| 28 |
inference: true
|
|
|
|
| 29 |
---
|
| 30 |
|
| 31 |
<img src="https://huggingface.co/datasets/tiiuae/documentation-images/resolve/main/falcon_mamba/falcon-h1-logo.png" alt="drawing" width="800"/>
|
| 32 |
|
| 33 |
-
#
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
0. [TL;DR](#TL;DR)
|
| 36 |
1. [Model Details](#model-details)
|
|
|
|
| 1 |
---
|
|
|
|
| 2 |
language:
|
| 3 |
- ar
|
| 4 |
- cs
|
|
|
|
| 18 |
- sv
|
| 19 |
- ur
|
| 20 |
- zh
|
| 21 |
+
library_name: transformers
|
|
|
|
| 22 |
license: other
|
| 23 |
license_name: falcon-llm-license
|
| 24 |
+
tags:
|
| 25 |
+
- falcon-h1
|
| 26 |
inference: true
|
| 27 |
+
pipeline_tag: text-generation
|
| 28 |
---
|
| 29 |
|
| 30 |
<img src="https://huggingface.co/datasets/tiiuae/documentation-images/resolve/main/falcon_mamba/falcon-h1-logo.png" alt="drawing" width="800"/>
|
| 31 |
|
| 32 |
+
# Falcon-H1: A Family of Hybrid-Head Language Models Redefining Efficiency and Performance
|
| 33 |
+
|
| 34 |
+
## Links
|
| 35 |
+
- ๐ [Paper on Hugging Face](https://huggingface.co/papers/2507.22448)
|
| 36 |
+
- ๐ป [Code on GitHub](https://github.com/tiiuae/Falcon-H1)
|
| 37 |
+
- ๐ [Project Homepage](https://tiiuae.github.io/Falcon-H1/)
|
| 38 |
+
- ๐ฐ [Release Blogpost](https://falcon-lm.github.io/blog/falcon-h1/)
|
| 39 |
+
- ๐ฎ [Hugging Face Demo](https://huggingface.co/spaces/tiiuae/Falcon-H1-playground)
|
| 40 |
+
- ๐ฌ [Discord Server](https://discord.gg/trwMYP9PYm)
|
| 41 |
+
|
| 42 |
+
# Table of Contents
|
| 43 |
|
| 44 |
0. [TL;DR](#TL;DR)
|
| 45 |
1. [Model Details](#model-details)
|