Skip to content

docs: point task guides at paths that exist #1436

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.

Sign up for GitHub

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

Open
xlb3055 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: point task guides at paths that exist #1436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9955665
docs: point task guides at paths that exist
xlb3055 Oct 20, 2026
067745f
docs: keep the custom-task example path a placeholder
xlb3055 Oct 20, 2026
5e481d0
docs: use the same existing task paths as #1258
xlb3055 Oct 20, 2026
f6c66f1
docs: describe the merged task folders without the old categories
xlb3055 Oct 20, 2026
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
4 changes: 2 additions & 2 deletions docs/source/adding-a-custom-task.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ from lighteval.tasks.requests import Doc
# Define as many as you need for your different tasks
def prompt_fn(line: dict, task_name: str):
"""Defines how to go from a dataset line to a doc object.
Follow examples in src/lighteval/tasks/default_prompts.py, or get more info
Follow examples in src/lighteval/tasks/tasks, or get more info
about what this function should do in the README.
"""
return Doc(
Expand Down Expand Up @@ -158,5 +158,5 @@ lighteval accelerate \
lighteval accelerate \
"model_name=openai-community/gpt2" \
"myothertask|3" \
--custom-tasks community_tasks/my_custom_task.py
--custom-tasks {path_to_your_custom_task_file}
```
6 changes: 3 additions & 3 deletions docs/source/quicktour.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ For example
```

All officially supported tasks can be found at the [tasks_list](available-tasks) and in the
[extended folder](https://github.com/huggingface/lighteval/tree/main/src/lighteval/tasks/extended).
Moreover, community-provided tasks can be found in the
[community](https://github.com/huggingface/lighteval/tree/main/community_tasks) folder.
[tasks folder](https://github.com/huggingface/lighteval/tree/main/src/lighteval/tasks/tasks).
Multilingual tasks are in
[multilingual/tasks](https://github.com/huggingface/lighteval/tree/main/src/lighteval/tasks/multilingual/tasks).

For more details on the implementation of the tasks, such as how prompts are constructed or which metrics are used, you can examine the
[implementation file](https://github.com/huggingface/lighteval/blob/main/src/lighteval/tasks/default_tasks.py).
Expand Down