Skip to content

Commit 6a06444

Browse files
PhilipMaysgugger
andauthored
improve documentation of training_args.py (#8270)
* improve documentation of training_args.py - do_train - do_eval - do_predict * fix line too long * fix style with black on training_args.py * Update src/transformers/training_args.py Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> * Update src/transformers/training_args.py Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> * Update src/transformers/training_args.py Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> * fix line length with utils/style_doc * black reformatting Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
1 parent 4c19f3b commit 6a06444

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

src/transformers/training_args.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,19 @@ class TrainingArguments:
4848
If :obj:`True`, overwrite the content of the output directory. Use this to continue training if
4949
:obj:`output_dir` points to a checkpoint directory.
5050
do_train (:obj:`bool`, `optional`, defaults to :obj:`False`):
51-
Whether to run training or not.
51+
Whether to run training or not. This argument is not directly used by :class:`~transformers.Trainer`, it's
52+
intended to be used by your training/evaluation scripts instead. See the `example scripts
53+
<https://github.com/huggingface/transformers/tree/master/examples>`__ for more details.
5254
do_eval (:obj:`bool`, `optional`):
53-
Whether to run evaluation on the dev set or not. Will default to :obj:`evaluation_strategy` different from
54-
:obj:`"no"`.
55+
Whether to run evaluation on the dev set or not. Will be set to :obj:`True` if :obj:`evaluation_strategy`
56+
is different from :obj:`"no"`. This argument is not directly used by :class:`~transformers.Trainer`, it's
57+
intended to be used by your training/evaluation scripts instead. See the `example scripts
58+
<https://github.com/huggingface/transformers/tree/master/examples>`__ for more details.
5559
do_predict (:obj:`bool`, `optional`, defaults to :obj:`False`):
56-
Whether to run predictions on the test set or not.
60+
Whether to run predictions on the test set or not. This argument is not directly used by
61+
:class:`~transformers.Trainer`, it's intended to be used by your training/evaluation scripts instead. See
62+
the `example scripts <https://github.com/huggingface/transformers/tree/master/examples>`__ for more
63+
details.
5764
evaluation_strategy (:obj:`str` or :class:`~transformers.trainer_utils.EvaluationStrategy`, `optional`, defaults to :obj:`"no"`):
5865
The evaluation strategy to adopt during training. Possible values are:
5966

0 commit comments

Comments
 (0)