forked from phoenix-oss/llama-stack-mirror
2a31163178
# What does this PR do? Automatically generates - build.yaml - run.yaml - run-with-safety.yaml - parts of markdown docs for the distributions. ## Test Plan At this point, this only updates the YAMLs and the docs. Some testing (especially with ollama and vllm) has been performed but needs to be much more tested.
60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
# Fireworks Distribution
|
|
|
|
The `llamastack/distribution-{{ name }}` distribution consists of the following provider configurations.
|
|
|
|
{{ providers_table }}
|
|
|
|
{% if run_config_env_vars %}
|
|
### Environment Variables
|
|
|
|
The following environment variables can be configured:
|
|
|
|
{% for var, (default_value, description) in run_config_env_vars.items() %}
|
|
- `{{ var }}`: {{ description }} (default: `{{ default_value }}`)
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{% if default_models %}
|
|
### Models
|
|
|
|
The following models are available by default:
|
|
|
|
{% for model in default_models %}
|
|
- `{{ model.model_id }}`
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
|
|
### Prerequisite: API Keys
|
|
|
|
Make sure you have access to a Fireworks API Key. You can get one by visiting [fireworks.ai](https://fireworks.ai/).
|
|
|
|
|
|
## Running Llama Stack with Fireworks
|
|
|
|
You can do this via Conda (build code) or Docker which has a pre-built image.
|
|
|
|
### Via Docker
|
|
|
|
This method allows you to get started quickly without having to build the distribution code.
|
|
|
|
```bash
|
|
LLAMA_STACK_PORT=5001
|
|
docker run \
|
|
-it \
|
|
-p $LLAMA_STACK_PORT:$LLAMA_STACK_PORT \
|
|
-v ./run.yaml:/root/my-run.yaml \
|
|
llamastack/distribution-{{ name }} \
|
|
/root/my-run.yaml \
|
|
--port $LLAMA_STACK_PORT \
|
|
--env FIREWORKS_API_KEY=$FIREWORKS_API_KEY
|
|
```
|
|
|
|
### Via Conda
|
|
|
|
```bash
|
|
llama stack build --template fireworks --image-type conda
|
|
llama stack run ./run.yaml \
|
|
--port 5001 \
|
|
--env FIREWORKS_API_KEY=$FIREWORKS_API_KEY
|
|
```
|