Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions docs/source/quicktour.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

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, ...


```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}
Copy link
Member

Choose a reason for hiding this comment

The 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

Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The 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.

Expand Down