transformers/pr_33892/en/main_classes/trainer.md

# Trainer

The [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) class provides an API for feature-complete training in PyTorch, and it supports distributed training on multiple GPUs/TPUs, mixed precision for [NVIDIA GPUs](https://nvidia.github.io/apex/), [AMD GPUs](https://rocm.docs.amd.com/en/latest/rocm.html), and [`torch.amp`](https://pytorch.org/docs/stable/amp.html) for PyTorch. [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) goes hand-in-hand with the [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) class, which offers a wide range of options to customize how a model is trained. Together, these two classes provide a complete training API.

[Seq2SeqTrainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Seq2SeqTrainer) and [Seq2SeqTrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Seq2SeqTrainingArguments) inherit from the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) and [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) classes and they're adapted for training models for sequence-to-sequence tasks such as summarization or translation.

<Tip warning={true}>

The [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) class is optimized for 🤗 Transformers models and can have surprising behaviors
when used with other models. When using it with your own model, make sure:

- your model always return tuples or subclasses of [ModelOutput](/docs/transformers/pr_33892/en/main_classes/output#transformers.utils.ModelOutput)
- your model can compute the loss if a `labels` argument is provided and that loss is returned as the first
  element of the tuple (if your model returns tuples)
- your model can accept multiple label arguments (use `label_names` in [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) to indicate their name to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)) but none of them should be named `"label"`

</Tip>

