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
```

The default eos_token_id is 2, should be 11

#11

by mike-ravkine - opened May 31, 2023

Discussion

mike-ravkine

May 31, 2023

Hi Guys!

Fantastic model.

I have encountered an issue using both the 7B and 40B Falcon models with recommended settings, they continue generation past <|endoftext|>

Issue is that the default llama eos_token_id=2 is specified here: https://huggingface.co/tiiuae/falcon-40b-instruct/blob/main/configuration_RW.py#L41

Looking at https://huggingface.co/tiiuae/falcon-40b-instruct/raw/main/tokenizer.json this is not the llama vocabulary and token=2 is >>INTRODUCTION<< and I think we're looking for token=11 <|endoftext|>

I am able to work-around the generation problem by manually adding eos_token_id=11 on model invocation.

--Mike

Shridharalve

Jun 1, 2023

Were you able to run the model on SageMaker?

FalconLLM

Technology Innovation Institute org Jun 1, 2023

•

edited Jun 1, 2023

Hey @mike-ravkine , glad you like the model

This is a bit surprising, while we should fix the default value, the config.json is correct since some days back, so when the model is loaded the config should be correct.
See: https://huggingface.co/tiiuae/falcon-40b-instruct/commit/662a9a4ffd96f4f73dd18141b60962f94b743c56

Could it be an issue with using a cached model since before it was fixed?

mike-ravkine

Jun 1, 2023

Thanks for the response @FalconLLM , this makes sense. I am actually using a quantized version of the model (from https://huggingface.co/TheBloke/falcon-40b-instruct-GPTQ) and it was missing the fix to config.json from above. I have opened a PR in that model!

mike-ravkine changed discussion status to closed Jun 1, 2023

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

· Sign up or log in to comment