mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 12:07:34 +00:00
docs: update configuration documentation for global default embedding model
- Clarified the optional nature of the default_embedding_dimension in the YAML configuration, specifying that it defaults to 384 if omitted. - Added a note in the VectorStoreConfig class to indicate that the router will fall back to 384 as the default dimension if not set.
This commit is contained in:
parent
600c3d5188
commit
f9afad99f8
2 changed files with 4 additions and 3 deletions
|
@ -803,14 +803,14 @@ shields:
|
|||
|
||||
### Global Vector-Store Defaults
|
||||
|
||||
Starting with Llama-Stack v2, you can provide a *stack-level* default embedding model that will be used whenever a new vector-store is created and the caller does **not** specify an `embedding_model` parameter.
|
||||
You can provide a *stack-level* default embedding model that will be used whenever a new vector-store is created and the caller does **not** specify an `embedding_model` parameter.
|
||||
|
||||
Add a top-level block next to `models:` and `vector_io:` in your build/run YAML:
|
||||
|
||||
```yaml
|
||||
vector_store_config:
|
||||
default_embedding_model: ${env.LLAMA_STACK_DEFAULT_EMBEDDING_MODEL:=all-MiniLM-L6-v2}
|
||||
# optional but recommended
|
||||
# optional - if omitted, defaults to 384
|
||||
default_embedding_dimension: ${env.LLAMA_STACK_DEFAULT_EMBEDDING_DIMENSION:=384}
|
||||
```
|
||||
|
||||
|
@ -825,7 +825,7 @@ Precedence rules at runtime:
|
|||
| Variable | Purpose | Example |
|
||||
|----------|---------|---------|
|
||||
| `LLAMA_STACK_DEFAULT_EMBEDDING_MODEL` | Global default embedding model id | `all-MiniLM-L6-v2` |
|
||||
| `LLAMA_STACK_DEFAULT_EMBEDDING_DIMENSION` | Dimension for embeddings (optional) | `384` |
|
||||
| `LLAMA_STACK_DEFAULT_EMBEDDING_DIMENSION` | Dimension for embeddings (optional, defaults to 384) | `384` |
|
||||
|
||||
If you include the `${env.…}` placeholder in `vector_store_config`, deployments can override the default without editing YAML:
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue