diff --git a/docs/_static/llama-stack-spec.html b/docs/_static/llama-stack-spec.html index 15b06257f..b1fe8e832 100644 --- a/docs/_static/llama-stack-spec.html +++ b/docs/_static/llama-stack-spec.html @@ -10328,14 +10328,14 @@ "properties": { "dataset_id": { "type": "string", - "description": "The ID of the dataset to be used to run the benchmark." + "description": "The ID of the dataset to be used to run the benchmark. ID obtained through `datasets.register()`" }, "grader_ids": { "type": "array", "items": { "type": "string" }, - "description": "List of grader ids to use for this benchmark." + "description": "List of grader ids to use for this benchmark. ID obtained through `graders.register()`" }, "benchmark_id": { "type": "string", diff --git a/docs/_static/llama-stack-spec.yaml b/docs/_static/llama-stack-spec.yaml index 0f83dd3d7..f91744f98 100644 --- a/docs/_static/llama-stack-spec.yaml +++ b/docs/_static/llama-stack-spec.yaml @@ -7084,13 +7084,14 @@ components: dataset_id: type: string description: >- - The ID of the dataset to be used to run the benchmark. + The ID of the dataset to be used to run the benchmark. ID obtained through + `datasets.register()` grader_ids: type: array items: type: string description: >- - List of grader ids to use for this benchmark. + List of grader ids to use for this benchmark. ID obtained through `graders.register()` benchmark_id: type: string description: >- diff --git a/llama_stack/apis/benchmarks/benchmarks.py b/llama_stack/apis/benchmarks/benchmarks.py index 3c5624e62..534aa6884 100644 --- a/llama_stack/apis/benchmarks/benchmarks.py +++ b/llama_stack/apis/benchmarks/benchmarks.py @@ -62,8 +62,8 @@ class Benchmarks(Protocol): """ Register a new benchmark. A benchmark consists of a dataset id and a list of grader ids. - :param dataset_id: The ID of the dataset to be used to run the benchmark. - :param grader_ids: List of grader ids to use for this benchmark. + :param dataset_id: The ID of the dataset to be used to run the benchmark. ID obtained through `datasets.register()` + :param grader_ids: List of grader ids to use for this benchmark. ID obtained through `graders.register()` :param benchmark_id: (Optional) The ID of the benchmark to register. If not provided, an ID will be generated. :param metadata: (Optional) Metadata for this benchmark for additional descriptions. """