From f939117dbf9d010ce0fd3eb57416b37486255a1b Mon Sep 17 00:00:00 2001 From: Jash Gulabrai Date: Mon, 7 Apr 2025 10:30:08 -0400 Subject: [PATCH] fix: Update NVIDIA Eval README --- .../providers/remote/eval/nvidia/README.md | 72 ++++++++++--------- 1 file changed, 39 insertions(+), 33 deletions(-) diff --git a/llama_stack/providers/remote/eval/nvidia/README.md b/llama_stack/providers/remote/eval/nvidia/README.md index 6221c9568..08aac78fc 100644 --- a/llama_stack/providers/remote/eval/nvidia/README.md +++ b/llama_stack/providers/remote/eval/nvidia/README.md @@ -18,9 +18,7 @@ POST /eval/benchmarks "dataset_id": "", "scoring_functions": [], "metadata": { - "config": { - "type": "mmlu" - } + "type": "mmlu" } } ``` @@ -36,31 +34,29 @@ POST /eval/benchmarks "dataset_id": "", "scoring_functions": [], "metadata": { - "config": { - "type": "custom", - "params": { - "parallelism": 8 - }, - "tasks": { - "qa": { - "type": "completion", - "params": { - "template": { - "prompt": "{{prompt}}", - "max_tokens": 200 - } - }, - "dataset": { - "files_url": "hf://datasets/default/sample-basic-test/testing/testing.jsonl" - }, - "metrics": { - "bleu": { - "type": "bleu", - "params": { - "references": [ - "{{ideal_response}}" - ] - } + "type": "custom", + "params": { + "parallelism": 8 + }, + "tasks": { + "qa": { + "type": "completion", + "params": { + "template": { + "prompt": "{{prompt}}", + "max_tokens": 200 + } + }, + "dataset": { + "files_url": "hf://datasets/default/sample-basic-test/testing/testing.jsonl" + }, + "metrics": { + "bleu": { + "type": "bleu", + "params": { + "references": [ + "{{ideal_response}}" + ] } } } @@ -78,12 +74,16 @@ POST /eval/benchmarks/{benchmark_id}/jobs ```json { "benchmark_id": "my-custom-benchmark", - "task_config": { + "benchmark_config": { "eval_candidate": { "type": "model", - "model": "meta/llama-3.1-8b-instruct" + "model": "meta/llama-3.1-8b-instruct", + "sampling_params": { + "max_tokens": 100, + "temperature": 0.7 + } }, - "scoring_params": [] + "scoring_params": {} } } ``` @@ -91,7 +91,8 @@ POST /eval/benchmarks/{benchmark_id}/jobs Response example: ```json { - "job_id": "1234" + "job_id": "1234", + "status": "in_progress" } ``` @@ -100,9 +101,14 @@ Response example: GET /eval/benchmarks/{benchmark_id}/jobs/{job_id} ``` +### Example for cancelling a job +``` +POST /eval/benchmarks/{benchmark_id}/jobs/{job_id}/cancel +``` + ### Example for getting the results ``` -GET /eval/benchmarks/{benchmark_id}/result +GET /eval/benchmarks/{benchmark_id}/results ``` ```json {