Instructions to use fireworks-ai/llama-3-firefunction-v2 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use fireworks-ai/llama-3-firefunction-v2 with Transformers:

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

pipe = pipeline("text-generation", model="fireworks-ai/llama-3-firefunction-v2")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("fireworks-ai/llama-3-firefunction-v2")
model = AutoModelForCausalLM.from_pretrained("fireworks-ai/llama-3-firefunction-v2", 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]:]))

Inference
Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use fireworks-ai/llama-3-firefunction-v2 with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "fireworks-ai/llama-3-firefunction-v2"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "fireworks-ai/llama-3-firefunction-v2",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/fireworks-ai/llama-3-firefunction-v2

SGLang

How to use fireworks-ai/llama-3-firefunction-v2 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 "fireworks-ai/llama-3-firefunction-v2" \
    --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": "fireworks-ai/llama-3-firefunction-v2",
		"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 "fireworks-ai/llama-3-firefunction-v2" \
        --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": "fireworks-ai/llama-3-firefunction-v2",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use fireworks-ai/llama-3-firefunction-v2 with Docker Model Runner:
```
docker model run hf.co/fireworks-ai/llama-3-firefunction-v2
```

pgarbacki commited on Jun 7, 2024

Commit

b0702d8

verified ·

1 Parent(s): 2082258

Update README.md

Browse files

Files changed (1) hide show

README.md +18 -11

README.md CHANGED Viewed

@@ -18,14 +18,7 @@ FireFunction is a state-of-the-art function calling model with a commercially vi
 💡 Hosted on the [Fireworks](https://fireworks.ai/models/fireworks/firefunction-v2) platform
-## Resources
-* [Fireworks discord with function calling channel](https://discord.gg/mMqQxvFD9A)
-* [Documentation](https://readme.fireworks.ai/docs/function-calling)
-* [UI Demo app](https://functional-chat.vercel.app/)
-* [Try in Fireworks prompt playground UI](https://fireworks.ai/models/fireworks/firefunction-v2)
-# Intended Use and Limitations
 ### Supported usecases
 The model was tuned to perfom well on a range of usecases including:
@@ -40,6 +33,18 @@ The model was not optimized for the following use cases:
   * 100+ function specs
   * nested function calling
 ## Example Usage
 See [documentation](https://readme.fireworks.ai/docs/function-calling) for more detail.
@@ -110,6 +115,8 @@ decoded = tokenizer.batch_decode(generated_ids)
 print(decoded[0])
 ```
-## Demo App
-Check our easy-to-extend [demo chat app](https://github.com/fw-ai/forge/tree/main/apps/functional_chat) with function calling capabilities built on Firefunction model.

 💡 Hosted on the [Fireworks](https://fireworks.ai/models/fireworks/firefunction-v2) platform
+## Intended Use and Limitations
 ### Supported usecases
 The model was tuned to perfom well on a range of usecases including:
   * 100+ function specs
   * nested function calling
+## Metrics
+|                                    | Firefunction v1 | Firefunction v2 | Llama 3 70b Instruct | Gpt-4o |
+|------------------------------------|-----------------|-----------------|----------------------|--------|
+| Gorilla simple                     | 0.91            | 0.94            | 0.925                | 0.88   |
+| Gorilla multiple_function          | 0.92            | 0.91            | 0.86                 | 0.91   |
+| Gorilla parallel_function          | 0               | 0.9             | 0.86                 | 0.89   |
+| Gorilla parallel_multiple_function | 0               | 0.8             | 0.615                | 0.72   |
+| Nexus parallel                     | 0.38            | 0.53            | 0.3                  | 0.47   |
+| Mtbench                            | 0.73            | 0.84            | 0.89                 | 0.93   |
+| Average                            | 0.49            | 0.82            | 0.74                 | 0.8    |
 ## Example Usage
 See [documentation](https://readme.fireworks.ai/docs/function-calling) for more detail.
 print(decoded[0])
 ```
+## Resources
+* [Fireworks discord with function calling channel](https://discord.gg/mMqQxvFD9A)
+* [Documentation](https://readme.fireworks.ai/docs/function-calling)
+* [Demo app](https://functional-chat.vercel.app/)
+* [Try in Fireworks prompt playground UI](https://fireworks.ai/models/fireworks/firefunction-v2)