-
Notifications
You must be signed in to change notification settings - Fork 120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve readability of the quick tour. #501
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,18 +32,33 @@ lighteval accelerate \ | |
"leaderboard|truthfulqa:mc|0|0" | ||
``` | ||
|
||
Here, `--tasks` refers to either a comma-separated list of supported tasks from | ||
the [tasks_list](available-tasks) in the format: | ||
Here, the first argument specifies which model(s) to run, and the second argument specifies how to evaluate them. | ||
|
||
Multiple models can be evaluated at the same time by using a comma-separated list. For example: | ||
|
||
```bash | ||
{suite}|{task}|{num_few_shot}|{0 or 1 to automatically reduce `num_few_shot` if prompt is too long} | ||
lighteval accelerate \ | ||
"pretrained=gpt2,pretrained=HuggingFaceTB/SmolLM2-135M-Instruct" \ | ||
"leaderboard|truthfulqa:mc|0|0" | ||
``` | ||
|
||
or a file path like | ||
[examples/tasks/recommended_set.txt](https://github.com/huggingface/lighteval/blob/main/examples/tasks/recommended_set.txt) | ||
which specifies multiple task configurations. | ||
Similarly, multiple evalutions can be run as well, either with a comma-separated list of supported tasks, or by specifing | ||
a file path, like from [examples/tasks/recommended_set.txt](https://github.com/huggingface/lighteval/blob/main/examples/tasks/recommended_set.txt). | ||
For example: | ||
|
||
```bash | ||
lighteval accelerate \ | ||
"pretrained=gpt2 \ | ||
./path/to/lighteval/examples/tasks/recommended_set.txt | ||
``` | ||
|
||
The task specification might be a bit hard to grasp as first. The format is as follows: | ||
|
||
```bash | ||
{suite}|{task}|{num_few_shot}|{0 or 1 to automatically reduce `num_few_shot` if prompt is too long} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. automatically adapt the number of few shot examples presented to the model if the prompt is too long for the context size of the task or the model There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (I would add this explanation on antoher line) |
||
``` | ||
|
||
Tasks details can be found in the | ||
All supported tasks can be found at the [tasks_list](available-tasks). For more details, you can have a look at the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We also support the tasks that are community provided in the extended folder |
||
[file](https://github.com/huggingface/lighteval/blob/main/src/lighteval/tasks/default_tasks.py) | ||
implementing them. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope, we can only evaluate one model at a time - however we can specifiy precision, peft weights, ...