fix: Update NVIDIA Eval README

This commit is contained in:
Jash Gulabrai 2025-04-07 10:30:08 -04:00
parent 4317a0ddcc
commit f939117dbf

View file

@ -18,11 +18,9 @@ POST /eval/benchmarks
"dataset_id": "", "dataset_id": "",
"scoring_functions": [], "scoring_functions": [],
"metadata": { "metadata": {
"config": {
"type": "mmlu" "type": "mmlu"
} }
} }
}
``` ```
### Example for register a custom evaluation ### Example for register a custom evaluation
@ -36,7 +34,6 @@ POST /eval/benchmarks
"dataset_id": "", "dataset_id": "",
"scoring_functions": [], "scoring_functions": [],
"metadata": { "metadata": {
"config": {
"type": "custom", "type": "custom",
"params": { "params": {
"parallelism": 8 "parallelism": 8
@ -67,7 +64,6 @@ POST /eval/benchmarks
} }
} }
} }
}
``` ```
### Example for triggering a benchmark/custom evaluation ### Example for triggering a benchmark/custom evaluation
@ -78,12 +74,16 @@ POST /eval/benchmarks/{benchmark_id}/jobs
```json ```json
{ {
"benchmark_id": "my-custom-benchmark", "benchmark_id": "my-custom-benchmark",
"task_config": { "benchmark_config": {
"eval_candidate": { "eval_candidate": {
"type": "model", "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: Response example:
```json ```json
{ {
"job_id": "1234" "job_id": "1234",
"status": "in_progress"
} }
``` ```
@ -100,9 +101,14 @@ Response example:
GET /eval/benchmarks/{benchmark_id}/jobs/{job_id} 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 ### Example for getting the results
``` ```
GET /eval/benchmarks/{benchmark_id}/result GET /eval/benchmarks/{benchmark_id}/results
``` ```
```json ```json
{ {