Skip to content

Commit

Permalink
Refactor ScriptArguments class documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
qgallouedec committed Nov 28, 2024
1 parent 512a09e commit 037f3fd
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions trl/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,20 @@ class ScriptArguments:
"""
Arguments common to all scripts.
dataset_name (`str`):
Dataset name.
dataset_train_split (`str`, *optional*, defaults to `"train"`):
Dataset split to use for training.
dataset_test_split (`str`, *optional*, defaults to `"test"`):
Dataset split to use for evaluation.
config (`str` or `None`, *optional*, defaults to `None`):
Path to the optional config file.
gradient_checkpointing_use_reentrant (`bool`, *optional*, defaults to `False`):
Whether to apply `use_reentrant` for gradient_checkpointing.
ignore_bias_buffers (`bool`, *optional*, defaults to `False`):
Debug argument for distributed training. Fix for DDP issues with LM bias/mask buffers - invalid scalar type,
inplace operation. See https://github.com/huggingface/transformers/issues/22482#issuecomment-1595790992.
Args:
dataset_name (`str`):
Dataset name.
dataset_train_split (`str`, *optional*, defaults to `"train"`):
Dataset split to use for training.
dataset_test_split (`str`, *optional*, defaults to `"test"`):
Dataset split to use for evaluation.
config (`str` or `None`, *optional*, defaults to `None`):
Path to the optional config file.
gradient_checkpointing_use_reentrant (`bool`, *optional*, defaults to `False`):
Whether to apply `use_reentrant` for gradient_checkpointing.
ignore_bias_buffers (`bool`, *optional*, defaults to `False`):
Debug argument for distributed training. Fix for DDP issues with LM bias/mask buffers - invalid scalar
type, inplace operation. See https://github.com/huggingface/transformers/issues/22482#issuecomment-1595790992.
"""

dataset_name: str
Expand Down

0 comments on commit 037f3fd

Please sign in to comment.