Skip to content

Commit 3de54bb

Browse files
sahilds1TineoC
authored andcommitted
Update the README
1 parent 4dd3b72 commit 3de54bb

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

server/api/services/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ It supports batch evalaution via a configuration CSV and produces a detailed met
77

88
## Usage
99

10+
This script evalutes LLM outputs using the `lighteval` library: https://huggingface.co/docs/lighteval/en/metric-list#automatic-metrics-for-generative-tasks
11+
1012
Ensure you have the `lighteval` library and any model SDKs (e.g., OpenAI, Anthropic) configured properly.
1113

1214

@@ -16,9 +18,9 @@ python evals.py --config path/to/config.csv --reference path/to/reference.csv --
1618

1719
The arguments to the script are:
1820

19-
- Path to the config CSV file (model, query, context)
20-
- Path to the reference CSV file
21-
- Path where the evaluation resulst will be saved
21+
- Path to the config CSV file: Must include the columns "Model Name" and "Query"
22+
- Path to the reference CSV file: Must include the columns "Context" and "Reference"
23+
- Path where the evaluation resuls will be saved
2224

2325

2426
The script outputs a CSV with the following columns:

0 commit comments

Comments
 (0)