Skip to content

Sync LightevalTaskConfig docstring with current fields #1259

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
nuthalapativarun wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Sync LightevalTaskConfig docstring with current fields #1259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 13 additions & 2 deletions src/lighteval/tasks/lighteval_task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ class LightevalTaskConfig:
hf_subset (str): Dataset subset/configuration name to use for this task.
metrics (ListLike[Metric | Metrics]): List of metrics or metric enums to compute for this task.

Inspect AI Compatible Parameters:
solver (None, optional): Reserved for Inspect AI solver compatibility.
Defaults to None.
scorer (None, optional): Reserved for Inspect AI scorer compatibility.
Defaults to None.
sample_fields (Callable[[dict], Sample] | None, optional): Function that
converts a dataset row to an Inspect AI Sample. Defaults to None.
sample_to_fewshot (Callable[[Sample], str] | None, optional): Function
that converts a Sample to its few-shot text representation.
Defaults to None.
filter (Callable[[dict], bool] | None, optional): Filter function applied
to Inspect AI samples. Defaults to None.

Dataset Configuration:
hf_revision (str | None, optional): Specific dataset revision to use.
Defaults to None (latest).
Expand Down Expand Up @@ -96,8 +109,6 @@ class LightevalTaskConfig:
prompt changes. Defaults to 0.
num_fewshots (int, optional): Number of few-shot examples to include.
Defaults to 0.
truncate_fewshots (bool, optional): Whether to truncate few-shot examples.
Defaults to False.
must_remove_duplicate_docs (bool, optional): Whether to remove duplicate
documents. Defaults to False.

Expand Down