Instructions to use tiiuae/falcon-40b-instruct with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use tiiuae/falcon-40b-instruct with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="tiiuae/falcon-40b-instruct", trust_remote_code=True)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("tiiuae/falcon-40b-instruct", trust_remote_code=True)
model = AutoModelForCausalLM.from_pretrained("tiiuae/falcon-40b-instruct", trust_remote_code=True)

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use tiiuae/falcon-40b-instruct with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "tiiuae/falcon-40b-instruct"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "tiiuae/falcon-40b-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/tiiuae/falcon-40b-instruct

SGLang

How to use tiiuae/falcon-40b-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-40b-instruct" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "tiiuae/falcon-40b-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

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-40b-instruct" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "tiiuae/falcon-40b-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use tiiuae/falcon-40b-instruct with Docker Model Runner:
```
docker model run hf.co/tiiuae/falcon-40b-instruct
```

Matt commited on Jul 7, 2023

Commit

bb9e6c5

1 Parent(s): 1e7fdcc

Move to in-library checkpoint

Browse files

Files changed (3) hide show

config.json +7 -10
generation_config.json +4 -4
tokenizer_config.json +5 -1

config.json CHANGED Viewed

@@ -2,13 +2,9 @@
   "alibi": false,
   "apply_residual_connection_post_layernorm": false,
   "architectures": [
-    "RWForCausalLM"
   ],
   "attention_dropout": 0.0,
-  "auto_map": {
-    "AutoConfig": "configuration_RW.RWConfig",
-    "AutoModelForCausalLM": "modelling_RW.RWForCausalLM"
-  },
   "bias": false,
   "bos_token_id": 11,
   "eos_token_id": 11,
@@ -16,13 +12,14 @@
   "hidden_size": 8192,
   "initializer_range": 0.02,
   "layer_norm_epsilon": 1e-05,
-  "model_type": "RefinedWeb",
-  "n_head": 128,
-  "n_head_kv": 8,
-  "n_layer": 60,
   "parallel_attn": true,
   "torch_dtype": "bfloat16",
   "transformers_version": "4.26.0",
   "use_cache": true,
   "vocab_size": 65024
-}

   "alibi": false,
   "apply_residual_connection_post_layernorm": false,
   "architectures": [
+    "FalconForCausalLM"
   ],
   "attention_dropout": 0.0,
   "bias": false,
   "bos_token_id": 11,
   "eos_token_id": 11,
   "hidden_size": 8192,
   "initializer_range": 0.02,
   "layer_norm_epsilon": 1e-05,
+  "model_type": "falcon",
+  "new_decoder_architecture": true,
+  "num_attention_heads": 128,
+  "num_hidden_layers": 60,
+  "num_kv_heads": 8,
   "parallel_attn": true,
   "torch_dtype": "bfloat16",
   "transformers_version": "4.26.0",
   "use_cache": true,
   "vocab_size": 65024
+}

generation_config.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "_from_model_config": true,
-  "bos_token_id": 1,
-  "eos_token_id": 2,
-  "transformers_version": "4.26.0"
-}

 {
   "_from_model_config": true,
+  "bos_token_id": 11,
+  "eos_token_id": 11,
+  "transformers_version": "4.31.0.dev0"
+}

tokenizer_config.json CHANGED Viewed

@@ -1,8 +1,12 @@
 {
   "add_prefix_space": false,
   "eos_token": "<|endoftext|>",
   "model_max_length": 2048,
   "name_or_path": "tiiuae/falcon_tokenizer",
   "special_tokens_map_file": null,
   "tokenizer_class": "PreTrainedTokenizerFast"
-}

 {
   "add_prefix_space": false,
   "eos_token": "<|endoftext|>",
+  "model_input_names": [
+    "input_ids",
+    "attention_mask"
+  ],
   "model_max_length": 2048,
   "name_or_path": "tiiuae/falcon_tokenizer",
   "special_tokens_map_file": null,
   "tokenizer_class": "PreTrainedTokenizerFast"
+}