## Trainer[[api-reference]][[transformers.Trainer]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.Trainer</name><anchor>transformers.Trainer</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L290</source><parameters>[{"name": "model", "val": ": typing.Union[transformers.modeling_utils.PreTrainedModel, torch.nn.modules.module.Module, NoneType] = None"}, {"name": "args", "val": ": typing.Optional[transformers.training_args.TrainingArguments] = None"}, {"name": "data_collator", "val": ": typing.Optional[collections.abc.Callable[[list[typing.Any]], dict[str, typing.Any]]] = None"}, {"name": "train_dataset", "val": ": typing.Union[torch.utils.data.dataset.Dataset, torch.utils.data.dataset.IterableDataset, ForwardRef('datasets.Dataset'), NoneType] = None"}, {"name": "eval_dataset", "val": ": typing.Union[torch.utils.data.dataset.Dataset, dict[str, torch.utils.data.dataset.Dataset], ForwardRef('datasets.Dataset'), NoneType] = None"}, {"name": "processing_class", "val": ": typing.Union[transformers.tokenization_utils_base.PreTrainedTokenizerBase, transformers.image_processing_utils.BaseImageProcessor, transformers.feature_extraction_utils.FeatureExtractionMixin, transformers.processing_utils.ProcessorMixin, NoneType] = None"}, {"name": "model_init", "val": ": typing.Optional[collections.abc.Callable[..., transformers.modeling_utils.PreTrainedModel]] = None"}, {"name": "compute_loss_func", "val": ": typing.Optional[collections.abc.Callable] = None"}, {"name": "compute_metrics", "val": ": typing.Optional[collections.abc.Callable[[transformers.trainer_utils.EvalPrediction], dict]] = None"}, {"name": "callbacks", "val": ": typing.Optional[list[transformers.trainer_callback.TrainerCallback]] = None"}, {"name": "optimizers", "val": ": tuple = (None, None)"}, {"name": "optimizer_cls_and_kwargs", "val": ": typing.Optional[tuple[type[torch.optim.optimizer.Optimizer], dict[str, typing.Any]]] = None"}, {"name": "preprocess_logits_for_metrics", "val": ": typing.Optional[collections.abc.Callable[[torch.Tensor, torch.Tensor], torch.Tensor]] = None"}]</parameters><paramsdesc>- **model** ([PreTrainedModel](/docs/transformers/pr_33892/en/main_classes/model#transformers.PreTrainedModel) or `torch.nn.Module`, *optional*) --
  The model to train, evaluate or use for predictions. If not provided, a `model_init` must be passed.

  <Tip>

  [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) is optimized to work with the [PreTrainedModel](/docs/transformers/pr_33892/en/main_classes/model#transformers.PreTrainedModel) provided by the library. You can still use
  your own models defined as `torch.nn.Module` as long as they work the same way as the 🤗 Transformers
  models.

  </Tip>

- **args** ([TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments), *optional*) --
  The arguments to tweak for training. Will default to a basic instance of [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) with the
  `output_dir` set to a directory named *tmp_trainer* in the current directory if not provided.
- **data_collator** (`DataCollator`, *optional*) --
  The function to use to form a batch from a list of elements of `train_dataset` or `eval_dataset`. Will
  default to [default_data_collator()](/docs/transformers/pr_33892/en/main_classes/data_collator#transformers.default_data_collator) if no `processing_class` is provided, an instance of
  [DataCollatorWithPadding](/docs/transformers/pr_33892/en/main_classes/data_collator#transformers.DataCollatorWithPadding) otherwise if the processing_class is a feature extractor or tokenizer.
- **train_dataset** (Union[`torch.utils.data.Dataset`, `torch.utils.data.IterableDataset`, `datasets.Dataset`], *optional*) --
  The dataset to use for training. If it is a [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns not accepted by the
  `model.forward()` method are automatically removed.

  Note that if it's a `torch.utils.data.IterableDataset` with some randomization and you are training in a
  distributed fashion, your iterable dataset should either use a internal attribute `generator` that is a
  `torch.Generator` for the randomization that must be identical on all processes (and the Trainer will
  manually set the seed of this `generator` at each epoch) or have a `set_epoch()` method that internally
  sets the seed of the RNGs used.
- **eval_dataset** (Union[`torch.utils.data.Dataset`, dict[str, `torch.utils.data.Dataset`, `datasets.Dataset`]), *optional*) --
  The dataset to use for evaluation. If it is a [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns not accepted by the
  `model.forward()` method are automatically removed. If it is a dictionary, it will evaluate on each
  dataset prepending the dictionary key to the metric name.
- **processing_class** (`PreTrainedTokenizerBase` or `BaseImageProcessor` or `FeatureExtractionMixin` or `ProcessorMixin`, *optional*) --
  Processing class used to process the data. If provided, will be used to automatically process the inputs
  for the model, and it will be saved along the model to make it easier to rerun an interrupted training or
  reuse the fine-tuned model.
- **model_init** (`Callable[[], PreTrainedModel]`, *optional*) --
  A function that instantiates the model to be used. If provided, each call to [train()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.train) will start
  from a new instance of the model as given by this function.

  The function may have zero argument, or a single one containing the optuna/Ray Tune trial object, to
  be able to choose different architectures according to hyper parameters (such as layer count, sizes of
  inner layers, dropout probabilities etc).
- **compute_loss_func** (`Callable`, *optional*) --
  A function that accepts the raw model outputs, labels, and the number of items in the entire accumulated
  batch (batch_size * gradient_accumulation_steps) and returns the loss. For example, see the default [loss function](https://github.com/huggingface/transformers/blob/052e652d6d53c2b26ffde87e039b723949a53493/src/transformers/trainer.py#L3618) used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer).
- **compute_metrics** (`Callable[[EvalPrediction], Dict]`, *optional*) --
  The function that will be used to compute metrics at evaluation. Must take a [EvalPrediction](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.EvalPrediction) and return
  a dictionary string to metric values. *Note* When passing TrainingArgs with `batch_eval_metrics` set to
  `True`, your compute_metrics function must take a boolean `compute_result` argument. This will be triggered
  after the last eval batch to signal that the function needs to calculate and return the global summary
  statistics rather than accumulating the batch-level statistics
- **callbacks** (List of [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback), *optional*) --
  A list of callbacks to customize the training loop. Will add those to the list of default callbacks
  detailed in [here](callback).

  If you want to remove one of the default callbacks used, use the [Trainer.remove_callback()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.remove_callback) method.
- **optimizers** (`tuple[torch.optim.Optimizer, torch.optim.lr_scheduler.LambdaLR]`, *optional*, defaults to `(None, None)`) --
  A tuple containing the optimizer and the scheduler to use. Will default to an instance of `AdamW` on your
  model and a scheduler given by [get_linear_schedule_with_warmup()](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.get_linear_schedule_with_warmup) controlled by `args`.
- **optimizer_cls_and_kwargs** (`tuple[Type[torch.optim.Optimizer], dict[str, Any]]`, *optional*) --
  A tuple containing the optimizer class and keyword arguments to use.
  Overrides `optim` and `optim_args` in `args`. Incompatible with the `optimizers` argument.

  Unlike `optimizers`, this argument avoids the need to place model parameters on the correct devices before initializing the Trainer.
- **preprocess_logits_for_metrics** (`Callable[[torch.Tensor, torch.Tensor], torch.Tensor]`, *optional*) --
  A function that preprocess the logits right before caching them at each evaluation step. Must take two
  tensors, the logits and the labels, and return the logits once processed as desired. The modifications made
  by this function will be reflected in the predictions received by `compute_metrics`.

  Note that the labels (second parameter) will be `None` if the dataset does not have them.</paramsdesc><paramgroups>0</paramgroups></docstring>

Trainer is a simple but feature-complete training and eval loop for PyTorch, optimized for 🤗 Transformers.



Important attributes:

- **model** -- Always points to the core model. If using a transformers model, it will be a [PreTrainedModel](/docs/transformers/pr_33892/en/main_classes/model#transformers.PreTrainedModel)
  subclass.
- **model_wrapped** -- Always points to the most external model in case one or more other modules wrap the
  original model. This is the model that should be used for the forward pass. For example, under `DeepSpeed`,
  the inner model is wrapped in `DeepSpeed` and then again in `torch.nn.DistributedDataParallel`. If the inner
  model hasn't been wrapped, then `self.model_wrapped` is the same as `self.model`.
- **is_model_parallel** -- Whether or not a model has been switched to a model parallel mode (different from
  data parallelism, this means some of the model layers are split on different GPUs).
- **place_model_on_device** -- Whether or not to automatically place the model on the device - it will be set
  to `False` if model parallel or deepspeed is used, or if the default
  `TrainingArguments.place_model_on_device` is overridden to return `False` .
- **is_in_train** -- Whether or not a model is currently running `train` (e.g. when `evaluate` is called while
  in `train`)




<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>add_callback</name><anchor>transformers.Trainer.add_callback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L794</source><parameters>[{"name": "callback", "val": ""}]</parameters><paramsdesc>- **callback** (`type` or [`~transformers.TrainerCallback]`) --
  A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) class or an instance of a [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback). In the
  first case, will instantiate a member of that class.</paramsdesc><paramgroups>0</paramgroups></docstring>

Add a callback to the current list of [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback).




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>autocast_smart_context_manager</name><anchor>transformers.Trainer.autocast_smart_context_manager</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3720</source><parameters>[{"name": "cache_enabled", "val": ": typing.Optional[bool] = True"}]</parameters></docstring>

A helper wrapper that creates an appropriate context manager for `autocast` while feeding it the desired
arguments, depending on the situation. We rely on accelerate for autocast, hence we do nothing here.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>compute_loss</name><anchor>transformers.Trainer.compute_loss</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3798</source><parameters>[{"name": "model", "val": ": Module"}, {"name": "inputs", "val": ": dict"}, {"name": "return_outputs", "val": ": bool = False"}, {"name": "num_items_in_batch", "val": ": typing.Optional[torch.Tensor] = None"}]</parameters><paramsdesc>- **model** (`nn.Module`) --
  The model to compute the loss for.
- **inputs** (`dict[str, Union[torch.Tensor, Any]]`) --
  The input data for the model.
- **return_outputs** (`bool`, *optional*, defaults to `False`) --
  Whether to return the model outputs along with the loss.
- **num_items_in_batch** (Optional[torch.Tensor], *optional*) --
  The number of items in the batch. If num_items_in_batch is not passed,</paramsdesc><paramgroups>0</paramgroups><retdesc>The loss of the model along with its output if return_outputs was set to True</retdesc></docstring>

How the loss is computed by Trainer. By default, all models return the loss in the first element.





Subclass and override for custom behavior. If you are not using `num_items_in_batch` when computing your loss,
make sure to overwrite `self.model_accepts_loss_kwargs` to `False`. Otherwise, the loss calculating might be slightly inaccurate when performing gradient accumulation.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>compute_loss_context_manager</name><anchor>transformers.Trainer.compute_loss_context_manager</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3708</source><parameters>[]</parameters></docstring>

A helper wrapper to group together context managers.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>create_model_card</name><anchor>transformers.Trainer.create_model_card</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4666</source><parameters>[{"name": "language", "val": ": typing.Optional[str] = None"}, {"name": "license", "val": ": typing.Optional[str] = None"}, {"name": "tags", "val": ": typing.Union[str, list[str], NoneType] = None"}, {"name": "model_name", "val": ": typing.Optional[str] = None"}, {"name": "finetuned_from", "val": ": typing.Optional[str] = None"}, {"name": "tasks", "val": ": typing.Union[str, list[str], NoneType] = None"}, {"name": "dataset_tags", "val": ": typing.Union[str, list[str], NoneType] = None"}, {"name": "dataset", "val": ": typing.Union[str, list[str], NoneType] = None"}, {"name": "dataset_args", "val": ": typing.Union[str, list[str], NoneType] = None"}]</parameters><paramsdesc>- **language** (`str`, *optional*) --
  The language of the model (if applicable)
- **license** (`str`, *optional*) --
  The license of the model. Will default to the license of the pretrained model used, if the original
  model given to the `Trainer` comes from a repo on the Hub.
- **tags** (`str` or `list[str]`, *optional*) --
  Some tags to be included in the metadata of the model card.
- **model_name** (`str`, *optional*) --
  The name of the model.
- **finetuned_from** (`str`, *optional*) --
  The name of the model used to fine-tune this one (if applicable). Will default to the name of the repo
  of the original model given to the `Trainer` (if it comes from the Hub).
- **tasks** (`str` or `list[str]`, *optional*) --
  One or several task identifiers, to be included in the metadata of the model card.
- **dataset_tags** (`str` or `list[str]`, *optional*) --
  One or several dataset tags, to be included in the metadata of the model card.
- **dataset** (`str` or `list[str]`, *optional*) --
  One or several dataset identifiers, to be included in the metadata of the model card.
- **dataset_args** (`str` or `list[str]`, *optional*) --
  One or several dataset arguments, to be included in the metadata of the model card.</paramsdesc><paramgroups>0</paramgroups></docstring>

Creates a draft of a model card using the information available to the `Trainer`.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>create_optimizer</name><anchor>transformers.Trainer.create_optimizer</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1189</source><parameters>[]</parameters></docstring>

Setup the optimizer.

We provide a reasonable default that works well. If you want to use something else, you can pass a tuple in the
Trainer's init through `optimizers`, or subclass and override this method in a subclass.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>create_optimizer_and_scheduler</name><anchor>transformers.Trainer.create_optimizer_and_scheduler</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1161</source><parameters>[{"name": "num_training_steps", "val": ": int"}]</parameters></docstring>

Setup the optimizer and the learning rate scheduler.

We provide a reasonable default that works well. If you want to use something else, you can pass a tuple in the
Trainer's init through `optimizers`, or subclass and override this method (or `create_optimizer` and/or
`create_scheduler`) in a subclass.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>create_scheduler</name><anchor>transformers.Trainer.create_scheduler</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1737</source><parameters>[{"name": "num_training_steps", "val": ": int"}, {"name": "optimizer", "val": ": Optimizer = None"}]</parameters><paramsdesc>- **num_training_steps** (int) -- The number of training steps to do.</paramsdesc><paramgroups>0</paramgroups></docstring>

Setup the scheduler. The optimizer of the trainer must have been set up either before this method is called or
passed as an argument.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>evaluate</name><anchor>transformers.Trainer.evaluate</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4138</source><parameters>[{"name": "eval_dataset", "val": ": typing.Union[torch.utils.data.dataset.Dataset, dict[str, torch.utils.data.dataset.Dataset], NoneType] = None"}, {"name": "ignore_keys", "val": ": typing.Optional[list[str]] = None"}, {"name": "metric_key_prefix", "val": ": str = 'eval'"}]</parameters><paramsdesc>- **eval_dataset** (Union[`Dataset`, dict[str, `Dataset`]), *optional*) --
  Pass a dataset if you wish to override `self.eval_dataset`. If it is a [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns
  not accepted by the `model.forward()` method are automatically removed. If it is a dictionary, it will
  evaluate on each dataset, prepending the dictionary key to the metric name. Datasets must implement the
  `__len__` method.

  <Tip>

  If you pass a dictionary with names of datasets as keys and datasets as values, evaluate will run
  separate evaluations on each dataset. This can be useful to monitor how training affects other
  datasets or simply to get a more fine-grained evaluation.
  When used with `load_best_model_at_end`, make sure `metric_for_best_model` references exactly one
  of the datasets. If you, for example, pass in `{"data1": data1, "data2": data2}` for two datasets
  `data1` and `data2`, you could specify `metric_for_best_model="eval_data1_loss"` for using the
  loss on `data1` and `metric_for_best_model="eval_data2_loss"` for the loss on `data2`.

  </Tip>

- **ignore_keys** (`list[str]`, *optional*) --
  A list of keys in the output of your model (if it is a dictionary) that should be ignored when
  gathering predictions.
- **metric_key_prefix** (`str`, *optional*, defaults to `"eval"`) --
  An optional prefix to be used as the metrics key prefix. For example the metrics "bleu" will be named
  "eval_bleu" if the prefix is "eval" (default)</paramsdesc><paramgroups>0</paramgroups><retdesc>A dictionary containing the evaluation loss and the potential metrics computed from the predictions. The
dictionary also contains the epoch number which comes from the training state.</retdesc></docstring>

Run evaluation and returns metrics.

The calling script will be responsible for providing a method to compute metrics, as they are task-dependent
(pass it to the init `compute_metrics` argument).

You can also subclass and override this method to inject custom behavior.






</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>evaluation_loop</name><anchor>transformers.Trainer.evaluation_loop</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4300</source><parameters>[{"name": "dataloader", "val": ": DataLoader"}, {"name": "description", "val": ": str"}, {"name": "prediction_loss_only", "val": ": typing.Optional[bool] = None"}, {"name": "ignore_keys", "val": ": typing.Optional[list[str]] = None"}, {"name": "metric_key_prefix", "val": ": str = 'eval'"}]</parameters></docstring>

Prediction/evaluation loop, shared by `Trainer.evaluate()` and `Trainer.predict()`.

Works both with or without labels.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>floating_point_ops</name><anchor>transformers.Trainer.floating_point_ops</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4630</source><parameters>[{"name": "inputs", "val": ": dict"}]</parameters><paramsdesc>- **inputs** (`dict[str, Union[torch.Tensor, Any]]`) --
  The inputs and targets of the model.</paramsdesc><paramgroups>0</paramgroups><rettype>`int`</rettype><retdesc>The number of floating-point operations.</retdesc></docstring>

For models that inherit from [PreTrainedModel](/docs/transformers/pr_33892/en/main_classes/model#transformers.PreTrainedModel), uses that method to compute the number of floating point
operations for every backward + forward pass. If using another model, either implement such a method in the
model or subclass and override this method.








</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_batch_samples</name><anchor>transformers.Trainer.get_batch_samples</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L5125</source><parameters>[{"name": "epoch_iterator", "val": ": Iterator"}, {"name": "num_batches", "val": ": int"}, {"name": "device", "val": ": device"}]</parameters></docstring>

Collects a specified number of batches from the epoch iterator and optionally counts the number of items in the batches to properly scale the loss.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_decay_parameter_names</name><anchor>transformers.Trainer.get_decay_parameter_names</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1177</source><parameters>[{"name": "model", "val": ""}]</parameters></docstring>

Get all parameter names that weight decay will be applied to.

This function filters out parameters in two ways:
1. By layer type (instances of layers specified in ALL_LAYERNORM_LAYERS)
2. By parameter name patterns (containing 'bias', or variation of 'norm')


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_eval_dataloader</name><anchor>transformers.Trainer.get_eval_dataloader</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1104</source><parameters>[{"name": "eval_dataset", "val": ": typing.Union[str, torch.utils.data.dataset.Dataset, NoneType] = None"}]</parameters><paramsdesc>- **eval_dataset** (`str` or `torch.utils.data.Dataset`, *optional*) --
  If a `str`, will use `self.eval_dataset[eval_dataset]` as the evaluation dataset. If a `Dataset`, will override `self.eval_dataset` and must implement `__len__`. If it is a [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns not accepted by the `model.forward()` method are automatically removed.</paramsdesc><paramgroups>0</paramgroups></docstring>

Returns the evaluation `~torch.utils.data.DataLoader`.

Subclass and override this method if you want to inject some custom behavior.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_learning_rates</name><anchor>transformers.Trainer.get_learning_rates</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1262</source><parameters>[]</parameters></docstring>

Returns the learning rate of each parameter from self.optimizer.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_num_trainable_parameters</name><anchor>transformers.Trainer.get_num_trainable_parameters</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1256</source><parameters>[]</parameters></docstring>

Get the number of trainable parameters.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_optimizer_cls_and_kwargs</name><anchor>transformers.Trainer.get_optimizer_cls_and_kwargs</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1286</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "model", "val": ": typing.Optional[transformers.modeling_utils.PreTrainedModel] = None"}]</parameters><paramsdesc>- **args** (`transformers.training_args.TrainingArguments`) --
  The training arguments for the training session.</paramsdesc><paramgroups>0</paramgroups></docstring>

Returns the optimizer class and optimizer parameters based on the training arguments.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_optimizer_group</name><anchor>transformers.Trainer.get_optimizer_group</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1270</source><parameters>[{"name": "param", "val": ": typing.Union[str, torch.nn.parameter.Parameter, NoneType] = None"}]</parameters><paramsdesc>- **param** (`str` or `torch.nn.parameter.Parameter`, *optional*) --
  The parameter for which optimizer group needs to be returned.</paramsdesc><paramgroups>0</paramgroups></docstring>

Returns optimizer group for a parameter if given, else returns all optimizer groups for params.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_test_dataloader</name><anchor>transformers.Trainer.get_test_dataloader</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1143</source><parameters>[{"name": "test_dataset", "val": ": Dataset"}]</parameters><paramsdesc>- **test_dataset** (`torch.utils.data.Dataset`, *optional*) --
  The test dataset to use. If it is a [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns not accepted by the
  `model.forward()` method are automatically removed. It must implement `__len__`.</paramsdesc><paramgroups>0</paramgroups></docstring>

Returns the test `~torch.utils.data.DataLoader`.

Subclass and override this method if you want to inject some custom behavior.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_total_train_batch_size</name><anchor>transformers.Trainer.get_total_train_batch_size</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L2177</source><parameters>[{"name": "args", "val": ""}]</parameters></docstring>
Calculates total batch size (micro_batch * grad_accum * dp_world_size).

Note: Only considers DP and TP (dp_world_size = world_size // tp_size).

</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_tp_size</name><anchor>transformers.Trainer.get_tp_size</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L2163</source><parameters>[]</parameters></docstring>
Get the tensor parallel size from either the model or DeepSpeed config.

</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_train_dataloader</name><anchor>transformers.Trainer.get_train_dataloader</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1056</source><parameters>[]</parameters></docstring>

Returns the training `~torch.utils.data.DataLoader`.

Will use no sampler if `train_dataset` does not implement `__len__`, a random sampler (adapted to distributed
training if necessary) otherwise.

Subclass and override this method if you want to inject some custom behavior.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>hyperparameter_search</name><anchor>transformers.Trainer.hyperparameter_search</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3441</source><parameters>[{"name": "hp_space", "val": ": typing.Optional[collections.abc.Callable[['optuna.Trial'], dict[str, float]]] = None"}, {"name": "compute_objective", "val": ": typing.Optional[collections.abc.Callable[[dict[str, float]], float]] = None"}, {"name": "n_trials", "val": ": int = 20"}, {"name": "direction", "val": ": typing.Union[str, list[str]] = 'minimize'"}, {"name": "backend", "val": ": typing.Union[ForwardRef('str'), transformers.trainer_utils.HPSearchBackend, NoneType] = None"}, {"name": "hp_name", "val": ": typing.Optional[collections.abc.Callable[['optuna.Trial'], str]] = None"}, {"name": "**kwargs", "val": ""}]</parameters><paramsdesc>- **hp_space** (`Callable[["optuna.Trial"], dict[str, float]]`, *optional*) --
  A function that defines the hyperparameter search space. Will default to
  `default_hp_space_optuna()` or `default_hp_space_ray()`
  depending on your backend.
- **compute_objective** (`Callable[[dict[str, float]], float]`, *optional*) --
  A function computing the objective to minimize or maximize from the metrics returned by the `evaluate`
  method. Will default to `default_compute_objective()`.
- **n_trials** (`int`, *optional*, defaults to 100) --
  The number of trial runs to test.
- **direction** (`str` or `list[str]`, *optional*, defaults to `"minimize"`) --
  If it's single objective optimization, direction is `str`, can be `"minimize"` or `"maximize"`, you
  should pick `"minimize"` when optimizing the validation loss, `"maximize"` when optimizing one or
  several metrics. If it's multi objectives optimization, direction is `list[str]`, can be List of
  `"minimize"` and `"maximize"`, you should pick `"minimize"` when optimizing the validation loss,
  `"maximize"` when optimizing one or several metrics.
- **backend** (`str` or `~training_utils.HPSearchBackend`, *optional*) --
  The backend to use for hyperparameter search. Will default to optuna or Ray Tune, depending
  on which one is installed. If all are installed, will default to optuna.
- **hp_name** (`Callable[["optuna.Trial"], str]]`, *optional*) --
  A function that defines the trial/run name. Will default to None.
- **kwargs** (`dict[str, Any]`, *optional*) --
  Additional keyword arguments for each backend:

  - `optuna`: parameters from
    [optuna.study.create_study](https://optuna.readthedocs.io/en/stable/reference/generated/optuna.study.create_study.html)
    and also the parameters `timeout`, `n_jobs` and `gc_after_trial` from
    [optuna.study.Study.optimize](https://optuna.readthedocs.io/en/stable/reference/generated/optuna.study.Study.html#optuna.study.Study.optimize)
  - `ray`: parameters from [tune.run](https://docs.ray.io/en/latest/tune/api_docs/execution.html#tune-run).
    If `resources_per_trial` is not set in the `kwargs`, it defaults to 1 CPU core and 1 GPU (if available).
    If `progress_reporter` is not set in the `kwargs`,
    [ray.tune.CLIReporter](https://docs.ray.io/en/latest/tune/api/doc/ray.tune.CLIReporter.html) is used.</paramsdesc><paramgroups>0</paramgroups><rettype>[`trainer_utils.BestRun` or `list[trainer_utils.BestRun]`]</rettype><retdesc>All the information about the best run or best
runs for multi-objective optimization. Experiment summary can be found in `run_summary` attribute for Ray
backend.</retdesc></docstring>

Launch an hyperparameter search using `optuna` or `Ray Tune`. The optimized quantity is determined
by `compute_objective`, which defaults to a function returning the evaluation loss when no metric is provided,
the sum of all metrics otherwise.

<Tip warning={true}>

To use this method, you need to have provided a `model_init` when initializing your [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer): we need to
reinitialize the model at each new run. This is incompatible with the `optimizers` argument, so you need to
subclass [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) and override the method [create_optimizer_and_scheduler()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.create_optimizer_and_scheduler) for custom
optimizer/scheduler.

</Tip>








</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>init_hf_repo</name><anchor>transformers.Trainer.init_hf_repo</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4648</source><parameters>[{"name": "token", "val": ": typing.Optional[str] = None"}]</parameters></docstring>

Initializes a git repo in `self.args.hub_model_id`.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>is_local_process_zero</name><anchor>transformers.Trainer.is_local_process_zero</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3877</source><parameters>[]</parameters></docstring>

Whether or not this process is the local (e.g., on one machine if training in a distributed fashion on several
machines) main process.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>is_world_process_zero</name><anchor>transformers.Trainer.is_world_process_zero</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3884</source><parameters>[]</parameters></docstring>

Whether or not this process is the global main process (when training in a distributed fashion on several
machines, this is only going to be `True` for one process).


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>log</name><anchor>transformers.Trainer.log</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3522</source><parameters>[{"name": "logs", "val": ": dict"}, {"name": "start_time", "val": ": typing.Optional[float] = None"}]</parameters><paramsdesc>- **logs** (`dict[str, float]`) --
  The values to log.
- **start_time** (`Optional[float]`) --
  The start of training.</paramsdesc><paramgroups>0</paramgroups></docstring>

Log `logs` on the various objects watching training.

Subclass and override this method to inject custom behavior.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>log_metrics</name><anchor>transformers.Trainer.log_metrics</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_pt_utils.py#L794</source><parameters>[{"name": "split", "val": ""}, {"name": "metrics", "val": ""}]</parameters><paramsdesc>- **split** (`str`) --
  Mode/split name: one of `train`, `eval`, `test`
- **metrics** (`dict[str, float]`) --
  The metrics returned from train/evaluate/predictmetrics: metrics dict</paramsdesc><paramgroups>0</paramgroups></docstring>

Log metrics in a specially formatted way.

Under distributed environment this is done only for a process with rank 0.



Notes on memory reports:

In order to get memory usage report you need to install `psutil`. You can do that with `pip install psutil`.

<ExampleCodeBlock anchor="transformers.Trainer.log_metrics.example">

Now when this method is run, you will see a report that will include:

```
init_mem_cpu_alloc_delta   =     1301MB
init_mem_cpu_peaked_delta  =      154MB
init_mem_gpu_alloc_delta   =      230MB
init_mem_gpu_peaked_delta  =        0MB
train_mem_cpu_alloc_delta  =     1345MB
train_mem_cpu_peaked_delta =        0MB
train_mem_gpu_alloc_delta  =      693MB
train_mem_gpu_peaked_delta =        7MB
```

</ExampleCodeBlock>

**Understanding the reports:**

- the first segment, e.g., `train__`, tells you which stage the metrics are for. Reports starting with `init_`
  will be added to the first stage that gets run. So that if only evaluation is run, the memory usage for the
  `__init__` will be reported along with the `eval_` metrics.
- the third segment, is either `cpu` or `gpu`, tells you whether it's the general RAM or the gpu0 memory
  metric.
- `*_alloc_delta` - is the difference in the used/allocated memory counter between the end and the start of the
  stage - it can be negative if a function released more memory than it allocated.
- `*_peaked_delta` - is any extra memory that was consumed and then freed - relative to the current allocated
  memory counter - it is never negative. When you look at the metrics of any stage you add up `alloc_delta` +
  `peaked_delta` and you know how much memory was needed to complete that stage.

The reporting happens only for process of rank 0 and gpu 0 (if there is a gpu). Typically this is enough since the
main process does the bulk of work, but it could be not quite so if model parallel is used and then other GPUs may
use a different amount of gpu memory. This is also not the same under DataParallel where gpu0 may require much more
memory than the rest since it stores the gradient and optimizer states for all participating GPUs. Perhaps in the
future these reports will evolve to measure those too.

The CPU RAM metric measures RSS (Resident Set Size) includes both the memory which is unique to the process and the
memory shared with other processes. It is important to note that it does not include swapped out memory, so the
reports could be imprecise.

The CPU peak memory is measured using a sampling thread. Due to python's GIL it may miss some of the peak memory if
that thread didn't get a chance to run when the highest memory was used. Therefore this report can be less than
reality. Using `tracemalloc` would have reported the exact peak memory, but it doesn't report memory allocations
outside of python. So if some C++ CUDA extension allocated its own memory it won't be reported. And therefore it
was dropped in favor of the memory sampling approach, which reads the current process memory usage.

The GPU allocated and peak memory reporting is done with `torch.cuda.memory_allocated()` and
`torch.cuda.max_memory_allocated()`. This metric reports only "deltas" for pytorch-specific allocations, as
`torch.cuda` memory management system doesn't track any memory allocated outside of pytorch. For example, the very
first cuda call typically loads CUDA kernels, which may take from 0.5 to 2GB of GPU memory.

Note that this tracker doesn't account for memory allocations outside of [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)'s `__init__`, `train`,
`evaluate` and `predict` calls.

Because `evaluation` calls may happen during `train`, we can't handle nested invocations because
`torch.cuda.max_memory_allocated` is a single counter, so if it gets reset by a nested eval call, `train`'s tracker
will report incorrect info. If this [pytorch issue](https://github.com/pytorch/pytorch/issues/16266) gets resolved
it will be possible to change this class to be re-entrant. Until then we will only track the outer level of
`train`, `evaluate` and `predict` methods. Which means that if `eval` is called during `train`, it's the latter
that will account for its memory usage and that of the former.

This also means that if any other tool that is used along the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) calls
`torch.cuda.reset_peak_memory_stats`, the gpu peak memory stats could be invalid. And the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) will disrupt
the normal behavior of any such tools that rely on calling `torch.cuda.reset_peak_memory_stats` themselves.

For best performance you may want to consider turning the memory profiling off for production runs.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>metrics_format</name><anchor>transformers.Trainer.metrics_format</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_pt_utils.py#L768</source><parameters>[{"name": "metrics", "val": ": dict"}]</parameters><paramsdesc>- **metrics** (`dict[str, float]`) --
  The metrics returned from train/evaluate/predict</paramsdesc><paramgroups>0</paramgroups><rettype>metrics (`dict[str, float]`)</rettype><retdesc>The reformatted metrics</retdesc></docstring>

Reformat Trainer metrics values to a human-readable format.








</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>num_examples</name><anchor>transformers.Trainer.num_examples</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1756</source><parameters>[{"name": "dataloader", "val": ": DataLoader"}]</parameters></docstring>

Helper to get number of samples in a `~torch.utils.data.DataLoader` by accessing its dataset. When
dataloader.dataset does not exist or has no length, estimates as best it can


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>num_tokens</name><anchor>transformers.Trainer.num_tokens</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L1770</source><parameters>[{"name": "train_dl", "val": ": DataLoader"}, {"name": "max_steps", "val": ": typing.Optional[int] = None"}]</parameters></docstring>

Helper to get number of tokens in a `~torch.utils.data.DataLoader` by enumerating dataloader.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>pop_callback</name><anchor>transformers.Trainer.pop_callback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L805</source><parameters>[{"name": "callback", "val": ""}]</parameters><paramsdesc>- **callback** (`type` or [`~transformers.TrainerCallback]`) --
  A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) class or an instance of a [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback). In the
  first case, will pop the first member of that class found in the list of callbacks.</paramsdesc><paramgroups>0</paramgroups><rettype>[TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback)</rettype><retdesc>The callback removed, if found.</retdesc></docstring>

Remove a callback from the current list of [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) and returns it.

If the callback is not found, returns `None` (and no error is raised).








</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>predict</name><anchor>transformers.Trainer.predict</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4239</source><parameters>[{"name": "test_dataset", "val": ": Dataset"}, {"name": "ignore_keys", "val": ": typing.Optional[list[str]] = None"}, {"name": "metric_key_prefix", "val": ": str = 'test'"}]</parameters><paramsdesc>- **test_dataset** (`Dataset`) --
  Dataset to run the predictions on. If it is an `datasets.Dataset`, columns not accepted by the
  `model.forward()` method are automatically removed. Has to implement the method `__len__`
- **ignore_keys** (`list[str]`, *optional*) --
  A list of keys in the output of your model (if it is a dictionary) that should be ignored when
  gathering predictions.
- **metric_key_prefix** (`str`, *optional*, defaults to `"test"`) --
  An optional prefix to be used as the metrics key prefix. For example the metrics "bleu" will be named
  "test_bleu" if the prefix is "test" (default)</paramsdesc><paramgroups>0</paramgroups></docstring>

Run prediction and returns predictions and potential metrics.

Depending on the dataset and your use case, your test dataset may contain labels. In that case, this method
will also return metrics, like in `evaluate()`.



<Tip>

If your predictions or labels have different sequence length (for instance because you're doing dynamic padding
in a token classification task) the predictions will be padded (on the right) to allow for concatenation into
one array. The padding index is -100.

</Tip>

Returns: *NamedTuple* A namedtuple with the following keys:

- predictions (`np.ndarray`): The predictions on `test_dataset`.
- label_ids (`np.ndarray`, *optional*): The labels (if the dataset contained some).
- metrics (`dict[str, float]`, *optional*): The potential dictionary of metrics (if the dataset contained
  labels).


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>prediction_step</name><anchor>transformers.Trainer.prediction_step</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4525</source><parameters>[{"name": "model", "val": ": Module"}, {"name": "inputs", "val": ": dict"}, {"name": "prediction_loss_only", "val": ": bool"}, {"name": "ignore_keys", "val": ": typing.Optional[list[str]] = None"}]</parameters><paramsdesc>- **model** (`nn.Module`) --
  The model to evaluate.
- **inputs** (`dict[str, Union[torch.Tensor, Any]]`) --
  The inputs and targets of the model.

  The dictionary will be unpacked before being fed to the model. Most models expect the targets under the
  argument `labels`. Check your model's documentation for all accepted arguments.
- **prediction_loss_only** (`bool`) --
  Whether or not to return the loss only.
- **ignore_keys** (`list[str]`, *optional*) --
  A list of keys in the output of your model (if it is a dictionary) that should be ignored when
  gathering predictions.</paramsdesc><paramgroups>0</paramgroups><rettype>tuple[Optional[torch.Tensor], Optional[torch.Tensor], Optional[torch.Tensor]]</rettype><retdesc>A tuple with the loss,
logits and labels (each being optional).</retdesc></docstring>

Perform an evaluation step on `model` using `inputs`.

Subclass and override to inject custom behavior.








</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>propagate_args_to_deepspeed</name><anchor>transformers.Trainer.propagate_args_to_deepspeed</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L5046</source><parameters>[{"name": "auto_find_batch_size", "val": " = False"}]</parameters></docstring>

Sets values in the deepspeed plugin based on the Trainer args


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>push_to_hub</name><anchor>transformers.Trainer.push_to_hub</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L4815</source><parameters>[{"name": "commit_message", "val": ": typing.Optional[str] = 'End of training'"}, {"name": "blocking", "val": ": bool = True"}, {"name": "token", "val": ": typing.Optional[str] = None"}, {"name": "revision", "val": ": typing.Optional[str] = None"}, {"name": "**kwargs", "val": ""}]</parameters><paramsdesc>- **commit_message** (`str`, *optional*, defaults to `"End of training"`) --
  Message to commit while pushing.
- **blocking** (`bool`, *optional*, defaults to `True`) --
  Whether the function should return only when the `git push` has finished.
- **token** (`str`, *optional*, defaults to `None`) --
  Token with write permission to overwrite Trainer's original args.
- **revision** (`str`, *optional*) --
  The git revision to commit from. Defaults to the head of the "main" branch.
- **kwargs** (`dict[str, Any]`, *optional*) --
  Additional keyword arguments passed along to [create_model_card()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.create_model_card).</paramsdesc><paramgroups>0</paramgroups><retdesc>The URL of the repository where the model was pushed if `blocking=False`, or a `Future` object tracking the
progress of the commit if `blocking=True`.</retdesc></docstring>

Upload `self.model` and `self.processing_class` to the 🤗 model hub on the repo `self.args.hub_model_id`.






</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>remove_callback</name><anchor>transformers.Trainer.remove_callback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L821</source><parameters>[{"name": "callback", "val": ""}]</parameters><paramsdesc>- **callback** (`type` or [`~transformers.TrainerCallback]`) --
  A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) class or an instance of a [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback). In the
  first case, will remove the first member of that class found in the list of callbacks.</paramsdesc><paramgroups>0</paramgroups></docstring>

Remove a callback from the current list of [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback).




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>save_metrics</name><anchor>transformers.Trainer.save_metrics</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_pt_utils.py#L884</source><parameters>[{"name": "split", "val": ""}, {"name": "metrics", "val": ""}, {"name": "combined", "val": " = True"}]</parameters><paramsdesc>- **split** (`str`) --
  Mode/split name: one of `train`, `eval`, `test`, `all`
- **metrics** (`dict[str, float]`) --
  The metrics returned from train/evaluate/predict
- **combined** (`bool`, *optional*, defaults to `True`) --
  Creates combined metrics by updating `all_results.json` with metrics of this call</paramsdesc><paramgroups>0</paramgroups></docstring>

Save metrics into a json file for that split, e.g. `train_results.json`.

Under distributed environment this is done only for a process with rank 0.



To understand the metrics please read the docstring of [log_metrics()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.log_metrics). The only difference is that raw
unformatted numbers are saved in the current method.



</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>save_model</name><anchor>transformers.Trainer.save_model</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3896</source><parameters>[{"name": "output_dir", "val": ": typing.Optional[str] = None"}, {"name": "_internal_call", "val": ": bool = False"}]</parameters></docstring>

Will save the model, so you can reload it using `from_pretrained()`.

Will only save from the main process.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>save_state</name><anchor>transformers.Trainer.save_state</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_pt_utils.py#L922</source><parameters>[]</parameters></docstring>

Saves the Trainer state, since Trainer.save_model saves only the tokenizer with the model.

Under distributed environment this is done only for a process with rank 0.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_initial_training_values</name><anchor>transformers.Trainer.set_initial_training_values</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L5142</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "dataloader", "val": ": DataLoader"}, {"name": "total_train_batch_size", "val": ": int"}]</parameters></docstring>

Calculates and returns the following values:
- `num_train_epochs`
- `num_update_steps_per_epoch`
- `num_examples`
- `num_train_samples`
- `epoch_based`
- `len_dataloader`
- `max_steps`


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>train</name><anchor>transformers.Trainer.train</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L2056</source><parameters>[{"name": "resume_from_checkpoint", "val": ": typing.Union[str, bool, NoneType] = None"}, {"name": "trial", "val": ": typing.Union[ForwardRef('optuna.Trial'), dict[str, typing.Any], NoneType] = None"}, {"name": "ignore_keys_for_eval", "val": ": typing.Optional[list[str]] = None"}]</parameters><paramsdesc>- **resume_from_checkpoint** (`str` or `bool`, *optional*) --
  If a `str`, local path to a saved checkpoint as saved by a previous instance of [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer). If a
  `bool` and equals `True`, load the last checkpoint in *args.output_dir* as saved by a previous instance
  of [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer). If present, training will resume from the model/optimizer/scheduler states loaded here.
- **trial** (`optuna.Trial` or `dict[str, Any]`, *optional*) --
  The trial run or the hyperparameter dictionary for hyperparameter search.
- **ignore_keys_for_eval** (`list[str]`, *optional*) --
  A list of keys in the output of your model (if it is a dictionary) that should be ignored when
  gathering predictions for evaluation during the training.</paramsdesc><paramgroups>0</paramgroups></docstring>

Main training entry point.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>training_step</name><anchor>transformers.Trainer.training_step</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer.py#L3727</source><parameters>[{"name": "model", "val": ": Module"}, {"name": "inputs", "val": ": dict"}, {"name": "num_items_in_batch", "val": ": typing.Optional[torch.Tensor] = None"}]</parameters><paramsdesc>- **model** (`nn.Module`) --
  The model to train.
- **inputs** (`dict[str, Union[torch.Tensor, Any]]`) --
  The inputs and targets of the model.

  The dictionary will be unpacked before being fed to the model. Most models expect the targets under the
  argument `labels`. Check your model's documentation for all accepted arguments.</paramsdesc><paramgroups>0</paramgroups><rettype>`torch.Tensor`</rettype><retdesc>The tensor with training loss on this batch.</retdesc></docstring>

Perform a training step on a batch of inputs.

Subclass and override to inject custom behavior.








</div></div>

## Seq2SeqTrainer[[transformers.Seq2SeqTrainer]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.Seq2SeqTrainer</name><anchor>transformers.Seq2SeqTrainer</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_seq2seq.py#L53</source><parameters>[{"name": "model", "val": ": typing.Union[ForwardRef('PreTrainedModel'), torch.nn.modules.module.Module, NoneType] = None"}, {"name": "args", "val": ": typing.Optional[ForwardRef('TrainingArguments')] = None"}, {"name": "data_collator", "val": ": typing.Optional[ForwardRef('DataCollator')] = None"}, {"name": "train_dataset", "val": ": typing.Union[torch.utils.data.dataset.Dataset, ForwardRef('IterableDataset'), ForwardRef('datasets.Dataset'), NoneType] = None"}, {"name": "eval_dataset", "val": ": typing.Union[torch.utils.data.dataset.Dataset, dict[str, torch.utils.data.dataset.Dataset], NoneType] = None"}, {"name": "processing_class", "val": ": typing.Union[ForwardRef('PreTrainedTokenizerBase'), ForwardRef('BaseImageProcessor'), ForwardRef('FeatureExtractionMixin'), ForwardRef('ProcessorMixin'), NoneType] = None"}, {"name": "model_init", "val": ": typing.Optional[collections.abc.Callable[[], 'PreTrainedModel']] = None"}, {"name": "compute_loss_func", "val": ": typing.Optional[collections.abc.Callable] = None"}, {"name": "compute_metrics", "val": ": typing.Optional[collections.abc.Callable[['EvalPrediction'], dict]] = None"}, {"name": "callbacks", "val": ": typing.Optional[list['TrainerCallback']] = None"}, {"name": "optimizers", "val": ": tuple = (None, None)"}, {"name": "preprocess_logits_for_metrics", "val": ": typing.Optional[collections.abc.Callable[[torch.Tensor, torch.Tensor], torch.Tensor]] = None"}]</parameters></docstring>



<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>evaluate</name><anchor>transformers.Seq2SeqTrainer.evaluate</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_seq2seq.py#L136</source><parameters>[{"name": "eval_dataset", "val": ": typing.Optional[torch.utils.data.dataset.Dataset] = None"}, {"name": "ignore_keys", "val": ": typing.Optional[list[str]] = None"}, {"name": "metric_key_prefix", "val": ": str = 'eval'"}, {"name": "**gen_kwargs", "val": ""}]</parameters><paramsdesc>- **eval_dataset** (`Dataset`, *optional*) --
  Pass a dataset if you wish to override `self.eval_dataset`. If it is an [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns
  not accepted by the `model.forward()` method are automatically removed. It must implement the `__len__`
  method.
- **ignore_keys** (`list[str]`, *optional*) --
  A list of keys in the output of your model (if it is a dictionary) that should be ignored when
  gathering predictions.
- **metric_key_prefix** (`str`, *optional*, defaults to `"eval"`) --
  An optional prefix to be used as the metrics key prefix. For example the metrics "bleu" will be named
  "eval_bleu" if the prefix is `"eval"` (default)
- **max_length** (`int`, *optional*) --
  The maximum target length to use when predicting with the generate method.
- **num_beams** (`int`, *optional*) --
  Number of beams for beam search that will be used when predicting with the generate method. 1 means no
  beam search.
- **gen_kwargs** --
  Additional `generate` specific kwargs.</paramsdesc><paramgroups>0</paramgroups><retdesc>A dictionary containing the evaluation loss and the potential metrics computed from the predictions. The
dictionary also contains the epoch number which comes from the training state.</retdesc></docstring>

Run evaluation and returns metrics.

The calling script will be responsible for providing a method to compute metrics, as they are task-dependent
(pass it to the init `compute_metrics` argument).

You can also subclass and override this method to inject custom behavior.






</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>predict</name><anchor>transformers.Seq2SeqTrainer.predict</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_seq2seq.py#L192</source><parameters>[{"name": "test_dataset", "val": ": Dataset"}, {"name": "ignore_keys", "val": ": typing.Optional[list[str]] = None"}, {"name": "metric_key_prefix", "val": ": str = 'test'"}, {"name": "**gen_kwargs", "val": ""}]</parameters><paramsdesc>- **test_dataset** (`Dataset`) --
  Dataset to run the predictions on. If it is a [Dataset](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset), columns not accepted by the
  `model.forward()` method are automatically removed. Has to implement the method `__len__`
- **ignore_keys** (`list[str]`, *optional*) --
  A list of keys in the output of your model (if it is a dictionary) that should be ignored when
  gathering predictions.
- **metric_key_prefix** (`str`, *optional*, defaults to `"eval"`) --
  An optional prefix to be used as the metrics key prefix. For example the metrics "bleu" will be named
  "eval_bleu" if the prefix is `"eval"` (default)
- **max_length** (`int`, *optional*) --
  The maximum target length to use when predicting with the generate method.
- **num_beams** (`int`, *optional*) --
  Number of beams for beam search that will be used when predicting with the generate method. 1 means no
  beam search.
- **gen_kwargs** --
  Additional `generate` specific kwargs.</paramsdesc><paramgroups>0</paramgroups></docstring>

Run prediction and returns predictions and potential metrics.

Depending on the dataset and your use case, your test dataset may contain labels. In that case, this method
will also return metrics, like in `evaluate()`.



<Tip>

If your predictions or labels have different sequence lengths (for instance because you're doing dynamic
padding in a token classification task) the predictions will be padded (on the right) to allow for
concatenation into one array. The padding index is -100.

</Tip>

Returns: *NamedTuple* A namedtuple with the following keys:

- predictions (`np.ndarray`): The predictions on `test_dataset`.
- label_ids (`np.ndarray`, *optional*): The labels (if the dataset contained some).
- metrics (`dict[str, float]`, *optional*): The potential dictionary of metrics (if the dataset contained
  labels).


</div></div>

## TrainingArguments[[transformers.TrainingArguments]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.TrainingArguments</name><anchor>transformers.TrainingArguments</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L199</source><parameters>[{"name": "output_dir", "val": ": typing.Optional[str] = None"}, {"name": "do_train", "val": ": bool = False"}, {"name": "do_eval", "val": ": bool = False"}, {"name": "do_predict", "val": ": bool = False"}, {"name": "eval_strategy", "val": ": typing.Union[transformers.trainer_utils.IntervalStrategy, str] = 'no'"}, {"name": "prediction_loss_only", "val": ": bool = False"}, {"name": "per_device_train_batch_size", "val": ": int = 8"}, {"name": "per_device_eval_batch_size", "val": ": int = 8"}, {"name": "gradient_accumulation_steps", "val": ": int = 1"}, {"name": "eval_accumulation_steps", "val": ": typing.Optional[int] = None"}, {"name": "eval_delay", "val": ": float = 0"}, {"name": "torch_empty_cache_steps", "val": ": typing.Optional[int] = None"}, {"name": "learning_rate", "val": ": float = 5e-05"}, {"name": "weight_decay", "val": ": float = 0.0"}, {"name": "adam_beta1", "val": ": float = 0.9"}, {"name": "adam_beta2", "val": ": float = 0.999"}, {"name": "adam_epsilon", "val": ": float = 1e-08"}, {"name": "max_grad_norm", "val": ": float = 1.0"}, {"name": "num_train_epochs", "val": ": float = 3.0"}, {"name": "max_steps", "val": ": int = -1"}, {"name": "lr_scheduler_type", "val": ": typing.Union[transformers.trainer_utils.SchedulerType, str] = 'linear'"}, {"name": "lr_scheduler_kwargs", "val": ": typing.Union[dict, str, NoneType] = None"}, {"name": "warmup_ratio", "val": ": float = 0.0"}, {"name": "warmup_steps", "val": ": int = 0"}, {"name": "log_level", "val": ": str = 'passive'"}, {"name": "log_level_replica", "val": ": str = 'warning'"}, {"name": "log_on_each_node", "val": ": bool = True"}, {"name": "logging_strategy", "val": ": typing.Union[transformers.trainer_utils.IntervalStrategy, str] = 'steps'"}, {"name": "logging_first_step", "val": ": bool = False"}, {"name": "logging_steps", "val": ": float = 500"}, {"name": "logging_nan_inf_filter", "val": ": bool = True"}, {"name": "save_strategy", "val": ": typing.Union[transformers.trainer_utils.SaveStrategy, str] = 'steps'"}, {"name": "save_steps", "val": ": float = 500"}, {"name": "save_total_limit", "val": ": typing.Optional[int] = None"}, {"name": "save_safetensors", "val": ": bool = True"}, {"name": "save_on_each_node", "val": ": bool = False"}, {"name": "save_only_model", "val": ": bool = False"}, {"name": "restore_callback_states_from_checkpoint", "val": ": bool = False"}, {"name": "use_cpu", "val": ": bool = False"}, {"name": "seed", "val": ": int = 42"}, {"name": "data_seed", "val": ": typing.Optional[int] = None"}, {"name": "bf16", "val": ": bool = False"}, {"name": "fp16", "val": ": bool = False"}, {"name": "bf16_full_eval", "val": ": bool = False"}, {"name": "fp16_full_eval", "val": ": bool = False"}, {"name": "tf32", "val": ": typing.Optional[bool] = None"}, {"name": "local_rank", "val": ": int = -1"}, {"name": "ddp_backend", "val": ": typing.Optional[str] = None"}, {"name": "debug", "val": ": typing.Union[str, list[transformers.debug_utils.DebugOption]] = ''"}, {"name": "dataloader_drop_last", "val": ": bool = False"}, {"name": "eval_steps", "val": ": typing.Optional[float] = None"}, {"name": "dataloader_num_workers", "val": ": int = 0"}, {"name": "dataloader_prefetch_factor", "val": ": typing.Optional[int] = None"}, {"name": "run_name", "val": ": typing.Optional[str] = None"}, {"name": "disable_tqdm", "val": ": typing.Optional[bool] = None"}, {"name": "remove_unused_columns", "val": ": bool = True"}, {"name": "label_names", "val": ": typing.Optional[list[str]] = None"}, {"name": "load_best_model_at_end", "val": ": bool = False"}, {"name": "metric_for_best_model", "val": ": typing.Optional[str] = None"}, {"name": "greater_is_better", "val": ": typing.Optional[bool] = None"}, {"name": "ignore_data_skip", "val": ": bool = False"}, {"name": "fsdp", "val": ": typing.Union[list[transformers.trainer_utils.FSDPOption], str, NoneType] = None"}, {"name": "fsdp_config", "val": ": typing.Union[dict[str, typing.Any], str, NoneType] = None"}, {"name": "accelerator_config", "val": ": typing.Union[dict, str, NoneType] = None"}, {"name": "parallelism_config", "val": ": typing.Optional[accelerate.parallelism_config.ParallelismConfig] = None"}, {"name": "deepspeed", "val": ": typing.Union[dict, str, NoneType] = None"}, {"name": "label_smoothing_factor", "val": ": float = 0.0"}, {"name": "optim", "val": ": typing.Union[transformers.training_args.OptimizerNames, str] = 'adamw_torch_fused'"}, {"name": "optim_args", "val": ": typing.Optional[str] = None"}, {"name": "group_by_length", "val": ": bool = False"}, {"name": "length_column_name", "val": ": str = 'length'"}, {"name": "report_to", "val": ": typing.Union[NoneType, str, list[str]] = 'none'"}, {"name": "project", "val": ": str = 'huggingface'"}, {"name": "trackio_space_id", "val": ": typing.Optional[str] = 'trackio'"}, {"name": "ddp_find_unused_parameters", "val": ": typing.Optional[bool] = None"}, {"name": "ddp_bucket_cap_mb", "val": ": typing.Optional[int] = None"}, {"name": "ddp_broadcast_buffers", "val": ": typing.Optional[bool] = None"}, {"name": "dataloader_pin_memory", "val": ": bool = True"}, {"name": "dataloader_persistent_workers", "val": ": bool = False"}, {"name": "skip_memory_metrics", "val": ": bool = True"}, {"name": "push_to_hub", "val": ": bool = False"}, {"name": "resume_from_checkpoint", "val": ": typing.Optional[str] = None"}, {"name": "hub_model_id", "val": ": typing.Optional[str] = None"}, {"name": "hub_strategy", "val": ": typing.Union[transformers.trainer_utils.HubStrategy, str] = 'every_save'"}, {"name": "hub_token", "val": ": typing.Optional[str] = None"}, {"name": "hub_private_repo", "val": ": typing.Optional[bool] = None"}, {"name": "hub_always_push", "val": ": bool = False"}, {"name": "hub_revision", "val": ": typing.Optional[str] = None"}, {"name": "gradient_checkpointing", "val": ": bool = False"}, {"name": "gradient_checkpointing_kwargs", "val": ": typing.Union[dict[str, typing.Any], str, NoneType] = None"}, {"name": "include_for_metrics", "val": ": list = <factory>"}, {"name": "eval_do_concat_batches", "val": ": bool = True"}, {"name": "auto_find_batch_size", "val": ": bool = False"}, {"name": "full_determinism", "val": ": bool = False"}, {"name": "ddp_timeout", "val": ": int = 1800"}, {"name": "torch_compile", "val": ": bool = False"}, {"name": "torch_compile_backend", "val": ": typing.Optional[str] = None"}, {"name": "torch_compile_mode", "val": ": typing.Optional[str] = None"}, {"name": "include_num_input_tokens_seen", "val": ": typing.Union[str, bool] = 'no'"}, {"name": "neftune_noise_alpha", "val": ": typing.Optional[float] = None"}, {"name": "optim_target_modules", "val": ": typing.Union[NoneType, str, list[str]] = None"}, {"name": "batch_eval_metrics", "val": ": bool = False"}, {"name": "eval_on_start", "val": ": bool = False"}, {"name": "use_liger_kernel", "val": ": bool = False"}, {"name": "liger_kernel_config", "val": ": typing.Optional[dict[str, bool]] = None"}, {"name": "eval_use_gather_object", "val": ": bool = False"}, {"name": "average_tokens_across_devices", "val": ": bool = True"}, {"name": "use_cache", "val": ": bool = False"}]</parameters><paramsdesc>- **output_dir** (`str`, *optional*, defaults to `"trainer_output"`) --
  The output directory where the model predictions and checkpoints will be written.
- **do_train** (`bool`, *optional*, defaults to `False`) --
  Whether to run training or not. This argument is not directly used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's intended to be used
  by your training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **do_eval** (`bool`, *optional*) --
  Whether to run evaluation on the validation set or not. Will be set to `True` if `eval_strategy` is
  different from `"no"`. This argument is not directly used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's intended to be used by your
  training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **do_predict** (`bool`, *optional*, defaults to `False`) --
  Whether to run predictions on the test set or not. This argument is not directly used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's
  intended to be used by your training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **eval_strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"no"`) --
  The evaluation strategy to adopt during training. Possible values are:

  - `"no"`: No evaluation is done during training.
  - `"steps"`: Evaluation is done (and logged) every `eval_steps`.
  - `"epoch"`: Evaluation is done at the end of each epoch.

- **prediction_loss_only** (`bool`, *optional*, defaults to `False`) --
  When performing evaluation and generating predictions, only returns the loss.
- **per_device_train_batch_size** (`int`, *optional*, defaults to 8) --
  The batch size *per device*. The **global batch size** is computed as:
  `per_device_train_batch_size * number_of_devices` in multi-GPU or distributed setups.
- **per_device_eval_batch_size** (`int`, *optional*, defaults to 8) --
  The batch size per device accelerator core/CPU for evaluation.
- **gradient_accumulation_steps** (`int`, *optional*, defaults to 1) --
  Number of updates steps to accumulate the gradients for, before performing a backward/update pass.

  <Tip warning={true}>

  When using gradient accumulation, one step is counted as one step with backward pass. Therefore, logging,
  evaluation, save will be conducted every `gradient_accumulation_steps * xxx_step` training examples.

  </Tip>

- **eval_accumulation_steps** (`int`, *optional*) --
  Number of predictions steps to accumulate the output tensors for, before moving the results to the CPU. If
  left unset, the whole predictions are accumulated on the device accelerator before being moved to the CPU (faster but
  requires more memory).
- **eval_delay** (`float`, *optional*) --
  Number of epochs or steps to wait for before the first evaluation can be performed, depending on the
  eval_strategy.
- **torch_empty_cache_steps** (`int`, *optional*) --
  Number of steps to wait before calling `torch.<device>.empty_cache()`. If left unset or set to None, cache will not be emptied.

  <Tip>

  This can help avoid CUDA out-of-memory errors by lowering peak VRAM usage at a cost of about [10% slower performance](https://github.com/huggingface/transformers/issues/31372).

  </Tip>

- **learning_rate** (`float`, *optional*, defaults to 5e-5) --
  The initial learning rate for `AdamW` optimizer.
- **weight_decay** (`float`, *optional*, defaults to 0) --
  The weight decay to apply (if not zero) to all layers except all bias and LayerNorm weights in `AdamW`
  optimizer.
- **adam_beta1** (`float`, *optional*, defaults to 0.9) --
  The beta1 hyperparameter for the `AdamW` optimizer.
- **adam_beta2** (`float`, *optional*, defaults to 0.999) --
  The beta2 hyperparameter for the `AdamW` optimizer.
- **adam_epsilon** (`float`, *optional*, defaults to 1e-8) --
  The epsilon hyperparameter for the `AdamW` optimizer.
- **max_grad_norm** (`float`, *optional*, defaults to 1.0) --
  Maximum gradient norm (for gradient clipping).
- **num_train_epochs(`float`,** *optional*, defaults to 3.0) --
  Total number of training epochs to perform (if not an integer, will perform the decimal part percents of
  the last epoch before stopping training).
- **max_steps** (`int`, *optional*, defaults to -1) --
  If set to a positive number, the total number of training steps to perform. Overrides `num_train_epochs`.
  For a finite dataset, training is reiterated through the dataset (if all data is exhausted) until
  `max_steps` is reached.
- **lr_scheduler_type** (`str` or [SchedulerType](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.SchedulerType), *optional*, defaults to `"linear"`) --
  The scheduler type to use. See the documentation of [SchedulerType](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.SchedulerType) for all possible values.
- **lr_scheduler_kwargs** (`dict` or `str`, *optional*, defaults to `None`) --
  The extra arguments for the lr_scheduler. See the documentation of each scheduler for possible values.
- **warmup_ratio** (`float`, *optional*, defaults to 0.0) --
  Ratio of total training steps used for a linear warmup from 0 to `learning_rate`.
- **warmup_steps** (`int`, *optional*, defaults to 0) --
  Number of steps used for a linear warmup from 0 to `learning_rate`. Overrides any effect of `warmup_ratio`.
- **log_level** (`str`, *optional*, defaults to `passive`) --
  Logger log level to use on the main process. Possible choices are the log levels as strings: 'debug',
  'info', 'warning', 'error' and 'critical', plus a 'passive' level which doesn't set anything and keeps the
  current log level for the Transformers library (which will be `"warning"` by default).
- **log_level_replica** (`str`, *optional*, defaults to `"warning"`) --
  Logger log level to use on replicas. Same choices as `log_level`"
- **log_on_each_node** (`bool`, *optional*, defaults to `True`) --
  In multinode distributed training, whether to log using `log_level` once per node, or only on the main
  node.
- **logging_strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"steps"`) --
  The logging strategy to adopt during training. Possible values are:

  - `"no"`: No logging is done during training.
  - `"epoch"`: Logging is done at the end of each epoch.
  - `"steps"`: Logging is done every `logging_steps`.

- **logging_first_step** (`bool`, *optional*, defaults to `False`) --
  Whether to log the first `global_step` or not.
- **logging_steps** (`int` or `float`, *optional*, defaults to 500) --
  Number of update steps between two logs if `logging_strategy="steps"`. Should be an integer or a float in
  range `[0,1)`. If smaller than 1, will be interpreted as ratio of total training steps.
- **logging_nan_inf_filter** (`bool`, *optional*, defaults to `True`) --
  Whether to filter `nan` and `inf` losses for logging. If set to `True` the loss of every step that is `nan`
  or `inf` is filtered and the average loss of the current logging window is taken instead.

  <Tip>

  `logging_nan_inf_filter` only influences the logging of loss values, it does not change the behavior the
  gradient is computed or applied to the model.

  </Tip>

- **save_strategy** (`str` or `SaveStrategy`, *optional*, defaults to `"steps"`) --
  The checkpoint save strategy to adopt during training. Possible values are:

  - `"no"`: No save is done during training.
  - `"epoch"`: Save is done at the end of each epoch.
  - `"steps"`: Save is done every `save_steps`.
  - `"best"`: Save is done whenever a new `best_metric` is achieved.

  If `"epoch"` or `"steps"` is chosen, saving will also be performed at the
  very end of training, always.
- **save_steps** (`int` or `float`, *optional*, defaults to 500) --
  Number of updates steps before two checkpoint saves if `save_strategy="steps"`. Should be an integer or a
  float in range `[0,1)`. If smaller than 1, will be interpreted as ratio of total training steps.
- **save_total_limit** (`int`, *optional*) --
  If a value is passed, will limit the total amount of checkpoints. Deletes the older checkpoints in
  `output_dir`. When `load_best_model_at_end` is enabled, the "best" checkpoint according to
  `metric_for_best_model` will always be retained in addition to the most recent ones. For example, for
  `save_total_limit=5` and `load_best_model_at_end`, the four last checkpoints will always be retained
  alongside the best model. When `save_total_limit=1` and `load_best_model_at_end`, it is possible that two
  checkpoints are saved: the last one and the best one (if they are different).
- **save_safetensors** (`bool`, *optional*, defaults to `True`) --
  Use [safetensors](https://huggingface.co/docs/safetensors) saving and loading for state dicts instead of
  default `torch.load` and `torch.save`.
- **save_on_each_node** (`bool`, *optional*, defaults to `False`) --
  When doing multi-node distributed training, whether to save models and checkpoints on each node, or only on
  the main one.

  This should not be activated when the different nodes use the same storage as the files will be saved with
  the same names for each node.
- **save_only_model** (`bool`, *optional*, defaults to `False`) --
  When checkpointing, whether to only save the model, or also the optimizer, scheduler & rng state.
  Note that when this is true, you won't be able to resume training from checkpoint.
  This enables you to save storage by not storing the optimizer, scheduler & rng state.
  You can only load the model using `from_pretrained` with this option set to `True`.
- **restore_callback_states_from_checkpoint** (`bool`, *optional*, defaults to `False`) --
  Whether to restore the callback states from the checkpoint. If `True`, will override
  callbacks passed to the `Trainer` if they exist in the checkpoint."
- **use_cpu** (`bool`, *optional*, defaults to `False`) --
  Whether or not to use cpu. If set to False, we will use the available torch device/backend.
- **seed** (`int`, *optional*, defaults to 42) --
  Random seed that will be set at the beginning of training. To ensure reproducibility across runs, use the
  `~Trainer.model_init` function to instantiate the model if it has some randomly initialized parameters.
- **data_seed** (`int`, *optional*) --
  Random seed to be used with data samplers. If not set, random generators for data sampling will use the
  same seed as `seed`. This can be used to ensure reproducibility of data sampling, independent of the model
  seed.
- **bf16** (`bool`, *optional*, defaults to `False`) --
  Whether to use bf16 16-bit (mixed) precision training instead of 32-bit training. Requires Ampere or higher
  NVIDIA architecture or Intel XPU or using CPU (use_cpu) or Ascend NPU.
- **fp16** (`bool`, *optional*, defaults to `False`) --
  Whether to use fp16 16-bit (mixed) precision training instead of 32-bit training.
- **bf16_full_eval** (`bool`, *optional*, defaults to `False`) --
  Whether to use full bfloat16 evaluation instead of 32-bit. This will be faster and save memory but can harm
  metric values.
- **fp16_full_eval** (`bool`, *optional*, defaults to `False`) --
  Whether to use full float16 evaluation instead of 32-bit. This will be faster and save memory but can harm
  metric values.
- **tf32** (`bool`, *optional*) --
  Whether to enable the TF32 mode, available in Ampere and newer GPU architectures. The default value depends
  on PyTorch's version default of `torch.backends.cuda.matmul.allow_tf32`. For more details please refer to
  the [TF32](https://huggingface.co/docs/transformers/perf_train_gpu_one#tf32) documentation. This is an
  experimental API and it may change.
- **ddp_backend** (`str`, *optional*) --
  The backend to use for distributed training. Must be one of `"nccl"`, `"mpi"`, `"ccl"`, `"gloo"`, `"hccl"`.
- **dataloader_drop_last** (`bool`, *optional*, defaults to `False`) --
  Whether to drop the last incomplete batch (if the length of the dataset is not divisible by the batch size)
  or not.
- **eval_steps** (`int` or `float`, *optional*) --
  Number of update steps between two evaluations if `eval_strategy="steps"`. Will default to the same
  value as `logging_steps` if not set. Should be an integer or a float in range `[0,1)`. If smaller than 1,
  will be interpreted as ratio of total training steps.
- **dataloader_num_workers** (`int`, *optional*, defaults to 0) --
  Number of subprocesses to use for data loading (PyTorch only). 0 means that the data will be loaded in the
  main process.
- **run_name** (`str`, *optional*) --
  A descriptor for the run. Typically used for [trackio](https://github.com/gradio-app/trackio),
  [wandb](https://www.wandb.com/), [mlflow](https://www.mlflow.org/), [comet](https://www.comet.com/site) and
  [swanlab](https://swanlab.cn) logging.
- **disable_tqdm** (`bool`, *optional*) --
  Whether or not to disable the tqdm progress bars and table of metrics produced by
  `~notebook.NotebookTrainingTracker` in Jupyter Notebooks. Will default to `True` if the logging level is
  set to warn or lower (default), `False` otherwise.
- **remove_unused_columns** (`bool`, *optional*, defaults to `True`) --
  Whether or not to automatically remove the columns unused by the model forward method.
- **label_names** (`list[str]`, *optional*) --
  The list of keys in your dictionary of inputs that correspond to the labels.

  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.

  You should only specify `label_names` if you're using custom label names or if your model's `forward` consumes multiple label tensors (e.g., extractive QA).
- **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. When this option is
  enabled, the best checkpoint will always be saved. See
  [`save_total_limit`](https://huggingface.co/docs/transformers/main_classes/trainer#transformers.TrainingArguments.save_total_limit)
  for more.

  <Tip>

  When set to `True`, the parameters `save_strategy` needs to be the same as `eval_strategy`, and in
  the case it is "steps", `save_steps` must be a round multiple of `eval_steps`.

  </Tip>

- **metric_for_best_model** (`str`, *optional*) --
  Use in conjunction with `load_best_model_at_end` to specify the metric to use to compare two different
  models. Must be the name of a metric returned by the evaluation with or without the prefix `"eval_"`.

  If not specified, this will default to `"loss"` when either `load_best_model_at_end == True`
  or `lr_scheduler_type == SchedulerType.REDUCE_ON_PLATEAU` (to use the evaluation loss).

  If you set this value, `greater_is_better` will default to `True` unless the name ends with "loss".
  Don't forget to set it to `False` if your metric is better when lower.
- **greater_is_better** (`bool`, *optional*) --
  Use in conjunction with `load_best_model_at_end` and `metric_for_best_model` to specify if better models
  should have a greater metric or not. Will default to:

  - `True` if `metric_for_best_model` is set to a value that doesn't end in `"loss"`.
  - `False` if `metric_for_best_model` is not set, or set to a value that ends in `"loss"`.
- **ignore_data_skip** (`bool`, *optional*, defaults to `False`) --
  When resuming training, whether or not to skip the epochs and batches to get the data loading at the same
  stage as in the previous training. If set to `True`, the training will begin faster (as that skipping step
  can take a long time) but will not yield the same results as the interrupted training would have.
- **fsdp** (`bool`, `str` or list of `FSDPOption`, *optional*, defaults to `None`) --
  Use PyTorch Distributed Parallel Training (in distributed training only).

  A list of options along the following:

  - `"full_shard"`: Shard parameters, gradients and optimizer states.
  - `"shard_grad_op"`: Shard optimizer states and gradients.
  - `"hybrid_shard"`: Apply `FULL_SHARD` within a node, and replicate parameters across nodes.
  - `"hybrid_shard_zero2"`: Apply `SHARD_GRAD_OP` within a node, and replicate parameters across nodes.
  - `"offload"`: Offload parameters and gradients to CPUs (only compatible with `"full_shard"` and
    `"shard_grad_op"`).
  - `"auto_wrap"`: Automatically recursively wrap layers with FSDP using `default_auto_wrap_policy`.
- **fsdp_config** (`str` or `dict`, *optional*) --
  Config to be used with fsdp (Pytorch Distributed Parallel Training). The value is either a location of
  fsdp json config file (e.g., `fsdp_config.json`) or an already loaded json file as `dict`.

  A List of config and its options:
  - min_num_params (`int`, *optional*, defaults to `0`):
    FSDP's minimum number of parameters for Default Auto Wrapping. (useful only when `fsdp` field is
    passed).
  - transformer_layer_cls_to_wrap (`list[str]`, *optional*):
    List of transformer layer class names (case-sensitive) to wrap, e.g, `BertLayer`, `GPTJBlock`,
    `T5Block` .... (useful only when `fsdp` flag is passed).
  - backward_prefetch (`str`, *optional*)
    FSDP's backward prefetch mode. Controls when to prefetch next set of parameters (useful only when
    `fsdp` field is passed).

    A list of options along the following:

    - `"backward_pre"` : Prefetches the next set of parameters before the current set of parameter's
      gradient computation.
    - `"backward_post"` : This prefetches the next set of parameters after the current set of
      parameter's gradient computation.
  - forward_prefetch (`bool`, *optional*, defaults to `False`)
    FSDP's forward prefetch mode (useful only when `fsdp` field is passed).
    If `"True"`, then FSDP explicitly prefetches the next upcoming all-gather while executing in the
    forward pass.
  - limit_all_gathers (`bool`, *optional*, defaults to `False`)
    FSDP's limit_all_gathers (useful only when `fsdp` field is passed).
    If `"True"`, FSDP explicitly synchronizes the CPU thread to prevent too many in-flight
    all-gathers.
  - use_orig_params (`bool`, *optional*, defaults to `True`)
    If `"True"`, allows non-uniform `requires_grad` during init, which means support for interspersed
    frozen and trainable parameters. Useful in cases such as parameter-efficient fine-tuning. Please
    refer this
    [blog](https://dev-discuss.pytorch.org/t/rethinking-pytorch-fully-sharded-data-parallel-fsdp-from-first-principles/1019
  - sync_module_states (`bool`, *optional*, defaults to `True`)
    If `"True"`, each individually wrapped FSDP unit will broadcast module parameters from rank 0 to
    ensure they are the same across all ranks after initialization
  - cpu_ram_efficient_loading (`bool`, *optional*, defaults to `False`)
    If `"True"`, only the first process loads the pretrained model checkpoint while all other processes
    have empty weights.  When this setting as `"True"`, `sync_module_states` also must to be `"True"`,
    otherwise all the processes except the main process would have random weights leading to unexpected
    behaviour during training.
  - activation_checkpointing (`bool`, *optional*, defaults to `False`):
    If `"True"`, activation checkpointing is a technique to reduce memory usage by clearing activations of
    certain layers and recomputing them during a backward pass. Effectively, this trades extra
    computation time for reduced memory usage.
  - xla (`bool`, *optional*, defaults to `False`):
    Whether to use PyTorch/XLA Fully Sharded Data Parallel Training. This is an experimental feature
    and its API may evolve in the future.
  - xla_fsdp_settings (`dict`, *optional*)
    The value is a dictionary which stores the XLA FSDP wrapping parameters.

    For a complete list of options, please see [here](
    https://github.com/pytorch/xla/blob/master/torch_xla/distributed/fsdp/xla_fully_sharded_data_parallel.py).
  - xla_fsdp_grad_ckpt (`bool`, *optional*, defaults to `False`):
    Will use gradient checkpointing over each nested XLA FSDP wrapped layer. This setting can only be
    used when the xla flag is set to true, and an auto wrapping policy is specified through
    fsdp_min_num_params or fsdp_transformer_layer_cls_to_wrap.
- **deepspeed** (`str` or `dict`, *optional*) --
  Use [Deepspeed](https://github.com/deepspeedai/DeepSpeed). This is an experimental feature and its API may
  evolve in the future. The value is either the location of DeepSpeed json config file (e.g.,
  `ds_config.json`) or an already loaded json file as a `dict`"

  <Tip warning={true}>
  If enabling any Zero-init, make sure that your model is not initialized until
  *after* initializing the `TrainingArguments`, else it will not be applied.
  </Tip>

- **accelerator_config** (`str`, `dict`, or `AcceleratorConfig`, *optional*) --
  Config to be used with the internal `Accelerator` implementation. The value is either a location of
  accelerator json config file (e.g., `accelerator_config.json`), an already loaded json file as `dict`,
  or an instance of `AcceleratorConfig`.

  A list of config and its options:
  - split_batches (`bool`, *optional*, defaults to `False`):
    Whether or not the accelerator should split the batches yielded by the dataloaders across the devices. If
    `True` the actual batch size used will be the same on any kind of distributed processes, but it must be a
    round multiple of the `num_processes` you are using. If `False`, actual batch size used will be the one set
    in your script multiplied by the number of processes.
  - dispatch_batches (`bool`, *optional*):
    If set to `True`, the dataloader prepared by the Accelerator is only iterated through on the main process
    and then the batches are split and broadcast to each process. Will default to `True` for `DataLoader` whose
    underlying dataset is an `IterableDataset`, `False` otherwise.
  - even_batches (`bool`, *optional*, defaults to `True`):
    If set to `True`, in cases where the total batch size across all processes does not exactly divide the
    dataset, samples at the start of the dataset will be duplicated so the batch can be divided equally among
    all workers.
  - use_seedable_sampler (`bool`, *optional*, defaults to `True`):
    Whether or not use a fully seedable random sampler (`accelerate.data_loader.SeedableRandomSampler`). Ensures
    training results are fully reproducible using a different sampling technique. While seed-to-seed results
    may differ, on average the differences are negligible when using multiple different seeds to compare. Should
    also be ran with `~utils.set_seed` for the best results.
  - use_configured_state (`bool`, *optional*, defaults to `False`):
    Whether or not to use a pre-configured `AcceleratorState` or `PartialState` defined before calling `TrainingArguments`.
    If `True`, an `Accelerator` or `PartialState` must be initialized. Note that by doing so, this could lead to issues
    with hyperparameter tuning.
- **parallelism_config** (`ParallelismConfig`, *optional*) --
  Parallelism configuration for the training run. Requires Accelerate `1.10.1`
- **label_smoothing_factor** (`float`, *optional*, defaults to 0.0) --
  The label smoothing factor to use. Zero means no label smoothing, otherwise the underlying onehot-encoded
  labels are changed from 0s and 1s to `label_smoothing_factor/num_labels` and `1 - label_smoothing_factor +
  label_smoothing_factor/num_labels` respectively.
- **debug** (`str` or list of `DebugOption`, *optional*, defaults to `""`) --
  Enable one or more debug features. This is an experimental feature.

  Possible options are:

  - `"underflow_overflow"`: detects overflow in model's input/outputs and reports the last frames that led to
    the event
  - `"tpu_metrics_debug"`: print debug metrics on TPU

  The options should be separated by whitespaces.
- **optim** (`str` or `training_args.OptimizerNames`, *optional*, defaults to `"adamw_torch"` (for torch>=2.8 `"adamw_torch_fused"`)) --
  The optimizer to use, such as "adamw_torch", "adamw_torch_fused", "adamw_anyprecision",
  "adafactor". See `OptimizerNames` in [training_args.py](https://github.com/huggingface/transformers/blob/main/src/transformers/training_args.py)
  for a full list of optimizers.
- **optim_args** (`str`, *optional*) --
  Optional arguments that are supplied to optimizers such as AnyPrecisionAdamW, AdEMAMix, and GaLore.
- **group_by_length** (`bool`, *optional*, defaults to `False`) --
  Whether or not to group together samples of roughly the same length in the training dataset (to minimize
  padding applied and be more efficient). Only useful if applying dynamic padding.
- **length_column_name** (`str`, *optional*, defaults to `"length"`) --
  Column name for precomputed lengths. If the column exists, grouping by length will use these values rather
  than computing them on train startup. Ignored unless `group_by_length` is `True` and the dataset is an
  instance of `Dataset`.
- **report_to** (`str` or `list[str]`, *optional*, defaults to `"none"`) --
  The list of integrations to report the results and logs to. Supported platforms are `"azure_ml"`,
  `"clearml"`, `"codecarbon"`, `"comet_ml"`, `"dagshub"`, `"dvclive"`, `"flyte"`, `"mlflow"`, `"neptune"`,
  `"swanlab"`, `"tensorboard"`, `"trackio"` and `"wandb"`. Use `"all"` to report to all integrations
  installed, `"none"` for no integrations.
- **project** (`str`, *optional*, defaults to `"huggingface"`) --
  The name of the project to use for logging. Currently, only used by Trackio.
- **trackio_space_id** (`str` or `None`, *optional*, defaults to `"trackio"`) --
  The Hugging Face Space ID to deploy to when using Trackio. Should be a complete Space name like
  `'username/reponame'` or `'orgname/reponame' `, or just `'reponame'` in which case the Space will be
  created in the currently-logged-in Hugging Face user's namespace. If `None`, will log to a local directory.
  Note that this Space will be public unless you set `hub_private_repo=True` or your organization's default
  is to create private Spaces."
- **ddp_find_unused_parameters** (`bool`, *optional*) --
  When using distributed training, the value of the flag `find_unused_parameters` passed to
  `DistributedDataParallel`. Will default to `False` if gradient checkpointing is used, `True` otherwise.
- **ddp_bucket_cap_mb** (`int`, *optional*) --
  When using distributed training, the value of the flag `bucket_cap_mb` passed to `DistributedDataParallel`.
- **ddp_broadcast_buffers** (`bool`, *optional*) --
  When using distributed training, the value of the flag `broadcast_buffers` passed to
  `DistributedDataParallel`. Will default to `False` if gradient checkpointing is used, `True` otherwise.
- **dataloader_pin_memory** (`bool`, *optional*, defaults to `True`) --
  Whether you want to pin memory in data loaders or not. Will default to `True`.
- **dataloader_persistent_workers** (`bool`, *optional*, defaults to `False`) --
  If True, the data loader will not shut down the worker processes after a dataset has been consumed once.
  This allows to maintain the workers Dataset instances alive. Can potentially speed up training, but will
  increase RAM usage. Will default to `False`.
- **dataloader_prefetch_factor** (`int`, *optional*) --
  Number of batches loaded in advance by each worker.
  2 means there will be a total of 2 * num_workers batches prefetched across all workers.
- **skip_memory_metrics** (`bool`, *optional*, defaults to `True`) --
  Whether to skip adding of memory profiler reports to metrics. This is skipped by default because it slows
  down the training and evaluation speed.
- **push_to_hub** (`bool`, *optional*, defaults to `False`) --
  Whether or not to push the model to the Hub every time the model is saved. If this is activated,
  `output_dir` will begin a git directory synced with the repo (determined by `hub_model_id`) and the content
  will be pushed each time a save is triggered (depending on your `save_strategy`). Calling
  [save_model()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.save_model) will also trigger a push.

  <Tip warning={true}>

  If `output_dir` exists, it needs to be a local clone of the repository to which the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) will be
  pushed.

  </Tip>

- **resume_from_checkpoint** (`str`, *optional*) --
  The path to a folder with a valid checkpoint for your model. This argument is not directly used by
  [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's intended to be used by your training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **hub_model_id** (`str`, *optional*) --
  The name of the repository to keep in sync with the local *output_dir*. It can be a simple model ID in
  which case the model will be pushed in your namespace. Otherwise it should be the whole repository name,
  for instance `"user_name/model"`, which allows you to push to an organization you are a member of with
  `"organization_name/model"`. Will default to `user_name/output_dir_name` with *output_dir_name* being the
  name of `output_dir`.

  Will default to the name of `output_dir`.
- **hub_strategy** (`str` or `HubStrategy`, *optional*, defaults to `"every_save"`) --
  Defines the scope of what is pushed to the Hub and when. Possible values are:

  - `"end"`: push the model, its configuration, the processing class e.g. tokenizer (if passed along to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)) and a
    draft of a model card when the [save_model()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.save_model) method is called.
  - `"every_save"`: push the model, its configuration, the processing class e.g. tokenizer (if passed along to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)) and
    a draft of a model card each time there is a model save. The pushes are asynchronous to not block
    training, and in case the save are very frequent, a new push is only attempted if the previous one is
    finished. A last push is made with the final model at the end of training.
  - `"checkpoint"`: like `"every_save"` but the latest checkpoint is also pushed in a subfolder named
    last-checkpoint, allowing you to resume training easily with
    `trainer.train(resume_from_checkpoint="last-checkpoint")`.
  - `"all_checkpoints"`: like `"checkpoint"` but all checkpoints are pushed like they appear in the output
    folder (so you will get one checkpoint folder per folder in your final repository)

- **hub_token** (`str`, *optional*) --
  The token to use to push the model to the Hub. Will default to the token in the cache folder obtained with
  `hf auth login`.
- **hub_private_repo** (`bool`, *optional*) --
  Whether to make the repo private. If `None` (default), the repo will be public unless the organization's
  default is private. This value is ignored if the repo already exists. If reporting to Trackio with
  deployment to Hugging Face Spaces enabled, the same logic determines whether the Space is private.
- **hub_always_push** (`bool`, *optional*, defaults to `False`) --
  Unless this is `True`, the `Trainer` will skip pushing a checkpoint when the previous push is not finished.
- **hub_revision** (`str`, *optional*) --
  The revision to use when pushing to the Hub. Can be a branch name, a tag, or a commit hash.
- **gradient_checkpointing** (`bool`, *optional*, defaults to `False`) --
  If True, use gradient checkpointing to save memory at the expense of slower backward pass.
- **gradient_checkpointing_kwargs** (`dict`, *optional*, defaults to `None`) --
  Key word arguments to be passed to the `gradient_checkpointing_enable` method.
- **include_for_metrics** (`list[str]`, *optional*, defaults to `[]`) --
  Include additional data in the `compute_metrics` function if needed for metrics computation.
  Possible options to add to `include_for_metrics` list:
  - `"inputs"`: Input data passed to the model, intended for calculating input dependent metrics.
  - `"loss"`: Loss values computed during evaluation, intended for calculating loss dependent metrics.
- **eval_do_concat_batches** (`bool`, *optional*, defaults to `True`) --
  Whether to recursively concat inputs/losses/labels/predictions across batches. If `False`,
  will instead store them as lists, with each batch kept separate.
- **auto_find_batch_size** (`bool`, *optional*, defaults to `False`) --
  Whether to find a batch size that will fit into memory automatically through exponential decay, avoiding
  CUDA Out-of-Memory errors. Requires accelerate to be installed (`pip install accelerate`)
- **full_determinism** (`bool`, *optional*, defaults to `False`) --
  If `True`, [enable_full_determinism()](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.enable_full_determinism) is called instead of [set_seed()](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.set_seed) to ensure reproducible results in
  distributed training. Important: this will negatively impact the performance, so only use it for debugging.
- **ddp_timeout** (`int`, *optional*, defaults to 1800) --
  The timeout for `torch.distributed.init_process_group` calls, used to avoid GPU socket timeouts when
  performing slow operations in distributed runnings. Please refer the [PyTorch documentation]
  (https://pytorch.org/docs/stable/distributed.html#torch.distributed.init_process_group) for more
  information.
- **torch_compile** (`bool`, *optional*, defaults to `False`) --
  Whether or not to compile the model using PyTorch 2.0
  [`torch.compile`](https://pytorch.org/get-started/pytorch-2.0/).

  This will use the best defaults for the [`torch.compile`
  API](https://pytorch.org/docs/stable/generated/torch.compile.html?highlight=torch+compile#torch.compile).
  You can customize the defaults with the argument `torch_compile_backend` and `torch_compile_mode` but we
  don't guarantee any of them will work as the support is progressively rolled in in PyTorch.

  This flag and the whole compile API is experimental and subject to change in future releases.
- **torch_compile_backend** (`str`, *optional*) --
  The backend to use in `torch.compile`. If set to any value, `torch_compile` will be set to `True`.

  Refer to the PyTorch doc for possible values and note that they may change across PyTorch versions.

  This flag is experimental and subject to change in future releases.
- **torch_compile_mode** (`str`, *optional*) --
  The mode to use in `torch.compile`. If set to any value, `torch_compile` will be set to `True`.

  Refer to the PyTorch doc for possible values and note that they may change across PyTorch versions.

  This flag is experimental and subject to change in future releases.
- **include_num_input_tokens_seen** (`Optional[Union[str, bool]]`, *optional*, defaults to "no") --
  Whether to track the number of input tokens seen. Must be one of ["all", "non_padding", "no"] or a boolean value which map to "all" or "no".
  May be slower in distributed training as gather operations must be called.

- **neftune_noise_alpha** (`Optional[float]`) --
  If not `None`, this will activate NEFTune noise embeddings. This can drastically improve model performance
  for instruction fine-tuning. Check out the [original paper](https://huggingface.co/papers/2310.05914) and the
  [original code](https://github.com/neelsjain/NEFTune). Support transformers `PreTrainedModel` and also
  `PeftModel` from peft. The original paper used values in the range [5.0, 15.0].
- **optim_target_modules** (`Union[str, list[str]]`, *optional*) --
  The target modules to optimize, i.e. the module names that you would like to train.
  Currently used for the GaLore algorithm (https://huggingface.co/papers/2403.03507) and APOLLO algorithm (https://huggingface.co/papers/2412.05270).
  See GaLore implementation (https://github.com/jiaweizzhao/GaLore) and APOLLO implementation (https://github.com/zhuhanqing/APOLLO) for more details.
  You need to make sure to pass a valid GaLore or APOLLO optimizer, e.g., one of: "apollo_adamw", "galore_adamw", "galore_adamw_8bit", "galore_adafactor" and make sure that the target modules are `nn.Linear` modules only.

- **batch_eval_metrics** (`bool`, *optional*, defaults to `False`) --
  If set to `True`, evaluation will call compute_metrics at the end of each batch to accumulate statistics
  rather than saving all eval logits in memory. When set to `True`, you must pass a compute_metrics function
  that takes a boolean argument `compute_result`, which when passed `True`, will trigger the final global
  summary statistics from the batch-level summary statistics you've accumulated over the evaluation set.

- **eval_on_start** (`bool`, *optional*, defaults to `False`) --
  Whether to perform a evaluation step (sanity check) before the training to ensure the validation steps works correctly.

- **eval_use_gather_object** (`bool`, *optional*, defaults to `False`) --
  Whether to run recursively gather object in a nested list/tuple/dictionary of objects from all devices. This should only be enabled if users are not just returning tensors, and this is actively discouraged by PyTorch.

- **use_liger_kernel** (`bool`, *optional*, defaults to `False`) --
  Whether enable [Liger](https://github.com/linkedin/Liger-Kernel) Kernel for LLM model training.
  It can effectively increase multi-GPU training throughput by ~20% and reduces memory usage by ~60%, works out of the box with
  flash attention, PyTorch FSDP, and Microsoft DeepSpeed. Currently, it supports llama, mistral, mixtral and gemma models.

- **liger_kernel_config** (`Optional[dict]`, *optional*) --
  Configuration to be used for Liger Kernel. When use_liger_kernel=True, this dict is passed as keyword arguments to the
  `_apply_liger_kernel_to_instance` function, which specifies which kernels to apply. Available options vary by model but typically
  include: 'rope', 'swiglu', 'cross_entropy', 'fused_linear_cross_entropy', 'rms_norm', etc. If `None`, use the default kernel configurations.

- **average_tokens_across_devices** (`bool`, *optional*, defaults to `True`) --
  Whether or not to average tokens across devices. If enabled, will use all_reduce to synchronize
  num_tokens_in_batch for precise loss calculation. Reference:
  https://github.com/huggingface/transformers/issues/34242

- **use_cache** (`bool`, *optional*, defaults to `False`) --
  Whether or not to enable cache for the model. For training, this is usually not needed apart from some PEFT methods that uses `past_key_values`.</paramsdesc><paramgroups>0</paramgroups></docstring>

TrainingArguments is the subset of the arguments we use in our example scripts **which relate to the training loop
itself**.

Using [HfArgumentParser](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.HfArgumentParser) we can turn this class into
[argparse](https://docs.python.org/3/library/argparse#module-argparse) arguments that can be specified on the
command line.





<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_process_log_level</name><anchor>transformers.TrainingArguments.get_process_log_level</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2075</source><parameters>[]</parameters></docstring>

Returns the log level to be used depending on whether this process is the main process of node 0, main process
of node non-0, or a non-main process.

For the main process the log level defaults to the logging level set (`logging.WARNING` if you didn't do
anything) unless overridden by `log_level` argument.

For the replica processes the log level defaults to `logging.WARNING` unless overridden by `log_level_replica`
argument.

The choice between the main and replica process settings is made according to the return value of `should_log`.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>get_warmup_steps</name><anchor>transformers.TrainingArguments.get_warmup_steps</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2164</source><parameters>[{"name": "num_training_steps", "val": ": int"}]</parameters></docstring>

Get number of steps used for a linear warmup.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>main_process_first</name><anchor>transformers.TrainingArguments.main_process_first</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2113</source><parameters>[{"name": "local", "val": " = True"}, {"name": "desc", "val": " = 'work'"}]</parameters><paramsdesc>- **local** (`bool`, *optional*, defaults to `True`) --
  if `True` first means process of rank 0 of each node if `False` first means process of rank 0 of node
  rank 0 In multi-node environment with a shared filesystem you most likely will want to use
  `local=False` so that only the main process of the first node will do the processing. If however, the
  filesystem is not shared, then the main process of each node will need to do the processing, which is
  the default behavior.
- **desc** (`str`, *optional*, defaults to `"work"`) --
  a work description to be used in debug logs</paramsdesc><paramgroups>0</paramgroups></docstring>

A context manager for torch distributed environment where on needs to do something on the main process, while
blocking replicas, and when it's finished releasing the replicas.

One such use is for `datasets`'s `map` feature which to be efficient should be run once on the main process,
which upon completion saves a cached version of results and which then automatically gets loaded by the
replicas.




</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_dataloader</name><anchor>transformers.TrainingArguments.set_dataloader</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2697</source><parameters>[{"name": "train_batch_size", "val": ": int = 8"}, {"name": "eval_batch_size", "val": ": int = 8"}, {"name": "drop_last", "val": ": bool = False"}, {"name": "num_workers", "val": ": int = 0"}, {"name": "pin_memory", "val": ": bool = True"}, {"name": "persistent_workers", "val": ": bool = False"}, {"name": "prefetch_factor", "val": ": typing.Optional[int] = None"}, {"name": "auto_find_batch_size", "val": ": bool = False"}, {"name": "ignore_data_skip", "val": ": bool = False"}, {"name": "sampler_seed", "val": ": typing.Optional[int] = None"}]</parameters><paramsdesc>- **drop_last** (`bool`, *optional*, defaults to `False`) --
  Whether to drop the last incomplete batch (if the length of the dataset is not divisible by the batch
  size) or not.
- **num_workers** (`int`, *optional*, defaults to 0) --
  Number of subprocesses to use for data loading (PyTorch only). 0 means that the data will be loaded in
  the main process.
- **pin_memory** (`bool`, *optional*, defaults to `True`) --
  Whether you want to pin memory in data loaders or not. Will default to `True`.
- **persistent_workers** (`bool`, *optional*, defaults to `False`) --
  If True, the data loader will not shut down the worker processes after a dataset has been consumed
  once. This allows to maintain the workers Dataset instances alive. Can potentially speed up training,
  but will increase RAM usage. Will default to `False`.
- **prefetch_factor** (`int`, *optional*) --
  Number of batches loaded in advance by each worker.
  2 means there will be a total of 2 * num_workers batches prefetched across all workers.
- **auto_find_batch_size** (`bool`, *optional*, defaults to `False`) --
  Whether to find a batch size that will fit into memory automatically through exponential decay,
  avoiding CUDA Out-of-Memory errors. Requires accelerate to be installed (`pip install accelerate`)
- **ignore_data_skip** (`bool`, *optional*, defaults to `False`) --
  When resuming training, whether or not to skip the epochs and batches to get the data loading at the
  same stage as in the previous training. If set to `True`, the training will begin faster (as that
  skipping step can take a long time) but will not yield the same results as the interrupted training
  would have.
- **sampler_seed** (`int`, *optional*) --
  Random seed to be used with data samplers. If not set, random generators for data sampling will use the
  same seed as `self.seed`. This can be used to ensure reproducibility of data sampling, independent of
  the model seed.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to the dataloaders creation.



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_dataloader.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_dataloader(train_batch_size=16, eval_batch_size=64)
>>> args.per_device_train_batch_size
16
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_evaluate</name><anchor>transformers.TrainingArguments.set_evaluate</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2310</source><parameters>[{"name": "strategy", "val": ": typing.Union[str, transformers.trainer_utils.IntervalStrategy] = 'no'"}, {"name": "steps", "val": ": int = 500"}, {"name": "batch_size", "val": ": int = 8"}, {"name": "accumulation_steps", "val": ": typing.Optional[int] = None"}, {"name": "delay", "val": ": typing.Optional[float] = None"}, {"name": "loss_only", "val": ": bool = False"}]</parameters><paramsdesc>- **strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"no"`) --
  The evaluation strategy to adopt during training. Possible values are:

  - `"no"`: No evaluation is done during training.
  - `"steps"`: Evaluation is done (and logged) every `steps`.
  - `"epoch"`: Evaluation is done at the end of each epoch.

  Setting a `strategy` different from `"no"` will set `self.do_eval` to `True`.
- **steps** (`int`, *optional*, defaults to 500) --
  Number of update steps between two evaluations if `strategy="steps"`.
- **batch_size** (`int` *optional*, defaults to 8) --
  The batch size per device (GPU/TPU core/CPU...) used for evaluation.
- **accumulation_steps** (`int`, *optional*) --
  Number of predictions steps to accumulate the output tensors for, before moving the results to the CPU.
  If left unset, the whole predictions are accumulated on GPU/TPU before being moved to the CPU (faster
  but requires more memory).
- **delay** (`float`, *optional*) --
  Number of epochs or steps to wait for before the first evaluation can be performed, depending on the
  eval_strategy.
- **loss_only** (`bool`, *optional*, defaults to `False`) --
  Ignores all outputs except the loss.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to evaluation.



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_evaluate.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_evaluate(strategy="steps", steps=100)
>>> args.eval_steps
100
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_logging</name><anchor>transformers.TrainingArguments.set_logging</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2452</source><parameters>[{"name": "strategy", "val": ": typing.Union[str, transformers.trainer_utils.IntervalStrategy] = 'steps'"}, {"name": "steps", "val": ": int = 500"}, {"name": "report_to", "val": ": typing.Union[str, list[str]] = 'none'"}, {"name": "level", "val": ": str = 'passive'"}, {"name": "first_step", "val": ": bool = False"}, {"name": "nan_inf_filter", "val": ": bool = False"}, {"name": "on_each_node", "val": ": bool = False"}, {"name": "replica_level", "val": ": str = 'passive'"}]</parameters><paramsdesc>- **strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"steps"`) --
  The logging strategy to adopt during training. Possible values are:

  - `"no"`: No logging is done during training.
  - `"epoch"`: Logging is done at the end of each epoch.
  - `"steps"`: Logging is done every `logging_steps`.

- **steps** (`int`, *optional*, defaults to 500) --
  Number of update steps between two logs if `strategy="steps"`.
- **level** (`str`, *optional*, defaults to `"passive"`) --
  Logger log level to use on the main process. Possible choices are the log levels as strings: `"debug"`,
  `"info"`, `"warning"`, `"error"` and `"critical"`, plus a `"passive"` level which doesn't set anything
  and lets the application set the level.
- **report_to** (`str` or `list[str]`, *optional*, defaults to `"none"`) --
  The list of integrations to report the results and logs to. Supported platforms are `"azure_ml"`,
  `"clearml"`, `"codecarbon"`, `"comet_ml"`, `"dagshub"`, `"dvclive"`, `"flyte"`, `"mlflow"`,
  `"neptune"`, `"swanlab"`, `"tensorboard"`, `"trackio"` and `"wandb"`. Use `"all"` to report to all
  integrations installed, `"none"` for no integrations.
- **first_step** (`bool`, *optional*, defaults to `False`) --
  Whether to log and evaluate the first `global_step` or not.
- **nan_inf_filter** (`bool`, *optional*, defaults to `True`) --
  Whether to filter `nan` and `inf` losses for logging. If set to `True` the loss of every step that is
  `nan` or `inf` is filtered and the average loss of the current logging window is taken instead.

  <Tip>

  `nan_inf_filter` only influences the logging of loss values, it does not change the behavior the
  gradient is computed or applied to the model.

  </Tip>

- **on_each_node** (`bool`, *optional*, defaults to `True`) --
  In multinode distributed training, whether to log using `log_level` once per node, or only on the main
  node.
- **replica_level** (`str`, *optional*, defaults to `"passive"`) --
  Logger log level to use on replicas. Same choices as `log_level`</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to logging.



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_logging.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_logging(strategy="steps", steps=100)
>>> args.logging_steps
100
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_lr_scheduler</name><anchor>transformers.TrainingArguments.set_lr_scheduler</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2652</source><parameters>[{"name": "name", "val": ": typing.Union[str, transformers.trainer_utils.SchedulerType] = 'linear'"}, {"name": "num_epochs", "val": ": float = 3.0"}, {"name": "max_steps", "val": ": int = -1"}, {"name": "warmup_ratio", "val": ": float = 0"}, {"name": "warmup_steps", "val": ": int = 0"}]</parameters><paramsdesc>- **name** (`str` or [SchedulerType](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.SchedulerType), *optional*, defaults to `"linear"`) --
  The scheduler type to use. See the documentation of [SchedulerType](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.SchedulerType) for all possible values.
- **num_epochs(`float`,** *optional*, defaults to 3.0) --
  Total number of training epochs to perform (if not an integer, will perform the decimal part percents
  of the last epoch before stopping training).
- **max_steps** (`int`, *optional*, defaults to -1) --
  If set to a positive number, the total number of training steps to perform. Overrides `num_train_epochs`.
  For a finite dataset, training is reiterated through the dataset (if all data is exhausted) until
  `max_steps` is reached.
- **warmup_ratio** (`float`, *optional*, defaults to 0.0) --
  Ratio of total training steps used for a linear warmup from 0 to `learning_rate`.
- **warmup_steps** (`int`, *optional*, defaults to 0) --
  Number of steps used for a linear warmup from 0 to `learning_rate`. Overrides any effect of
  `warmup_ratio`.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to the learning rate scheduler and its hyperparameters.



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_lr_scheduler.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_lr_scheduler(name="cosine", warmup_ratio=0.05)
>>> args.warmup_ratio
0.05
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_optimizer</name><anchor>transformers.TrainingArguments.set_optimizer</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2601</source><parameters>[{"name": "name", "val": ": typing.Union[str, transformers.training_args.OptimizerNames] = 'adamw_torch'"}, {"name": "learning_rate", "val": ": float = 5e-05"}, {"name": "weight_decay", "val": ": float = 0"}, {"name": "beta1", "val": ": float = 0.9"}, {"name": "beta2", "val": ": float = 0.999"}, {"name": "epsilon", "val": ": float = 1e-08"}, {"name": "args", "val": ": typing.Optional[str] = None"}]</parameters><paramsdesc>- **name** (`str` or `training_args.OptimizerNames`, *optional*, defaults to `"adamw_torch"`) --
  The optimizer to use: `"adamw_torch"`, `"adamw_torch_fused"`, `"adamw_apex_fused"`,
  `"adamw_anyprecision"` or `"adafactor"`.
- **learning_rate** (`float`, *optional*, defaults to 5e-5) --
  The initial learning rate.
- **weight_decay** (`float`, *optional*, defaults to 0) --
  The weight decay to apply (if not zero) to all layers except all bias and LayerNorm weights.
- **beta1** (`float`, *optional*, defaults to 0.9) --
  The beta1 hyperparameter for the adam optimizer or its variants.
- **beta2** (`float`, *optional*, defaults to 0.999) --
  The beta2 hyperparameter for the adam optimizer or its variants.
- **epsilon** (`float`, *optional*, defaults to 1e-8) --
  The epsilon hyperparameter for the adam optimizer or its variants.
- **args** (`str`, *optional*) --
  Optional arguments that are supplied to AnyPrecisionAdamW (only useful when
  `optim="adamw_anyprecision"`).</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to the optimizer and its hyperparameters.



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_optimizer.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_optimizer(name="adamw_torch", beta1=0.8)
>>> args.optim
'adamw_torch'
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_push_to_hub</name><anchor>transformers.TrainingArguments.set_push_to_hub</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2527</source><parameters>[{"name": "model_id", "val": ": str"}, {"name": "strategy", "val": ": typing.Union[str, transformers.trainer_utils.HubStrategy] = 'every_save'"}, {"name": "token", "val": ": typing.Optional[str] = None"}, {"name": "private_repo", "val": ": typing.Optional[bool] = None"}, {"name": "always_push", "val": ": bool = False"}, {"name": "revision", "val": ": typing.Optional[str] = None"}]</parameters><paramsdesc>- **model_id** (`str`) --
  The name of the repository to keep in sync with the local *output_dir*. It can be a simple model ID in
  which case the model will be pushed in your namespace. Otherwise it should be the whole repository
  name, for instance `"user_name/model"`, which allows you to push to an organization you are a member of
  with `"organization_name/model"`.
- **strategy** (`str` or `HubStrategy`, *optional*, defaults to `"every_save"`) --
  Defines the scope of what is pushed to the Hub and when. Possible values are:

  - `"end"`: push the model, its configuration, the processing_class e.g. tokenizer (if passed along to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)) and a
  draft of a model card when the [save_model()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.save_model) method is called.
  - `"every_save"`: push the model, its configuration, the processing_class e.g. tokenizer (if passed along to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer))
    and
  a draft of a model card each time there is a model save. The pushes are asynchronous to not block
  training, and in case the save are very frequent, a new push is only attempted if the previous one is
  finished. A last push is made with the final model at the end of training.
  - `"checkpoint"`: like `"every_save"` but the latest checkpoint is also pushed in a subfolder named
  last-checkpoint, allowing you to resume training easily with
  `trainer.train(resume_from_checkpoint="last-checkpoint")`.
  - `"all_checkpoints"`: like `"checkpoint"` but all checkpoints are pushed like they appear in the
    output
  folder (so you will get one checkpoint folder per folder in your final repository)

- **token** (`str`, *optional*) --
  The token to use to push the model to the Hub. Will default to the token in the cache folder obtained
  with `hf auth login`.
- **private_repo** (`bool`, *optional*, defaults to `False`) --
  Whether to make the repo private. If `None` (default), the repo will be public unless the organization's default is private. This value is ignored if the repo already exists.
- **always_push** (`bool`, *optional*, defaults to `False`) --
  Unless this is `True`, the `Trainer` will skip pushing a checkpoint when the previous push is not
  finished.
- **revision** (`str`, *optional*) --
  The revision to use when pushing to the Hub. Can be a branch name, a tag, or a commit hash.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to synchronizing checkpoints with the Hub.

<Tip>

Calling this method will set `self.push_to_hub` to `True`, which means the `output_dir` will begin a git
directory synced with the repo (determined by `model_id`) and the content will be pushed each time a save is
triggered (depending on your `self.save_strategy`). Calling [save_model()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.save_model) will also trigger a push.

</Tip>



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_push_to_hub.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_push_to_hub("me/awesome-model")
>>> args.hub_model_id
'me/awesome-model'
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_save</name><anchor>transformers.TrainingArguments.set_save</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2403</source><parameters>[{"name": "strategy", "val": ": typing.Union[str, transformers.trainer_utils.IntervalStrategy] = 'steps'"}, {"name": "steps", "val": ": int = 500"}, {"name": "total_limit", "val": ": typing.Optional[int] = None"}, {"name": "on_each_node", "val": ": bool = False"}]</parameters><paramsdesc>- **strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"steps"`) --
  The checkpoint save strategy to adopt during training. Possible values are:

  - `"no"`: No save is done during training.
  - `"epoch"`: Save is done at the end of each epoch.
  - `"steps"`: Save is done every `save_steps`.

- **steps** (`int`, *optional*, defaults to 500) --
  Number of updates steps before two checkpoint saves if `strategy="steps"`.
- **total_limit** (`int`, *optional*) --
  If a value is passed, will limit the total amount of checkpoints. Deletes the older checkpoints in
  `output_dir`.
- **on_each_node** (`bool`, *optional*, defaults to `False`) --
  When doing multi-node distributed training, whether to save models and checkpoints on each node, or
  only on the main one.

  This should not be activated when the different nodes use the same storage as the files will be saved
  with the same names for each node.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all arguments linked to checkpoint saving.



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_save.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_save(strategy="steps", steps=100)
>>> args.save_steps
100
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_testing</name><anchor>transformers.TrainingArguments.set_testing</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2367</source><parameters>[{"name": "batch_size", "val": ": int = 8"}, {"name": "loss_only", "val": ": bool = False"}]</parameters><paramsdesc>- **batch_size** (`int` *optional*, defaults to 8) --
  The batch size per device (GPU/TPU core/CPU...) used for testing.
- **loss_only** (`bool`, *optional*, defaults to `False`) --
  Ignores all outputs except the loss.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all basic arguments linked to testing on a held-out dataset.

<Tip>

Calling this method will automatically set `self.do_predict` to `True`.

</Tip>



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_testing.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_testing(batch_size=32)
>>> args.per_device_eval_batch_size
32
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>set_training</name><anchor>transformers.TrainingArguments.set_training</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2235</source><parameters>[{"name": "learning_rate", "val": ": float = 5e-05"}, {"name": "batch_size", "val": ": int = 8"}, {"name": "weight_decay", "val": ": float = 0"}, {"name": "num_epochs", "val": ": float = 3"}, {"name": "max_steps", "val": ": int = -1"}, {"name": "gradient_accumulation_steps", "val": ": int = 1"}, {"name": "seed", "val": ": int = 42"}, {"name": "gradient_checkpointing", "val": ": bool = False"}]</parameters><paramsdesc>- **learning_rate** (`float`, *optional*, defaults to 5e-5) --
  The initial learning rate for the optimizer.
- **batch_size** (`int` *optional*, defaults to 8) --
  The batch size per device (GPU/TPU core/CPU...) used for training.
- **weight_decay** (`float`, *optional*, defaults to 0) --
  The weight decay to apply (if not zero) to all layers except all bias and LayerNorm weights in the
  optimizer.
- **num_train_epochs(`float`,** *optional*, defaults to 3.0) --
  Total number of training epochs to perform (if not an integer, will perform the decimal part percents
  of the last epoch before stopping training).
- **max_steps** (`int`, *optional*, defaults to -1) --
  If set to a positive number, the total number of training steps to perform. Overrides `num_train_epochs`.
  For a finite dataset, training is reiterated through the dataset (if all data is exhausted) until
  `max_steps` is reached.
- **gradient_accumulation_steps** (`int`, *optional*, defaults to 1) --
  Number of updates steps to accumulate the gradients for, before performing a backward/update pass.

  <Tip warning={true}>

  When using gradient accumulation, one step is counted as one step with backward pass. Therefore,
  logging, evaluation, save will be conducted every `gradient_accumulation_steps * xxx_step` training
  examples.

  </Tip>

- **seed** (`int`, *optional*, defaults to 42) --
  Random seed that will be set at the beginning of training. To ensure reproducibility across runs, use
  the `~Trainer.model_init` function to instantiate the model if it has some randomly initialized
  parameters.
- **gradient_checkpointing** (`bool`, *optional*, defaults to `False`) --
  If True, use gradient checkpointing to save memory at the expense of slower backward pass.</paramsdesc><paramgroups>0</paramgroups></docstring>

A method that regroups all basic arguments linked to the training.

<Tip>

Calling this method will automatically set `self.do_train` to `True`.

</Tip>



<ExampleCodeBlock anchor="transformers.TrainingArguments.set_training.example">

Example:

```py
>>> from transformers import TrainingArguments

>>> args = TrainingArguments("working_dir")
>>> args = args.set_training(learning_rate=1e-4, batch_size=32)
>>> args.learning_rate
1e-4
```

</ExampleCodeBlock>


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>to_dict</name><anchor>transformers.TrainingArguments.to_dict</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2185</source><parameters>[]</parameters></docstring>

Serializes this instance while replace `Enum` by their values (for JSON serialization support). It obfuscates
the token values by removing their value.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>to_json_string</name><anchor>transformers.TrainingArguments.to_json_string</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2215</source><parameters>[]</parameters></docstring>

Serializes this instance to a JSON string.


</div>
<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>to_sanitized_dict</name><anchor>transformers.TrainingArguments.to_sanitized_dict</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args.py#L2221</source><parameters>[]</parameters></docstring>

Sanitized serialization to use with TensorBoard's hparams


</div></div>

## Seq2SeqTrainingArguments[[transformers.Seq2SeqTrainingArguments]]

<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>class transformers.Seq2SeqTrainingArguments</name><anchor>transformers.Seq2SeqTrainingArguments</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args_seq2seq.py#L30</source><parameters>[{"name": "output_dir", "val": ": typing.Optional[str] = None"}, {"name": "do_train", "val": ": bool = False"}, {"name": "do_eval", "val": ": bool = False"}, {"name": "do_predict", "val": ": bool = False"}, {"name": "eval_strategy", "val": ": typing.Union[transformers.trainer_utils.IntervalStrategy, str] = 'no'"}, {"name": "prediction_loss_only", "val": ": bool = False"}, {"name": "per_device_train_batch_size", "val": ": int = 8"}, {"name": "per_device_eval_batch_size", "val": ": int = 8"}, {"name": "gradient_accumulation_steps", "val": ": int = 1"}, {"name": "eval_accumulation_steps", "val": ": typing.Optional[int] = None"}, {"name": "eval_delay", "val": ": float = 0"}, {"name": "torch_empty_cache_steps", "val": ": typing.Optional[int] = None"}, {"name": "learning_rate", "val": ": float = 5e-05"}, {"name": "weight_decay", "val": ": float = 0.0"}, {"name": "adam_beta1", "val": ": float = 0.9"}, {"name": "adam_beta2", "val": ": float = 0.999"}, {"name": "adam_epsilon", "val": ": float = 1e-08"}, {"name": "max_grad_norm", "val": ": float = 1.0"}, {"name": "num_train_epochs", "val": ": float = 3.0"}, {"name": "max_steps", "val": ": int = -1"}, {"name": "lr_scheduler_type", "val": ": typing.Union[transformers.trainer_utils.SchedulerType, str] = 'linear'"}, {"name": "lr_scheduler_kwargs", "val": ": typing.Union[dict, str, NoneType] = None"}, {"name": "warmup_ratio", "val": ": float = 0.0"}, {"name": "warmup_steps", "val": ": int = 0"}, {"name": "log_level", "val": ": str = 'passive'"}, {"name": "log_level_replica", "val": ": str = 'warning'"}, {"name": "log_on_each_node", "val": ": bool = True"}, {"name": "logging_strategy", "val": ": typing.Union[transformers.trainer_utils.IntervalStrategy, str] = 'steps'"}, {"name": "logging_first_step", "val": ": bool = False"}, {"name": "logging_steps", "val": ": float = 500"}, {"name": "logging_nan_inf_filter", "val": ": bool = True"}, {"name": "save_strategy", "val": ": typing.Union[transformers.trainer_utils.SaveStrategy, str] = 'steps'"}, {"name": "save_steps", "val": ": float = 500"}, {"name": "save_total_limit", "val": ": typing.Optional[int] = None"}, {"name": "save_safetensors", "val": ": bool = True"}, {"name": "save_on_each_node", "val": ": bool = False"}, {"name": "save_only_model", "val": ": bool = False"}, {"name": "restore_callback_states_from_checkpoint", "val": ": bool = False"}, {"name": "use_cpu", "val": ": bool = False"}, {"name": "seed", "val": ": int = 42"}, {"name": "data_seed", "val": ": typing.Optional[int] = None"}, {"name": "bf16", "val": ": bool = False"}, {"name": "fp16", "val": ": bool = False"}, {"name": "bf16_full_eval", "val": ": bool = False"}, {"name": "fp16_full_eval", "val": ": bool = False"}, {"name": "tf32", "val": ": typing.Optional[bool] = None"}, {"name": "local_rank", "val": ": int = -1"}, {"name": "ddp_backend", "val": ": typing.Optional[str] = None"}, {"name": "debug", "val": ": typing.Union[str, list[transformers.debug_utils.DebugOption]] = ''"}, {"name": "dataloader_drop_last", "val": ": bool = False"}, {"name": "eval_steps", "val": ": typing.Optional[float] = None"}, {"name": "dataloader_num_workers", "val": ": int = 0"}, {"name": "dataloader_prefetch_factor", "val": ": typing.Optional[int] = None"}, {"name": "run_name", "val": ": typing.Optional[str] = None"}, {"name": "disable_tqdm", "val": ": typing.Optional[bool] = None"}, {"name": "remove_unused_columns", "val": ": bool = True"}, {"name": "label_names", "val": ": typing.Optional[list[str]] = None"}, {"name": "load_best_model_at_end", "val": ": bool = False"}, {"name": "metric_for_best_model", "val": ": typing.Optional[str] = None"}, {"name": "greater_is_better", "val": ": typing.Optional[bool] = None"}, {"name": "ignore_data_skip", "val": ": bool = False"}, {"name": "fsdp", "val": ": typing.Union[list[transformers.trainer_utils.FSDPOption], str, NoneType] = None"}, {"name": "fsdp_config", "val": ": typing.Union[dict[str, typing.Any], str, NoneType] = None"}, {"name": "accelerator_config", "val": ": typing.Union[dict, str, NoneType] = None"}, {"name": "parallelism_config", "val": ": typing.Optional[accelerate.parallelism_config.ParallelismConfig] = None"}, {"name": "deepspeed", "val": ": typing.Union[dict, str, NoneType] = None"}, {"name": "label_smoothing_factor", "val": ": float = 0.0"}, {"name": "optim", "val": ": typing.Union[transformers.training_args.OptimizerNames, str] = 'adamw_torch_fused'"}, {"name": "optim_args", "val": ": typing.Optional[str] = None"}, {"name": "group_by_length", "val": ": bool = False"}, {"name": "length_column_name", "val": ": str = 'length'"}, {"name": "report_to", "val": ": typing.Union[NoneType, str, list[str]] = 'none'"}, {"name": "project", "val": ": str = 'huggingface'"}, {"name": "trackio_space_id", "val": ": typing.Optional[str] = 'trackio'"}, {"name": "ddp_find_unused_parameters", "val": ": typing.Optional[bool] = None"}, {"name": "ddp_bucket_cap_mb", "val": ": typing.Optional[int] = None"}, {"name": "ddp_broadcast_buffers", "val": ": typing.Optional[bool] = None"}, {"name": "dataloader_pin_memory", "val": ": bool = True"}, {"name": "dataloader_persistent_workers", "val": ": bool = False"}, {"name": "skip_memory_metrics", "val": ": bool = True"}, {"name": "push_to_hub", "val": ": bool = False"}, {"name": "resume_from_checkpoint", "val": ": typing.Optional[str] = None"}, {"name": "hub_model_id", "val": ": typing.Optional[str] = None"}, {"name": "hub_strategy", "val": ": typing.Union[transformers.trainer_utils.HubStrategy, str] = 'every_save'"}, {"name": "hub_token", "val": ": typing.Optional[str] = None"}, {"name": "hub_private_repo", "val": ": typing.Optional[bool] = None"}, {"name": "hub_always_push", "val": ": bool = False"}, {"name": "hub_revision", "val": ": typing.Optional[str] = None"}, {"name": "gradient_checkpointing", "val": ": bool = False"}, {"name": "gradient_checkpointing_kwargs", "val": ": typing.Union[dict[str, typing.Any], str, NoneType] = None"}, {"name": "include_for_metrics", "val": ": list = <factory>"}, {"name": "eval_do_concat_batches", "val": ": bool = True"}, {"name": "auto_find_batch_size", "val": ": bool = False"}, {"name": "full_determinism", "val": ": bool = False"}, {"name": "ddp_timeout", "val": ": int = 1800"}, {"name": "torch_compile", "val": ": bool = False"}, {"name": "torch_compile_backend", "val": ": typing.Optional[str] = None"}, {"name": "torch_compile_mode", "val": ": typing.Optional[str] = None"}, {"name": "include_num_input_tokens_seen", "val": ": typing.Union[str, bool] = 'no'"}, {"name": "neftune_noise_alpha", "val": ": typing.Optional[float] = None"}, {"name": "optim_target_modules", "val": ": typing.Union[NoneType, str, list[str]] = None"}, {"name": "batch_eval_metrics", "val": ": bool = False"}, {"name": "eval_on_start", "val": ": bool = False"}, {"name": "use_liger_kernel", "val": ": bool = False"}, {"name": "liger_kernel_config", "val": ": typing.Optional[dict[str, bool]] = None"}, {"name": "eval_use_gather_object", "val": ": bool = False"}, {"name": "average_tokens_across_devices", "val": ": bool = True"}, {"name": "use_cache", "val": ": bool = False"}, {"name": "sortish_sampler", "val": ": bool = False"}, {"name": "predict_with_generate", "val": ": bool = False"}, {"name": "generation_max_length", "val": ": typing.Optional[int] = None"}, {"name": "generation_num_beams", "val": ": typing.Optional[int] = None"}, {"name": "generation_config", "val": ": typing.Union[str, pathlib.Path, transformers.generation.configuration_utils.GenerationConfig, NoneType] = None"}]</parameters><paramsdesc>- **output_dir** (`str`, *optional*, defaults to `"trainer_output"`) --
The output directory where the model predictions and checkpoints will be written.
- **do_train** (`bool`, *optional*, defaults to `False`) --
  Whether to run training or not. This argument is not directly used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's intended to be used
  by your training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **do_eval** (`bool`, *optional*) --
  Whether to run evaluation on the validation set or not. Will be set to `True` if `eval_strategy` is
  different from `"no"`. This argument is not directly used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's intended to be used by your
  training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **do_predict** (`bool`, *optional*, defaults to `False`) --
  Whether to run predictions on the test set or not. This argument is not directly used by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's
  intended to be used by your training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **eval_strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"no"`) --
  The evaluation strategy to adopt during training. Possible values are:

  - `"no"`: No evaluation is done during training.
  - `"steps"`: Evaluation is done (and logged) every `eval_steps`.
  - `"epoch"`: Evaluation is done at the end of each epoch.

- **prediction_loss_only** (`bool`, *optional*, defaults to `False`) --
  When performing evaluation and generating predictions, only returns the loss.
- **per_device_train_batch_size** (`int`, *optional*, defaults to 8) --
  The batch size *per device*. The **global batch size** is computed as:
  `per_device_train_batch_size * number_of_devices` in multi-GPU or distributed setups.
- **per_device_eval_batch_size** (`int`, *optional*, defaults to 8) --
  The batch size per device accelerator core/CPU for evaluation.
- **gradient_accumulation_steps** (`int`, *optional*, defaults to 1) --
  Number of updates steps to accumulate the gradients for, before performing a backward/update pass.

  <Tip warning={true}>

  When using gradient accumulation, one step is counted as one step with backward pass. Therefore, logging,
  evaluation, save will be conducted every `gradient_accumulation_steps * xxx_step` training examples.

  </Tip>

- **eval_accumulation_steps** (`int`, *optional*) --
  Number of predictions steps to accumulate the output tensors for, before moving the results to the CPU. If
  left unset, the whole predictions are accumulated on the device accelerator before being moved to the CPU (faster but
  requires more memory).
- **eval_delay** (`float`, *optional*) --
  Number of epochs or steps to wait for before the first evaluation can be performed, depending on the
  eval_strategy.
- **torch_empty_cache_steps** (`int`, *optional*) --
  Number of steps to wait before calling `torch.<device>.empty_cache()`. If left unset or set to None, cache will not be emptied.

  <Tip>

  This can help avoid CUDA out-of-memory errors by lowering peak VRAM usage at a cost of about [10% slower performance](https://github.com/huggingface/transformers/issues/31372).

  </Tip>

- **learning_rate** (`float`, *optional*, defaults to 5e-5) --
  The initial learning rate for `AdamW` optimizer.
- **weight_decay** (`float`, *optional*, defaults to 0) --
  The weight decay to apply (if not zero) to all layers except all bias and LayerNorm weights in `AdamW`
  optimizer.
- **adam_beta1** (`float`, *optional*, defaults to 0.9) --
  The beta1 hyperparameter for the `AdamW` optimizer.
- **adam_beta2** (`float`, *optional*, defaults to 0.999) --
  The beta2 hyperparameter for the `AdamW` optimizer.
- **adam_epsilon** (`float`, *optional*, defaults to 1e-8) --
  The epsilon hyperparameter for the `AdamW` optimizer.
- **max_grad_norm** (`float`, *optional*, defaults to 1.0) --
  Maximum gradient norm (for gradient clipping).
- **num_train_epochs(`float`,** *optional*, defaults to 3.0) --
  Total number of training epochs to perform (if not an integer, will perform the decimal part percents of
  the last epoch before stopping training).
- **max_steps** (`int`, *optional*, defaults to -1) --
  If set to a positive number, the total number of training steps to perform. Overrides `num_train_epochs`.
  For a finite dataset, training is reiterated through the dataset (if all data is exhausted) until
  `max_steps` is reached.
- **lr_scheduler_type** (`str` or [SchedulerType](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.SchedulerType), *optional*, defaults to `"linear"`) --
  The scheduler type to use. See the documentation of [SchedulerType](/docs/transformers/pr_33892/en/main_classes/optimizer_schedules#transformers.SchedulerType) for all possible values.
- **lr_scheduler_kwargs** (`dict` or `str`, *optional*, defaults to `None`) --
  The extra arguments for the lr_scheduler. See the documentation of each scheduler for possible values.
- **warmup_ratio** (`float`, *optional*, defaults to 0.0) --
  Ratio of total training steps used for a linear warmup from 0 to `learning_rate`.
- **warmup_steps** (`int`, *optional*, defaults to 0) --
  Number of steps used for a linear warmup from 0 to `learning_rate`. Overrides any effect of `warmup_ratio`.
- **log_level** (`str`, *optional*, defaults to `passive`) --
  Logger log level to use on the main process. Possible choices are the log levels as strings: 'debug',
  'info', 'warning', 'error' and 'critical', plus a 'passive' level which doesn't set anything and keeps the
  current log level for the Transformers library (which will be `"warning"` by default).
- **log_level_replica** (`str`, *optional*, defaults to `"warning"`) --
  Logger log level to use on replicas. Same choices as `log_level`"
- **log_on_each_node** (`bool`, *optional*, defaults to `True`) --
  In multinode distributed training, whether to log using `log_level` once per node, or only on the main
  node.
- **logging_strategy** (`str` or [IntervalStrategy](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.IntervalStrategy), *optional*, defaults to `"steps"`) --
  The logging strategy to adopt during training. Possible values are:

  - `"no"`: No logging is done during training.
  - `"epoch"`: Logging is done at the end of each epoch.
  - `"steps"`: Logging is done every `logging_steps`.

- **logging_first_step** (`bool`, *optional*, defaults to `False`) --
  Whether to log the first `global_step` or not.
- **logging_steps** (`int` or `float`, *optional*, defaults to 500) --
  Number of update steps between two logs if `logging_strategy="steps"`. Should be an integer or a float in
  range `[0,1)`. If smaller than 1, will be interpreted as ratio of total training steps.
- **logging_nan_inf_filter** (`bool`, *optional*, defaults to `True`) --
  Whether to filter `nan` and `inf` losses for logging. If set to `True` the loss of every step that is `nan`
  or `inf` is filtered and the average loss of the current logging window is taken instead.

  <Tip>

  `logging_nan_inf_filter` only influences the logging of loss values, it does not change the behavior the
  gradient is computed or applied to the model.

  </Tip>

- **save_strategy** (`str` or `SaveStrategy`, *optional*, defaults to `"steps"`) --
  The checkpoint save strategy to adopt during training. Possible values are:

  - `"no"`: No save is done during training.
  - `"epoch"`: Save is done at the end of each epoch.
  - `"steps"`: Save is done every `save_steps`.
  - `"best"`: Save is done whenever a new `best_metric` is achieved.

  If `"epoch"` or `"steps"` is chosen, saving will also be performed at the
  very end of training, always.
- **save_steps** (`int` or `float`, *optional*, defaults to 500) --
  Number of updates steps before two checkpoint saves if `save_strategy="steps"`. Should be an integer or a
  float in range `[0,1)`. If smaller than 1, will be interpreted as ratio of total training steps.
- **save_total_limit** (`int`, *optional*) --
  If a value is passed, will limit the total amount of checkpoints. Deletes the older checkpoints in
  `output_dir`. When `load_best_model_at_end` is enabled, the "best" checkpoint according to
  `metric_for_best_model` will always be retained in addition to the most recent ones. For example, for
  `save_total_limit=5` and `load_best_model_at_end`, the four last checkpoints will always be retained
  alongside the best model. When `save_total_limit=1` and `load_best_model_at_end`, it is possible that two
  checkpoints are saved: the last one and the best one (if they are different).
- **save_safetensors** (`bool`, *optional*, defaults to `True`) --
  Use [safetensors](https://huggingface.co/docs/safetensors) saving and loading for state dicts instead of
  default `torch.load` and `torch.save`.
- **save_on_each_node** (`bool`, *optional*, defaults to `False`) --
  When doing multi-node distributed training, whether to save models and checkpoints on each node, or only on
  the main one.

  This should not be activated when the different nodes use the same storage as the files will be saved with
  the same names for each node.
- **save_only_model** (`bool`, *optional*, defaults to `False`) --
  When checkpointing, whether to only save the model, or also the optimizer, scheduler & rng state.
  Note that when this is true, you won't be able to resume training from checkpoint.
  This enables you to save storage by not storing the optimizer, scheduler & rng state.
  You can only load the model using `from_pretrained` with this option set to `True`.
- **restore_callback_states_from_checkpoint** (`bool`, *optional*, defaults to `False`) --
  Whether to restore the callback states from the checkpoint. If `True`, will override
  callbacks passed to the `Trainer` if they exist in the checkpoint."
- **use_cpu** (`bool`, *optional*, defaults to `False`) --
  Whether or not to use cpu. If set to False, we will use the available torch device/backend.
- **seed** (`int`, *optional*, defaults to 42) --
  Random seed that will be set at the beginning of training. To ensure reproducibility across runs, use the
  `~Trainer.model_init` function to instantiate the model if it has some randomly initialized parameters.
- **data_seed** (`int`, *optional*) --
  Random seed to be used with data samplers. If not set, random generators for data sampling will use the
  same seed as `seed`. This can be used to ensure reproducibility of data sampling, independent of the model
  seed.
- **bf16** (`bool`, *optional*, defaults to `False`) --
  Whether to use bf16 16-bit (mixed) precision training instead of 32-bit training. Requires Ampere or higher
  NVIDIA architecture or Intel XPU or using CPU (use_cpu) or Ascend NPU.
- **fp16** (`bool`, *optional*, defaults to `False`) --
  Whether to use fp16 16-bit (mixed) precision training instead of 32-bit training.
- **bf16_full_eval** (`bool`, *optional*, defaults to `False`) --
  Whether to use full bfloat16 evaluation instead of 32-bit. This will be faster and save memory but can harm
  metric values.
- **fp16_full_eval** (`bool`, *optional*, defaults to `False`) --
  Whether to use full float16 evaluation instead of 32-bit. This will be faster and save memory but can harm
  metric values.
- **tf32** (`bool`, *optional*) --
  Whether to enable the TF32 mode, available in Ampere and newer GPU architectures. The default value depends
  on PyTorch's version default of `torch.backends.cuda.matmul.allow_tf32`. For more details please refer to
  the [TF32](https://huggingface.co/docs/transformers/perf_train_gpu_one#tf32) documentation. This is an
  experimental API and it may change.
- **ddp_backend** (`str`, *optional*) --
  The backend to use for distributed training. Must be one of `"nccl"`, `"mpi"`, `"ccl"`, `"gloo"`, `"hccl"`.
- **dataloader_drop_last** (`bool`, *optional*, defaults to `False`) --
  Whether to drop the last incomplete batch (if the length of the dataset is not divisible by the batch size)
  or not.
- **eval_steps** (`int` or `float`, *optional*) --
  Number of update steps between two evaluations if `eval_strategy="steps"`. Will default to the same
  value as `logging_steps` if not set. Should be an integer or a float in range `[0,1)`. If smaller than 1,
  will be interpreted as ratio of total training steps.
- **dataloader_num_workers** (`int`, *optional*, defaults to 0) --
  Number of subprocesses to use for data loading (PyTorch only). 0 means that the data will be loaded in the
  main process.
- **run_name** (`str`, *optional*) --
  A descriptor for the run. Typically used for [trackio](https://github.com/gradio-app/trackio),
  [wandb](https://www.wandb.com/), [mlflow](https://www.mlflow.org/), [comet](https://www.comet.com/site) and
  [swanlab](https://swanlab.cn) logging.
- **disable_tqdm** (`bool`, *optional*) --
  Whether or not to disable the tqdm progress bars and table of metrics produced by
  `~notebook.NotebookTrainingTracker` in Jupyter Notebooks. Will default to `True` if the logging level is
  set to warn or lower (default), `False` otherwise.
- **remove_unused_columns** (`bool`, *optional*, defaults to `True`) --
  Whether or not to automatically remove the columns unused by the model forward method.
- **label_names** (`list[str]`, *optional*) --
  The list of keys in your dictionary of inputs that correspond to the labels.

  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.

  You should only specify `label_names` if you're using custom label names or if your model's `forward` consumes multiple label tensors (e.g., extractive QA).
- **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. When this option is
  enabled, the best checkpoint will always be saved. See
  [`save_total_limit`](https://huggingface.co/docs/transformers/main_classes/trainer#transformers.TrainingArguments.save_total_limit)
  for more.

  <Tip>

  When set to `True`, the parameters `save_strategy` needs to be the same as `eval_strategy`, and in
  the case it is "steps", `save_steps` must be a round multiple of `eval_steps`.

  </Tip>

- **metric_for_best_model** (`str`, *optional*) --
  Use in conjunction with `load_best_model_at_end` to specify the metric to use to compare two different
  models. Must be the name of a metric returned by the evaluation with or without the prefix `"eval_"`.

  If not specified, this will default to `"loss"` when either `load_best_model_at_end == True`
  or `lr_scheduler_type == SchedulerType.REDUCE_ON_PLATEAU` (to use the evaluation loss).

  If you set this value, `greater_is_better` will default to `True` unless the name ends with "loss".
  Don't forget to set it to `False` if your metric is better when lower.
- **greater_is_better** (`bool`, *optional*) --
  Use in conjunction with `load_best_model_at_end` and `metric_for_best_model` to specify if better models
  should have a greater metric or not. Will default to:

  - `True` if `metric_for_best_model` is set to a value that doesn't end in `"loss"`.
  - `False` if `metric_for_best_model` is not set, or set to a value that ends in `"loss"`.
- **ignore_data_skip** (`bool`, *optional*, defaults to `False`) --
  When resuming training, whether or not to skip the epochs and batches to get the data loading at the same
  stage as in the previous training. If set to `True`, the training will begin faster (as that skipping step
  can take a long time) but will not yield the same results as the interrupted training would have.
- **fsdp** (`bool`, `str` or list of `FSDPOption`, *optional*, defaults to `None`) --
  Use PyTorch Distributed Parallel Training (in distributed training only).

  A list of options along the following:

  - `"full_shard"`: Shard parameters, gradients and optimizer states.
  - `"shard_grad_op"`: Shard optimizer states and gradients.
  - `"hybrid_shard"`: Apply `FULL_SHARD` within a node, and replicate parameters across nodes.
  - `"hybrid_shard_zero2"`: Apply `SHARD_GRAD_OP` within a node, and replicate parameters across nodes.
  - `"offload"`: Offload parameters and gradients to CPUs (only compatible with `"full_shard"` and
    `"shard_grad_op"`).
  - `"auto_wrap"`: Automatically recursively wrap layers with FSDP using `default_auto_wrap_policy`.
- **fsdp_config** (`str` or `dict`, *optional*) --
  Config to be used with fsdp (Pytorch Distributed Parallel Training). The value is either a location of
  fsdp json config file (e.g., `fsdp_config.json`) or an already loaded json file as `dict`.

  A List of config and its options:
  - min_num_params (`int`, *optional*, defaults to `0`):
    FSDP's minimum number of parameters for Default Auto Wrapping. (useful only when `fsdp` field is
    passed).
  - transformer_layer_cls_to_wrap (`list[str]`, *optional*):
    List of transformer layer class names (case-sensitive) to wrap, e.g, `BertLayer`, `GPTJBlock`,
    `T5Block` .... (useful only when `fsdp` flag is passed).
  - backward_prefetch (`str`, *optional*)
    FSDP's backward prefetch mode. Controls when to prefetch next set of parameters (useful only when
    `fsdp` field is passed).

    A list of options along the following:

    - `"backward_pre"` : Prefetches the next set of parameters before the current set of parameter's
      gradient computation.
    - `"backward_post"` : This prefetches the next set of parameters after the current set of
      parameter's gradient computation.
  - forward_prefetch (`bool`, *optional*, defaults to `False`)
    FSDP's forward prefetch mode (useful only when `fsdp` field is passed).
    If `"True"`, then FSDP explicitly prefetches the next upcoming all-gather while executing in the
    forward pass.
  - limit_all_gathers (`bool`, *optional*, defaults to `False`)
    FSDP's limit_all_gathers (useful only when `fsdp` field is passed).
    If `"True"`, FSDP explicitly synchronizes the CPU thread to prevent too many in-flight
    all-gathers.
  - use_orig_params (`bool`, *optional*, defaults to `True`)
    If `"True"`, allows non-uniform `requires_grad` during init, which means support for interspersed
    frozen and trainable parameters. Useful in cases such as parameter-efficient fine-tuning. Please
    refer this
    [blog](https://dev-discuss.pytorch.org/t/rethinking-pytorch-fully-sharded-data-parallel-fsdp-from-first-principles/1019
  - sync_module_states (`bool`, *optional*, defaults to `True`)
    If `"True"`, each individually wrapped FSDP unit will broadcast module parameters from rank 0 to
    ensure they are the same across all ranks after initialization
  - cpu_ram_efficient_loading (`bool`, *optional*, defaults to `False`)
    If `"True"`, only the first process loads the pretrained model checkpoint while all other processes
    have empty weights.  When this setting as `"True"`, `sync_module_states` also must to be `"True"`,
    otherwise all the processes except the main process would have random weights leading to unexpected
    behaviour during training.
  - activation_checkpointing (`bool`, *optional*, defaults to `False`):
    If `"True"`, activation checkpointing is a technique to reduce memory usage by clearing activations of
    certain layers and recomputing them during a backward pass. Effectively, this trades extra
    computation time for reduced memory usage.
  - xla (`bool`, *optional*, defaults to `False`):
    Whether to use PyTorch/XLA Fully Sharded Data Parallel Training. This is an experimental feature
    and its API may evolve in the future.
  - xla_fsdp_settings (`dict`, *optional*)
    The value is a dictionary which stores the XLA FSDP wrapping parameters.

    For a complete list of options, please see [here](
    https://github.com/pytorch/xla/blob/master/torch_xla/distributed/fsdp/xla_fully_sharded_data_parallel.py).
  - xla_fsdp_grad_ckpt (`bool`, *optional*, defaults to `False`):
    Will use gradient checkpointing over each nested XLA FSDP wrapped layer. This setting can only be
    used when the xla flag is set to true, and an auto wrapping policy is specified through
    fsdp_min_num_params or fsdp_transformer_layer_cls_to_wrap.
- **deepspeed** (`str` or `dict`, *optional*) --
  Use [Deepspeed](https://github.com/deepspeedai/DeepSpeed). This is an experimental feature and its API may
  evolve in the future. The value is either the location of DeepSpeed json config file (e.g.,
  `ds_config.json`) or an already loaded json file as a `dict`"

  <Tip warning={true}>
  If enabling any Zero-init, make sure that your model is not initialized until
  *after* initializing the `TrainingArguments`, else it will not be applied.
  </Tip>

- **accelerator_config** (`str`, `dict`, or `AcceleratorConfig`, *optional*) --
  Config to be used with the internal `Accelerator` implementation. The value is either a location of
  accelerator json config file (e.g., `accelerator_config.json`), an already loaded json file as `dict`,
  or an instance of `AcceleratorConfig`.

  A list of config and its options:
  - split_batches (`bool`, *optional*, defaults to `False`):
    Whether or not the accelerator should split the batches yielded by the dataloaders across the devices. If
    `True` the actual batch size used will be the same on any kind of distributed processes, but it must be a
    round multiple of the `num_processes` you are using. If `False`, actual batch size used will be the one set
    in your script multiplied by the number of processes.
  - dispatch_batches (`bool`, *optional*):
    If set to `True`, the dataloader prepared by the Accelerator is only iterated through on the main process
    and then the batches are split and broadcast to each process. Will default to `True` for `DataLoader` whose
    underlying dataset is an `IterableDataset`, `False` otherwise.
  - even_batches (`bool`, *optional*, defaults to `True`):
    If set to `True`, in cases where the total batch size across all processes does not exactly divide the
    dataset, samples at the start of the dataset will be duplicated so the batch can be divided equally among
    all workers.
  - use_seedable_sampler (`bool`, *optional*, defaults to `True`):
    Whether or not use a fully seedable random sampler (`accelerate.data_loader.SeedableRandomSampler`). Ensures
    training results are fully reproducible using a different sampling technique. While seed-to-seed results
    may differ, on average the differences are negligible when using multiple different seeds to compare. Should
    also be ran with `~utils.set_seed` for the best results.
  - use_configured_state (`bool`, *optional*, defaults to `False`):
    Whether or not to use a pre-configured `AcceleratorState` or `PartialState` defined before calling `TrainingArguments`.
    If `True`, an `Accelerator` or `PartialState` must be initialized. Note that by doing so, this could lead to issues
    with hyperparameter tuning.
- **parallelism_config** (`ParallelismConfig`, *optional*) --
  Parallelism configuration for the training run. Requires Accelerate `1.10.1`
- **label_smoothing_factor** (`float`, *optional*, defaults to 0.0) --
  The label smoothing factor to use. Zero means no label smoothing, otherwise the underlying onehot-encoded
  labels are changed from 0s and 1s to `label_smoothing_factor/num_labels` and `1 - label_smoothing_factor +
  label_smoothing_factor/num_labels` respectively.
- **debug** (`str` or list of `DebugOption`, *optional*, defaults to `""`) --
  Enable one or more debug features. This is an experimental feature.

  Possible options are:

  - `"underflow_overflow"`: detects overflow in model's input/outputs and reports the last frames that led to
    the event
  - `"tpu_metrics_debug"`: print debug metrics on TPU

  The options should be separated by whitespaces.
- **optim** (`str` or `training_args.OptimizerNames`, *optional*, defaults to `"adamw_torch"` (for torch>=2.8 `"adamw_torch_fused"`)) --
  The optimizer to use, such as "adamw_torch", "adamw_torch_fused", "adamw_anyprecision",
  "adafactor". See `OptimizerNames` in [training_args.py](https://github.com/huggingface/transformers/blob/main/src/transformers/training_args.py)
  for a full list of optimizers.
- **optim_args** (`str`, *optional*) --
  Optional arguments that are supplied to optimizers such as AnyPrecisionAdamW, AdEMAMix, and GaLore.
- **group_by_length** (`bool`, *optional*, defaults to `False`) --
  Whether or not to group together samples of roughly the same length in the training dataset (to minimize
  padding applied and be more efficient). Only useful if applying dynamic padding.
- **length_column_name** (`str`, *optional*, defaults to `"length"`) --
  Column name for precomputed lengths. If the column exists, grouping by length will use these values rather
  than computing them on train startup. Ignored unless `group_by_length` is `True` and the dataset is an
  instance of `Dataset`.
- **report_to** (`str` or `list[str]`, *optional*, defaults to `"none"`) --
  The list of integrations to report the results and logs to. Supported platforms are `"azure_ml"`,
  `"clearml"`, `"codecarbon"`, `"comet_ml"`, `"dagshub"`, `"dvclive"`, `"flyte"`, `"mlflow"`, `"neptune"`,
  `"swanlab"`, `"tensorboard"`, `"trackio"` and `"wandb"`. Use `"all"` to report to all integrations
  installed, `"none"` for no integrations.
- **project** (`str`, *optional*, defaults to `"huggingface"`) --
  The name of the project to use for logging. Currently, only used by Trackio.
- **trackio_space_id** (`str` or `None`, *optional*, defaults to `"trackio"`) --
  The Hugging Face Space ID to deploy to when using Trackio. Should be a complete Space name like
  `'username/reponame'` or `'orgname/reponame' `, or just `'reponame'` in which case the Space will be
  created in the currently-logged-in Hugging Face user's namespace. If `None`, will log to a local directory.
  Note that this Space will be public unless you set `hub_private_repo=True` or your organization's default
  is to create private Spaces."
- **ddp_find_unused_parameters** (`bool`, *optional*) --
  When using distributed training, the value of the flag `find_unused_parameters` passed to
  `DistributedDataParallel`. Will default to `False` if gradient checkpointing is used, `True` otherwise.
- **ddp_bucket_cap_mb** (`int`, *optional*) --
  When using distributed training, the value of the flag `bucket_cap_mb` passed to `DistributedDataParallel`.
- **ddp_broadcast_buffers** (`bool`, *optional*) --
  When using distributed training, the value of the flag `broadcast_buffers` passed to
  `DistributedDataParallel`. Will default to `False` if gradient checkpointing is used, `True` otherwise.
- **dataloader_pin_memory** (`bool`, *optional*, defaults to `True`) --
  Whether you want to pin memory in data loaders or not. Will default to `True`.
- **dataloader_persistent_workers** (`bool`, *optional*, defaults to `False`) --
  If True, the data loader will not shut down the worker processes after a dataset has been consumed once.
  This allows to maintain the workers Dataset instances alive. Can potentially speed up training, but will
  increase RAM usage. Will default to `False`.
- **dataloader_prefetch_factor** (`int`, *optional*) --
  Number of batches loaded in advance by each worker.
  2 means there will be a total of 2 * num_workers batches prefetched across all workers.
- **skip_memory_metrics** (`bool`, *optional*, defaults to `True`) --
  Whether to skip adding of memory profiler reports to metrics. This is skipped by default because it slows
  down the training and evaluation speed.
- **push_to_hub** (`bool`, *optional*, defaults to `False`) --
  Whether or not to push the model to the Hub every time the model is saved. If this is activated,
  `output_dir` will begin a git directory synced with the repo (determined by `hub_model_id`) and the content
  will be pushed each time a save is triggered (depending on your `save_strategy`). Calling
  [save_model()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.save_model) will also trigger a push.

  <Tip warning={true}>

  If `output_dir` exists, it needs to be a local clone of the repository to which the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) will be
  pushed.

  </Tip>

- **resume_from_checkpoint** (`str`, *optional*) --
  The path to a folder with a valid checkpoint for your model. This argument is not directly used by
  [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), it's intended to be used by your training/evaluation scripts instead. See the [example
  scripts](https://github.com/huggingface/transformers/tree/main/examples) for more details.
- **hub_model_id** (`str`, *optional*) --
  The name of the repository to keep in sync with the local *output_dir*. It can be a simple model ID in
  which case the model will be pushed in your namespace. Otherwise it should be the whole repository name,
  for instance `"user_name/model"`, which allows you to push to an organization you are a member of with
  `"organization_name/model"`. Will default to `user_name/output_dir_name` with *output_dir_name* being the
  name of `output_dir`.

  Will default to the name of `output_dir`.
- **hub_strategy** (`str` or `HubStrategy`, *optional*, defaults to `"every_save"`) --
  Defines the scope of what is pushed to the Hub and when. Possible values are:

  - `"end"`: push the model, its configuration, the processing class e.g. tokenizer (if passed along to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)) and a
    draft of a model card when the [save_model()](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer.save_model) method is called.
  - `"every_save"`: push the model, its configuration, the processing class e.g. tokenizer (if passed along to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer)) and
    a draft of a model card each time there is a model save. The pushes are asynchronous to not block
    training, and in case the save are very frequent, a new push is only attempted if the previous one is
    finished. A last push is made with the final model at the end of training.
  - `"checkpoint"`: like `"every_save"` but the latest checkpoint is also pushed in a subfolder named
    last-checkpoint, allowing you to resume training easily with
    `trainer.train(resume_from_checkpoint="last-checkpoint")`.
  - `"all_checkpoints"`: like `"checkpoint"` but all checkpoints are pushed like they appear in the output
    folder (so you will get one checkpoint folder per folder in your final repository)

- **hub_token** (`str`, *optional*) --
  The token to use to push the model to the Hub. Will default to the token in the cache folder obtained with
  `hf auth login`.
- **hub_private_repo** (`bool`, *optional*) --
  Whether to make the repo private. If `None` (default), the repo will be public unless the organization's
  default is private. This value is ignored if the repo already exists. If reporting to Trackio with
  deployment to Hugging Face Spaces enabled, the same logic determines whether the Space is private.
- **hub_always_push** (`bool`, *optional*, defaults to `False`) --
  Unless this is `True`, the `Trainer` will skip pushing a checkpoint when the previous push is not finished.
- **hub_revision** (`str`, *optional*) --
  The revision to use when pushing to the Hub. Can be a branch name, a tag, or a commit hash.
- **gradient_checkpointing** (`bool`, *optional*, defaults to `False`) --
  If True, use gradient checkpointing to save memory at the expense of slower backward pass.
- **gradient_checkpointing_kwargs** (`dict`, *optional*, defaults to `None`) --
  Key word arguments to be passed to the `gradient_checkpointing_enable` method.
- **include_for_metrics** (`list[str]`, *optional*, defaults to `[]`) --
  Include additional data in the `compute_metrics` function if needed for metrics computation.
  Possible options to add to `include_for_metrics` list:
  - `"inputs"`: Input data passed to the model, intended for calculating input dependent metrics.
  - `"loss"`: Loss values computed during evaluation, intended for calculating loss dependent metrics.
- **eval_do_concat_batches** (`bool`, *optional*, defaults to `True`) --
  Whether to recursively concat inputs/losses/labels/predictions across batches. If `False`,
  will instead store them as lists, with each batch kept separate.
- **auto_find_batch_size** (`bool`, *optional*, defaults to `False`) --
  Whether to find a batch size that will fit into memory automatically through exponential decay, avoiding
  CUDA Out-of-Memory errors. Requires accelerate to be installed (`pip install accelerate`)
- **full_determinism** (`bool`, *optional*, defaults to `False`) --
  If `True`, [enable_full_determinism()](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.enable_full_determinism) is called instead of [set_seed()](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.set_seed) to ensure reproducible results in
  distributed training. Important: this will negatively impact the performance, so only use it for debugging.
- **ddp_timeout** (`int`, *optional*, defaults to 1800) --
  The timeout for `torch.distributed.init_process_group` calls, used to avoid GPU socket timeouts when
  performing slow operations in distributed runnings. Please refer the [PyTorch documentation]
  (https://pytorch.org/docs/stable/distributed.html#torch.distributed.init_process_group) for more
  information.
- **torch_compile** (`bool`, *optional*, defaults to `False`) --
  Whether or not to compile the model using PyTorch 2.0
  [`torch.compile`](https://pytorch.org/get-started/pytorch-2.0/).

  This will use the best defaults for the [`torch.compile`
  API](https://pytorch.org/docs/stable/generated/torch.compile.html?highlight=torch+compile#torch.compile).
  You can customize the defaults with the argument `torch_compile_backend` and `torch_compile_mode` but we
  don't guarantee any of them will work as the support is progressively rolled in in PyTorch.

  This flag and the whole compile API is experimental and subject to change in future releases.
- **torch_compile_backend** (`str`, *optional*) --
  The backend to use in `torch.compile`. If set to any value, `torch_compile` will be set to `True`.

  Refer to the PyTorch doc for possible values and note that they may change across PyTorch versions.

  This flag is experimental and subject to change in future releases.
- **torch_compile_mode** (`str`, *optional*) --
  The mode to use in `torch.compile`. If set to any value, `torch_compile` will be set to `True`.

  Refer to the PyTorch doc for possible values and note that they may change across PyTorch versions.

  This flag is experimental and subject to change in future releases.
- **include_num_input_tokens_seen** (`Optional[Union[str, bool]]`, *optional*, defaults to "no") --
  Whether to track the number of input tokens seen. Must be one of ["all", "non_padding", "no"] or a boolean value which map to "all" or "no".
  May be slower in distributed training as gather operations must be called.

- **neftune_noise_alpha** (`Optional[float]`) --
  If not `None`, this will activate NEFTune noise embeddings. This can drastically improve model performance
  for instruction fine-tuning. Check out the [original paper](https://huggingface.co/papers/2310.05914) and the
  [original code](https://github.com/neelsjain/NEFTune). Support transformers `PreTrainedModel` and also
  `PeftModel` from peft. The original paper used values in the range [5.0, 15.0].
- **optim_target_modules** (`Union[str, list[str]]`, *optional*) --
  The target modules to optimize, i.e. the module names that you would like to train.
  Currently used for the GaLore algorithm (https://huggingface.co/papers/2403.03507) and APOLLO algorithm (https://huggingface.co/papers/2412.05270).
  See GaLore implementation (https://github.com/jiaweizzhao/GaLore) and APOLLO implementation (https://github.com/zhuhanqing/APOLLO) for more details.
  You need to make sure to pass a valid GaLore or APOLLO optimizer, e.g., one of: "apollo_adamw", "galore_adamw", "galore_adamw_8bit", "galore_adafactor" and make sure that the target modules are `nn.Linear` modules only.

- **batch_eval_metrics** (`bool`, *optional*, defaults to `False`) --
  If set to `True`, evaluation will call compute_metrics at the end of each batch to accumulate statistics
  rather than saving all eval logits in memory. When set to `True`, you must pass a compute_metrics function
  that takes a boolean argument `compute_result`, which when passed `True`, will trigger the final global
  summary statistics from the batch-level summary statistics you've accumulated over the evaluation set.

- **eval_on_start** (`bool`, *optional*, defaults to `False`) --
  Whether to perform a evaluation step (sanity check) before the training to ensure the validation steps works correctly.

- **eval_use_gather_object** (`bool`, *optional*, defaults to `False`) --
  Whether to run recursively gather object in a nested list/tuple/dictionary of objects from all devices. This should only be enabled if users are not just returning tensors, and this is actively discouraged by PyTorch.

- **use_liger_kernel** (`bool`, *optional*, defaults to `False`) --
  Whether enable [Liger](https://github.com/linkedin/Liger-Kernel) Kernel for LLM model training.
  It can effectively increase multi-GPU training throughput by ~20% and reduces memory usage by ~60%, works out of the box with
  flash attention, PyTorch FSDP, and Microsoft DeepSpeed. Currently, it supports llama, mistral, mixtral and gemma models.

- **liger_kernel_config** (`Optional[dict]`, *optional*) --
  Configuration to be used for Liger Kernel. When use_liger_kernel=True, this dict is passed as keyword arguments to the
  `_apply_liger_kernel_to_instance` function, which specifies which kernels to apply. Available options vary by model but typically
  include: 'rope', 'swiglu', 'cross_entropy', 'fused_linear_cross_entropy', 'rms_norm', etc. If `None`, use the default kernel configurations.

- **average_tokens_across_devices** (`bool`, *optional*, defaults to `True`) --
  Whether or not to average tokens across devices. If enabled, will use all_reduce to synchronize
  num_tokens_in_batch for precise loss calculation. Reference:
  https://github.com/huggingface/transformers/issues/34242

- **use_cache** (`bool`, *optional*, defaults to `False`) --
  Whether or not to enable cache for the model. For training, this is usually not needed apart from some PEFT methods that uses `past_key_values`.
- **predict_with_generate** (`bool`, *optional*, defaults to `False`) --
  Whether to use generate to calculate generative metrics (ROUGE, BLEU).
- **generation_max_length** (`int`, *optional*) --
  The `max_length` to use on each evaluation loop when `predict_with_generate=True`. Will default to the
  `max_length` value of the model configuration.
- **generation_num_beams** (`int`, *optional*) --
  The `num_beams` to use on each evaluation loop when `predict_with_generate=True`. Will default to the
  `num_beams` value of the model configuration.
- **generation_config** (`str` or `Path` or [GenerationConfig](/docs/transformers/pr_33892/en/main_classes/text_generation#transformers.GenerationConfig), *optional*) --
  Allows to load a [GenerationConfig](/docs/transformers/pr_33892/en/main_classes/text_generation#transformers.GenerationConfig) from the `from_pretrained` method. This can be either:

  - a string, the *model id* of a pretrained model configuration hosted inside a model repo on
    huggingface.co.
  - a path to a *directory* containing a configuration file saved using the
    [save_pretrained()](/docs/transformers/pr_33892/en/main_classes/text_generation#transformers.GenerationConfig.save_pretrained) method, e.g., `./my_model_directory/`.
  - a [GenerationConfig](/docs/transformers/pr_33892/en/main_classes/text_generation#transformers.GenerationConfig) object.</paramsdesc><paramgroups>0</paramgroups></docstring>

TrainingArguments is the subset of the arguments we use in our example scripts **which relate to the training loop
itself**.

Using [HfArgumentParser](/docs/transformers/pr_33892/en/internal/trainer_utils#transformers.HfArgumentParser) we can turn this class into
[argparse](https://docs.python.org/3/library/argparse#module-argparse) arguments that can be specified on the
command line.









<div class="docstring border-l-2 border-t-2 pl-4 pt-3.5 border-gray-100 rounded-tl-xl mb-6 mt-8">


<docstring><name>to_dict</name><anchor>transformers.Seq2SeqTrainingArguments.to_dict</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/training_args_seq2seq.py#L80</source><parameters>[]</parameters></docstring>

Serializes this instance while replace `Enum` by their values and `GenerationConfig` by dictionaries (for JSON
serialization support). It obfuscates the token values by removing their value.


</div></div>

<EditOnGithub source="https://github.com/huggingface/transformers/blob/main/docs/source/en/main_classes/trainer.md" />