Skip to content

Fix TrainingArguments.label_names docs to reflect the correct default value behaviour #21288

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

Merged
sgugger merged 3 commits into from
Jan 24, 2023
Merged

Fix TrainingArguments.label_names docs to reflect the correct default value behaviour #21288

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21d01f7
Update TrainingArguments.label_names docs
fredtcaroli Jan 24, 2023
caa04b4
Change wording
fredtcaroli Jan 24, 2023
96ee07f
Change wording
fredtcaroli Jan 24, 2023
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
5 changes: 3 additions & 2 deletions src/transformers/training_args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,9 @@ class TrainingArguments:
label_names (`List[str]`, *optional*):
The list of keys in your dictionary of inputs that correspond to the labels.

Will eventually default to `["labels"]` except if the model used is one of the `XxxForQuestionAnswering` in
which case it will default to `["start_positions", "end_positions"]`.
Will eventually default to the list of argument names accepted by the model that contain the word "label",
except if the model used is one of the `XxxForQuestionAnswering` in which case it will also include the
`["start_positions", "end_positions"]` keys.
load_best_model_at_end (`bool`, *optional*, defaults to `False`):
Whether or not to load the best model found during training at the end of training.

Expand Down