mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-06-28 02:53:30 +00:00
9654dd9da1
This commit significantly improves the environment variable substitution
functionality in Llama Stack configuration files:
* The version field in configuration files has been changed from string
to integer type for better type consistency across build and run
configurations.
* The environment variable substitution system for ${env.FOO:} was fixed
and properly returns an error
* The environment variable substitution system for ${env.FOO+} returns
None instead of an empty strings, it better matches type annotations
in config fields
* The system includes automatic type conversion for boolean, integer,
and float values.
* The error messages have been enhanced to provide clearer guidance when
environment variables are missing, including suggestions for using
default values or conditional syntax.
* Comprehensive documentation has been added to the configuration guide
explaining all supported syntax patterns, best practices, and runtime
override capabilities.
* Multiple provider configurations have been updated to use the new
conditional syntax for optional API keys, making the system more
flexible for different deployment scenarios. The telemetry
configuration has been improved to properly handle optional endpoints
with appropriate validation, ensuring that required endpoints are
specified when their corresponding sinks are enabled.
* There were many instances of ${env.NVIDIA_API_KEY:} that should have
caused the code to fail. However, due to a bug, the distro server was
still being started, and early validation wasn’t triggered. As a
result, failures were likely being handled downstream by the
providers. I’ve maintained similar behavior by using
${env.NVIDIA_API_KEY:+}, though I believe this is incorrect for many
configurations. I’ll leave it to each provider to correct it as
needed.
* Environment variable substitution now uses the same syntax as Bash
parameter expansion.
Signed-off-by: Sébastien Han <seb@redhat.com>
61 lines
2.1 KiB
Python
61 lines
2.1 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
import os
|
|
import warnings
|
|
from typing import Any
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class NvidiaDatasetIOConfig(BaseModel):
|
|
"""Configuration for NVIDIA DatasetIO implementation."""
|
|
|
|
api_key: str | None = Field(
|
|
default_factory=lambda: os.getenv("NVIDIA_API_KEY"),
|
|
description="The NVIDIA API key.",
|
|
)
|
|
|
|
dataset_namespace: str | None = Field(
|
|
default_factory=lambda: os.getenv("NVIDIA_DATASET_NAMESPACE", "default"),
|
|
description="The NVIDIA dataset namespace.",
|
|
)
|
|
|
|
project_id: str | None = Field(
|
|
default_factory=lambda: os.getenv("NVIDIA_PROJECT_ID", "test-project"),
|
|
description="The NVIDIA project ID.",
|
|
)
|
|
|
|
datasets_url: str = Field(
|
|
default_factory=lambda: os.getenv("NVIDIA_DATASETS_URL", "http://nemo.test"),
|
|
description="Base URL for the NeMo Dataset API",
|
|
)
|
|
|
|
# warning for default values
|
|
def __post_init__(self):
|
|
default_values = []
|
|
if os.getenv("NVIDIA_PROJECT_ID") is None:
|
|
default_values.append("project_id='test-project'")
|
|
if os.getenv("NVIDIA_DATASET_NAMESPACE") is None:
|
|
default_values.append("dataset_namespace='default'")
|
|
if os.getenv("NVIDIA_DATASETS_URL") is None:
|
|
default_values.append("datasets_url='http://nemo.test'")
|
|
|
|
if default_values:
|
|
warnings.warn(
|
|
f"Using default values: {', '.join(default_values)}. \
|
|
Please set the environment variables to avoid this default behavior.",
|
|
stacklevel=2,
|
|
)
|
|
|
|
@classmethod
|
|
def sample_run_config(cls, **kwargs) -> dict[str, Any]:
|
|
return {
|
|
"api_key": "${env.NVIDIA_API_KEY:+}",
|
|
"dataset_namespace": "${env.NVIDIA_DATASET_NAMESPACE:=default}",
|
|
"project_id": "${env.NVIDIA_PROJECT_ID:=test-project}",
|
|
"datasets_url": "${env.NVIDIA_DATASETS_URL:=http://nemo.test}",
|
|
}
|