Skip to content

docs: point task guides at paths that exist - #1436

Open
xlb3055 wants to merge 4 commits into
huggingface:mainfrom
xlb3055:docs/fix-task-paths
Open

xlb3055 wants to merge 4 commits into
huggingface:mainfrom
xlb3055:docs/fix-task-paths

Conversation

@xlb3055

@xlb3055 xlb3055 commented Oct 20, 2026

Copy link
Copy Markdown

Since #1016 moved tasks into individual files, a few doc references point at paths that no longer exist on main:

  • docs/source/quicktour.mdx links src/lighteval/tasks/extended and community_tasks/ (both 404). They now link src/lighteval/tasks/tasks/, where Move tasks to individual files #1016 moved the default, extended and community tasks, and src/lighteval/tasks/multilingual/tasks/ for the multilingual ones.
  • docs/source/adding-a-custom-task.mdx tells readers to follow src/lighteval/tasks/default_prompts.py, which no longer exists. It now points at src/lighteval/tasks/tasks/, where each task file defines its own prompt function (Step 1 of the same guide already says to create the task file there).
  • The second command example in that guide passed --custom-tasks community_tasks/my_custom_task.py. It now uses the same {path_to_your_custom_task_file} placeholder as the command template right above it, since the example task myothertask lives in the reader's own file.

The default_tasks.py link in the quicktour is left unchanged because #1258 already fixes it.

Documentation only. The old paths were checked to be missing and the new ones to exist on main; no test suite was run.

This change was prepared with AI assistance.

🤖 Generated with Claude Code

xlb3055 and others added 4 commits October 20, 2026 11:11
The quicktour linked tasks/extended and community_tasks, and the custom-task guide linked default_prompts.py. None of those paths exist on main.

Signed-off-by: bin <178128333+xlb3055@users.noreply.github.com>
examples/nanotron/custom_task.py does not define the myothertask example from
this guide, so copying the command would fail. Use the same placeholder as the
command template above.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: bin <178128333+xlb3055@users.noreply.github.com>
huggingface#1016 folded the extended and community suites into src/lighteval/tasks/tasks,
so labelling that folder "extended" and the multilingual folder "community"
would be misleading.

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant