Transformers documentation
Trainer
Trainer
Trainer 클래스는 PyTorch에서 완전한 기능(feature-complete)의 훈련을 위한 API를 제공하며, 다중 GPU/TPU에서의 분산 훈련, NVIDIA GPU, AMD GPU를 위한 혼합 정밀도, 그리고 PyTorch의 torch.amp를 지원합니다. Trainer는 모델의 훈련 방식을 커스터마이즈할 수 있는 다양한 옵션을 제공하는 TrainingArguments 클래스와 함께 사용됩니다. 이 두 클래스는 함께 완전한 훈련 API를 제공합니다.
Seq2SeqTrainer와 Seq2SeqTrainingArguments는 Trainer와 TrainingArguments 클래스를 상속하며, 요약이나 번역과 같은 시퀀스-투-시퀀스 작업을 위한 모델 훈련에 적합하게 조정되어 있습니다.
Trainer 클래스는 🤗 Transformers 모델에 최적화되어 있으며, 다른 모델과 함께 사용될 때 예상치 못한 동작을 하게 될 수 있습니다. 자신만의 모델을 사용할 때는 다음을 확인하세요:
- 모델은 항상 튜플이나 ModelOutput의 서브클래스를 반환해야 합니다.
- 모델은
labels인자가 제공되면 손실을 계산할 수 있고, 모델이 튜플을 반환하는 경우 그 손실이 튜플의 첫 번째 요소로 반환되어야 합니다.- 모델은 여러 개의 레이블 인자를 수용할 수 있어야 하며, Trainer에게 이름을 알리기 위해 TrainingArguments에서
label_names를 사용하지만, 그 중 어느 것도"label"로 명명되어서는 안 됩니다.
Trainer
class transformers.Trainer
< source >( model: transformers.modeling_utils.PreTrainedModel | torch.nn.modules.module.Module | None = None args: transformers.training_args.TrainingArguments | None = None data_collator: collections.abc.Callable[[list[typing.Any]], dict[str, typing.Any]] | None = None train_dataset: typing.Union[torch.utils.data.dataset.Dataset, torch.utils.data.dataset.IterableDataset, ForwardRef('datasets.Dataset'), NoneType] = None eval_dataset: typing.Union[torch.utils.data.dataset.Dataset, dict[str, torch.utils.data.dataset.Dataset], ForwardRef('datasets.Dataset'), NoneType] = None processing_class: transformers.tokenization_utils_base.PreTrainedTokenizerBase | transformers.image_processing_utils.BaseImageProcessor | transformers.feature_extraction_utils.FeatureExtractionMixin | transformers.processing_utils.ProcessorMixin | None = None model_init: collections.abc.Callable[..., transformers.modeling_utils.PreTrainedModel] | None = None compute_loss_func: collections.abc.Callable | None = None compute_metrics: collections.abc.Callable[[transformers.trainer_utils.EvalPrediction], dict] | None = None callbacks: list[transformers.trainer_callback.TrainerCallback] | None = None optimizers: tuple = (None, None) optimizer_cls_and_kwargs: tuple[type[torch.optim.optimizer.Optimizer], dict[str, typing.Any]] | None = None preprocess_logits_for_metrics: collections.abc.Callable[[torch.Tensor, torch.Tensor], torch.Tensor] | None = None )
Parameters
- model (PreTrainedModel or
torch.nn.Module, optional) — The model to train, evaluate or use for predictions. If not provided, amodel_initmust be passed.Trainer is optimized to work with the PreTrainedModel provided by the library. You can still use your own models defined as
torch.nn.Moduleas long as they work the same way as the 🤗 Transformers models. - args (TrainingArguments, optional) —
The arguments to tweak for training. Will default to a basic instance of TrainingArguments with the
output_dirset 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 oftrain_datasetoreval_dataset. Will default to default_data_collator() if noprocessing_classis provided, an instance of 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 aDataset, columns not accepted by themodel.forward()method are automatically removed.Note that if it’s a
torch.utils.data.IterableDatasetwith some randomization and you are training in a distributed fashion, your iterable dataset should either use a internal attributegeneratorthat is atorch.Generatorfor the randomization that must be identical on all processes (and the Trainer will manually set the seed of thisgeneratorat each epoch) or have aset_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 aDataset, columns not accepted by themodel.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 (
PreTrainedTokenizerBaseorBaseImageProcessororFeatureExtractionMixinorProcessorMixin, 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() 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 used by Trainer. - compute_metrics (
Callable[[EvalPrediction], Dict], optional) — The function that will be used to compute metrics at evaluation. Must take a EvalPrediction and return a dictionary string to metric values. Note When passing TrainingArgs withbatch_eval_metricsset toTrue, your compute_metrics function must take a booleancompute_resultargument. 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, optional) —
A list of callbacks to customize the training loop. Will add those to the list of default callbacks
detailed in here.
If you want to remove one of the default callbacks used, use the 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 ofAdamWon your model and a scheduler given by get_linear_schedule_with_warmup() controlled byargs. - optimizer_cls_and_kwargs (
tuple[Type[torch.optim.Optimizer], dict[str, Any]], optional) — A tuple containing the optimizer class and keyword arguments to use. Overridesoptimandoptim_argsinargs. Incompatible with theoptimizersargument.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 bycompute_metrics.Note that the labels (second parameter) will be
Noneif the dataset does not have them.
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 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 inDeepSpeedand then again intorch.nn.DistributedDataParallel. If the inner model hasn’t been wrapped, thenself.model_wrappedis the same asself.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
Falseif model parallel or deepspeed is used, or if the defaultTrainingArguments.place_model_on_deviceis overridden to returnFalse. - is_in_train — Whether or not a model is currently running
train(e.g. whenevaluateis called while intrain)
add_callback
< source >( callback )
Parameters
- callback (
typeor [`~transformers.TrainerCallback]`) — A TrainerCallback class or an instance of a TrainerCallback. In the first case, will instantiate a member of that class.
Add a callback to the current list of TrainerCallback.
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.
compute_loss
< source >( model: Module inputs: dict return_outputs: bool = False num_items_in_batch: torch.Tensor | None = None )
Parameters
- 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 toFalse) — 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,
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.
A helper wrapper to group together context managers.
create_model_card
< source >( language: str | None = None license: str | None = None tags: str | list[str] | None = None model_name: str | None = None finetuned_from: str | None = None tasks: str | list[str] | None = None dataset_tags: str | list[str] | None = None dataset: str | list[str] | None = None dataset_args: str | list[str] | None = None )
Parameters
- 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 theTrainercomes from a repo on the Hub. - tags (
strorlist[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 theTrainer(if it comes from the Hub). - tasks (
strorlist[str], optional) — One or several task identifiers, to be included in the metadata of the model card. - dataset_tags (
strorlist[str], optional) — One or several dataset tags, to be included in the metadata of the model card. - dataset (
strorlist[str], optional) — One or several dataset identifiers, to be included in the metadata of the model card. - dataset_args (
strorlist[str], optional) — One or several dataset arguments, to be included in the metadata of the model card.
Creates a draft of a model card using the information available to the Trainer.
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.
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.
create_scheduler
< source >( num_training_steps: int optimizer: Optimizer = None )
Setup the scheduler. The optimizer of the trainer must have been set up either before this method is called or passed as an argument.
evaluate
< source >( eval_dataset: torch.utils.data.dataset.Dataset | dict[str, torch.utils.data.dataset.Dataset] | None = None ignore_keys: list[str] | None = None metric_key_prefix: str = 'eval' )
Parameters
- eval_dataset (Union[
Dataset, dict[str,Dataset]], optional) — Pass a dataset if you wish to overrideself.eval_dataset. If it is aDataset, columns not accepted by themodel.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.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 suremetric_for_best_modelreferences exactly one of the datasets. If you, for example, pass in{"data1": data1, "data2": data2}for two datasetsdata1anddata2, you could specifymetric_for_best_model="eval_data1_loss"for using the loss ondata1andmetric_for_best_model="eval_data2_loss"for the loss ondata2. - 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)
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.
evaluation_loop
< source >( dataloader: DataLoader description: str prediction_loss_only: bool | None = None ignore_keys: list[str] | None = None metric_key_prefix: str = 'eval' )
Prediction/evaluation loop, shared by Trainer.evaluate() and Trainer.predict().
Works both with or without labels.
floating_point_ops
< source >( inputs: dict ) → int
For models that inherit from 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.
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.
Get the context parallel size
Get all parameter names that weight decay will be applied to.
This function filters out parameters in two ways:
- By layer type (instances of layers specified in ALL_LAYERNORM_LAYERS)
- By parameter name patterns (containing ‘bias’, or variation of ‘norm’)
get_eval_dataloader
< source >( eval_dataset: str | torch.utils.data.dataset.Dataset | None = None )
Parameters
- eval_dataset (
strortorch.utils.data.Dataset, optional) — If astr, will useself.eval_dataset[eval_dataset]as the evaluation dataset. If aDataset, will overrideself.eval_datasetand must implement__len__. If it is aDataset, columns not accepted by themodel.forward()method are automatically removed.
Returns the evaluation ~torch.utils.data.DataLoader.
Subclass and override this method if you want to inject some custom behavior.
Returns the learning rate of each parameter from self.optimizer.
Get the number of trainable parameters.
get_optimizer_cls_and_kwargs
< source >( args: TrainingArguments model: transformers.modeling_utils.PreTrainedModel | None = None )
Returns the optimizer class and optimizer parameters based on the training arguments.
get_optimizer_group
< source >( param: str | torch.nn.parameter.Parameter | None = None )
Returns optimizer group for a parameter if given, else returns all optimizer groups for params.
Get the sequence parallel size
get_test_dataloader
< source >( test_dataset: Dataset )
Returns the test ~torch.utils.data.DataLoader.
Subclass and override this method if you want to inject some custom behavior.
Calculates total batch size (micro_batch grad_accum dp_world_size).
Accounts for all parallelism dimensions: TP, CP, and SP.
Formula: dp_world_size = world_size // (tp_size cp_size sp_size)
Where:
- TP (Tensor Parallelism): Model layers split across GPUs
- CP (Context Parallelism): Sequences split using Ring Attention (FSDP2)
- SP (Sequence Parallelism): Sequences split using ALST/Ulysses (DeepSpeed)
All dimensions are separate and multiplicative: world_size = dp_size tp_size cp_size * sp_size
Get the tensor parallel size from either the model or DeepSpeed config.
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.
hyperparameter_search
< source >( hp_space: collections.abc.Callable[['optuna.Trial'], dict[str, float]] | None = None compute_objective: collections.abc.Callable[[dict[str, float]], float] | None = None n_trials: int = 20 direction: str | list[str] = 'minimize' backend: typing.Union[ForwardRef('str'), transformers.trainer_utils.HPSearchBackend, NoneType] = None hp_name: collections.abc.Callable[['optuna.Trial'], str] | None = None **kwargs ) → [trainer_utils.BestRun or list[trainer_utils.BestRun]]
Parameters
- hp_space (
Callable[["optuna.Trial"], dict[str, float]], optional) — A function that defines the hyperparameter search space. Will default todefault_hp_space_optuna()ordefault_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 theevaluatemethod. Will default todefault_compute_objective(). - n_trials (
int, optional, defaults to 100) — The number of trial runs to test. - direction (
strorlist[str], optional, defaults to"minimize") — If it’s single objective optimization, direction isstr, 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 islist[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 (
stror~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 and also the parameterstimeout,n_jobsandgc_after_trialfrom optuna.study.Study.optimizeray: parameters from tune.run. Ifresources_per_trialis not set in thekwargs, it defaults to 1 CPU core and 1 GPU (if available). Ifprogress_reporteris not set in thekwargs, ray.tune.CLIReporter is used.
Returns
[trainer_utils.BestRun or list[trainer_utils.BestRun]]
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.
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.
To use this method, you need to have provided a
model_initwhen initializing your Trainer: we need to reinitialize the model at each new run. This is incompatible with theoptimizersargument, so you need to subclass Trainer and override the method create_optimizer_and_scheduler() for custom optimizer/scheduler.
Initializes a git repo in self.args.hub_model_id.
Whether or not this process is the local (e.g., on one machine if training in a distributed fashion on several machines) main process.
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).
log
< source >( logs: dict start_time: float | None = None )
Log logs on the various objects watching training.
Subclass and override this method to inject custom behavior.
log_metrics
< source >( split metrics )
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.
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 = 7MBUnderstanding the reports:
- the first segment, e.g.,
train__, tells you which stage the metrics are for. Reports starting withinit_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 theeval_metrics. - the third segment, is either
cpuorgpu, 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 upalloc_delta+peaked_deltaand 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’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 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 calls
torch.cuda.reset_peak_memory_stats, the gpu peak memory stats could be invalid. And the 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.
metrics_format
< source >( metrics: dict ) → metrics (dict[str, float])
Reformat Trainer metrics values to a human-readable format.
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
Helper to get number of tokens in a ~torch.utils.data.DataLoader by enumerating dataloader.
pop_callback
< source >( callback ) → TrainerCallback
Parameters
- callback (
typeor [`~transformers.TrainerCallback]`) — A TrainerCallback class or an instance of a TrainerCallback. In the first case, will pop the first member of that class found in the list of callbacks.
Returns
The callback removed, if found.
Remove a callback from the current list of TrainerCallback and returns it.
If the callback is not found, returns None (and no error is raised).
predict
< source >( test_dataset: Dataset ignore_keys: list[str] | None = None metric_key_prefix: str = 'test' )
Parameters
- test_dataset (
Dataset) — Dataset to run the predictions on. If it is andatasets.Dataset, columns not accepted by themodel.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)
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().
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.
Returns: NamedTuple A namedtuple with the following keys:
- predictions (
np.ndarray): The predictions ontest_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).
prediction_step
< source >( model: Module inputs: dict prediction_loss_only: bool ignore_keys: list[str] | None = None ) → tuple[Optional[torch.Tensor], Optional[torch.Tensor], Optional[torch.Tensor]]
Parameters
- 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.
Returns
tuple[Optional[torch.Tensor], Optional[torch.Tensor], Optional[torch.Tensor]]
A tuple with the loss, logits and labels (each being optional).
Perform an evaluation step on model using inputs.
Subclass and override to inject custom behavior.
Sets values in the deepspeed plugin based on the Trainer args
push_to_hub
< source >( commit_message: str | None = 'End of training' blocking: bool = True token: str | None = None revision: str | None = None **kwargs )
Parameters
- commit_message (
str, optional, defaults to"End of training") — Message to commit while pushing. - blocking (
bool, optional, defaults toTrue) — Whether the function should return only when thegit pushhas finished. - token (
str, optional, defaults toNone) — 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().
Upload self.model and self.processing_class to the 🤗 model hub on the repo self.args.hub_model_id.
remove_callback
< source >( callback )
Parameters
- callback (
typeor [`~transformers.TrainerCallback]`) — A TrainerCallback class or an instance of a TrainerCallback. In the first case, will remove the first member of that class found in the list of callbacks.
Remove a callback from the current list of TrainerCallback.
save_metrics
< source >( split metrics combined = True )
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(). The only difference is that raw unformatted numbers are saved in the current method.
Will save the model, so you can reload it using from_pretrained().
Will only save from the main process.
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.
set_initial_training_values
< source >( args: TrainingArguments dataloader: DataLoader total_train_batch_size: int )
Calculates and returns the following values:
num_train_epochsnum_update_steps_per_epochnum_examplesnum_train_samplesepoch_basedlen_dataloadermax_steps
train
< source >( resume_from_checkpoint: str | bool | None = None trial: typing.Union[ForwardRef('optuna.Trial'), dict[str, typing.Any], NoneType] = None ignore_keys_for_eval: list[str] | None = None )
Parameters
- resume_from_checkpoint (
strorbool, optional) — If astr, local path to a saved checkpoint as saved by a previous instance of Trainer. If abooland equalsTrue, load the last checkpoint in args.output_dir as saved by a previous instance of Trainer. If present, training will resume from the model/optimizer/scheduler states loaded here. - trial (
optuna.Trialordict[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.
Main training entry point.
training_step
< source >( model: Module inputs: dict num_items_in_batch: torch.Tensor | None = None ) → torch.Tensor
Parameters
- 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.
Returns
torch.Tensor
The tensor with training loss on this batch.
Perform a training step on a batch of inputs.
Subclass and override to inject custom behavior.
Seq2SeqTrainer
class transformers.Seq2SeqTrainer
< source >( model: typing.Union[ForwardRef('PreTrainedModel'), torch.nn.modules.module.Module, NoneType] = None args: typing.Optional[ForwardRef('TrainingArguments')] = None data_collator: typing.Optional[ForwardRef('DataCollator')] = None train_dataset: typing.Union[torch.utils.data.dataset.Dataset, ForwardRef('IterableDataset'), ForwardRef('datasets.Dataset'), NoneType] = None eval_dataset: torch.utils.data.dataset.Dataset | dict[str, torch.utils.data.dataset.Dataset] | None = None processing_class: typing.Union[ForwardRef('PreTrainedTokenizerBase'), ForwardRef('BaseImageProcessor'), ForwardRef('FeatureExtractionMixin'), ForwardRef('ProcessorMixin'), NoneType] = None model_init: collections.abc.Callable[[], 'PreTrainedModel'] | None = None compute_loss_func: collections.abc.Callable | None = None compute_metrics: collections.abc.Callable[['EvalPrediction'], dict] | None = None callbacks: list['TrainerCallback'] | None = None optimizers: tuple = (None, None) preprocess_logits_for_metrics: collections.abc.Callable[[torch.Tensor, torch.Tensor], torch.Tensor] | None = None )
evaluate
< source >( eval_dataset: torch.utils.data.dataset.Dataset | None = None ignore_keys: list[str] | None = None metric_key_prefix: str = 'eval' **gen_kwargs )
Parameters
- eval_dataset (
Dataset, optional) — Pass a dataset if you wish to overrideself.eval_dataset. If it is anDataset, columns not accepted by themodel.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
generatespecific kwargs.
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.
predict
< source >( test_dataset: Dataset ignore_keys: list[str] | None = None metric_key_prefix: str = 'test' **gen_kwargs )
Parameters
- test_dataset (
Dataset) — Dataset to run the predictions on. If it is aDataset, columns not accepted by themodel.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
generatespecific kwargs.
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().
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.
Returns: NamedTuple A namedtuple with the following keys:
- predictions (
np.ndarray): The predictions ontest_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).
TrainingArguments
class transformers.TrainingArguments
< source >( output_dir: str | None = None do_train: bool = False do_eval: bool = False do_predict: bool = False eval_strategy: transformers.trainer_utils.IntervalStrategy | str = 'no' prediction_loss_only: bool = False per_device_train_batch_size: int = 8 per_device_eval_batch_size: int = 8 gradient_accumulation_steps: int = 1 eval_accumulation_steps: int | None = None eval_delay: float = 0 torch_empty_cache_steps: int | None = None learning_rate: float = 5e-05 weight_decay: float = 0.0 adam_beta1: float = 0.9 adam_beta2: float = 0.999 adam_epsilon: float = 1e-08 max_grad_norm: float = 1.0 num_train_epochs: float = 3.0 max_steps: int = -1 lr_scheduler_type: transformers.trainer_utils.SchedulerType | str = 'linear' lr_scheduler_kwargs: dict | str | None = None warmup_ratio: float | None = None warmup_steps: float = 0 log_level: str = 'passive' log_level_replica: str = 'warning' log_on_each_node: bool = True logging_dir: str | None = None logging_strategy: transformers.trainer_utils.IntervalStrategy | str = 'steps' logging_first_step: bool = False logging_steps: float = 500 logging_nan_inf_filter: bool = True save_strategy: transformers.trainer_utils.SaveStrategy | str = 'steps' save_steps: float = 500 save_total_limit: int | None = None enable_jit_checkpoint: bool = False save_on_each_node: bool = False save_only_model: bool = False restore_callback_states_from_checkpoint: bool = False use_cpu: bool = False seed: int = 42 data_seed: int | None = None bf16: bool = False fp16: bool = False bf16_full_eval: bool = False fp16_full_eval: bool = False tf32: bool | None = None local_rank: int = -1 ddp_backend: str | None = None debug: str | list[transformers.debug_utils.DebugOption] = '' dataloader_drop_last: bool = False eval_steps: float | None = None dataloader_num_workers: int = 0 dataloader_prefetch_factor: int | None = None run_name: str | None = None disable_tqdm: bool | None = None remove_unused_columns: bool = True label_names: list[str] | None = None load_best_model_at_end: bool = False metric_for_best_model: str | None = None greater_is_better: bool | None = None ignore_data_skip: bool = False fsdp: list[transformers.trainer_utils.FSDPOption] | str | None = None fsdp_config: dict[str, typing.Any] | str | None = None accelerator_config: dict | str | None = None parallelism_config: accelerate.parallelism_config.ParallelismConfig | None = None deepspeed: dict | str | None = None label_smoothing_factor: float = 0.0 optim: transformers.training_args.OptimizerNames | str = 'adamw_torch_fused' optim_args: str | None = None group_by_length: bool = False length_column_name: str = 'length' report_to: None | str | list[str] = 'none' project: str = 'huggingface' trackio_space_id: str | None = 'trackio' ddp_find_unused_parameters: bool | None = None ddp_bucket_cap_mb: int | None = None ddp_broadcast_buffers: bool | None = None dataloader_pin_memory: bool = True dataloader_persistent_workers: bool = False skip_memory_metrics: bool = True push_to_hub: bool = False resume_from_checkpoint: str | None = None hub_model_id: str | None = None hub_strategy: transformers.trainer_utils.HubStrategy | str = 'every_save' hub_token: str | None = None hub_private_repo: bool | None = None hub_always_push: bool = False hub_revision: str | None = None gradient_checkpointing: bool = False gradient_checkpointing_kwargs: dict[str, typing.Any] | str | None = None include_for_metrics: list = <factory> eval_do_concat_batches: bool = True auto_find_batch_size: bool = False full_determinism: bool = False ddp_timeout: int = 1800 torch_compile: bool = False torch_compile_backend: str | None = None torch_compile_mode: str | None = None include_num_input_tokens_seen: str | bool = 'no' neftune_noise_alpha: float | None = None optim_target_modules: None | str | list[str] = None batch_eval_metrics: bool = False eval_on_start: bool = False use_liger_kernel: bool = False liger_kernel_config: dict[str, bool] | None = None eval_use_gather_object: bool = False average_tokens_across_devices: bool = True use_cache: bool = False )
Parameters
- output_dir (
str, optional, defaults to"trainer_output") — The output directory where the model predictions and checkpoints will be written.
Training Duration and Batch Size
- 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_devicesin multi-GPU or distributed setups. - 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) — Overridesnum_train_epochs. If set to a positive number, the total number of training steps to perform. For a finite dataset, training is reiterated through the dataset (if all data is exhausted) untilmax_stepsis reached.
Learning Rate & Scheduler
- learning_rate (
float, optional, defaults to 5e-5) — The initial learning rate for the optimizer. This is typically the peak learning rate when using a scheduler with warmup. - lr_scheduler_type (
stror SchedulerType, optional, defaults to"linear") — The learning rate scheduler type to use. See SchedulerType for all possible values. Common choices:- “linear” = get_linear_schedule_with_warmup()
- “cosine” = get_cosine_schedule_with_warmup()
- “constant” = get_constant_schedule()
- “constant_with_warmup” = get_constant_schedule_with_warmup()
- lr_scheduler_kwargs (
dictorstr, optional, defaults toNone) — The extra arguments for the lr_scheduler. See the documentation of each scheduler for possible values. - warmup_steps (
intorfloat, optional, defaults to 0) — Number of steps for a linear warmup from 0 tolearning_rate. Warmup helps stabilize training in the initial phase. Can be:- An integer: exact number of warmup steps
- A float in range [0, 1): interpreted as ratio of total training steps
Optimizer
- optim (
strortraining_args.OptimizerNames, optional, defaults to"adamw_torch"(for torch>=2.8"adamw_torch_fused")) — The optimizer to use. Common options:"adamw_torch": PyTorch’s AdamW (recommended default)"adamw_torch_fused": Fused AdamW kernel"adamw_hf": HuggingFace’s AdamW implementation"sgd": Stochastic Gradient Descent with momentum"adafactor": Memory-efficient optimizer for large models"adamw_8bit": 8-bit AdamW (requires bitsandbytes) SeeOptimizerNamesfor the complete list.
- optim_args (
str, optional) — Optional arguments that are supplied to optimizers such as AnyPrecisionAdamW, AdEMAMix, and GaLore. - weight_decay (
float, optional, defaults to 0) — Weight decay coefficient applied by the optimizer (not the loss function). Adds L2 regularization to prevent overfitting by penalizing large weights. Automatically excluded from bias and LayerNorm parameters. Typical values: 0.01 (standard), 0.1 (stronger regularization), 0.0 (no regularization). - adam_beta1 (
float, optional, defaults to 0.9) — The exponential decay rate for the first moment estimates (momentum) in Adam-based optimizers. Controls how much history of gradients to retain. - adam_beta2 (
float, optional, defaults to 0.999) — The exponential decay rate for the second moment estimates (variance) in Adam-based optimizers. Controls adaptive learning rate scaling. - adam_epsilon (
float, optional, defaults to 1e-8) — Epsilon value for numerical stability in Adam-based optimizers. Prevents division by zero in the denominator of the update rule. - 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 and APOLLO algorithm. See GaLore implementation and APOLLO implementation 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 arenn.Linearmodules only.
Regularization & Training Stability
- gradient_accumulation_steps (
int, optional, defaults to 1) — Number of update steps to accumulate gradients before performing a backward/update pass. Simulates larger batch sizes without additional memory. Effective batch size =per_device_train_batch_size × num_devices × gradient_accumulation_steps.When using gradient accumulation, one “step” is counted as one step with a backward pass. Therefore, logging, evaluation, and saving will occur every
gradient_accumulation_steps × xxx_steptraining examples. - average_tokens_across_devices (
bool, optional, defaults toTrue) — 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 - max_grad_norm (
float, optional, defaults to 1.0) — Maximum gradient norm for gradient clipping. Applied after backward pass, before optimizer step. Prevents gradient explosion by scaling down gradients when their global norm exceeds this threshold. Set to 0 to disable clipping. Typical values: 1.0 (standard), 0.5 (more conservative), 5.0 (less aggressive). - label_smoothing_factor (
float, optional, defaults to 0.0) — Label smoothing factor to prevent overconfidence. Replaces hard 0/1 targets with soft targets: 0 becomesε/num_labelsand 1 becomes1 - ε + ε/num_labels, where ε =label_smoothing_factor. Zero means no smoothing. Typical range: 0.0 to 0.1.
Mixed Precision Training
- bf16 (
bool, optional, defaults toFalse) — Enable bfloat16 (BF16) mixed precision training Generally preferred over FP16 due to better numerical stability and no loss scaling required. - fp16 (
bool, optional, defaults toFalse) — Enable float16 (FP16) mixed precision training. Consider using BF16 instead if your hardware supports it. - bf16_full_eval (
bool, optional, defaults toFalse) — Use full BF16 precision for evaluation (not just mixed precision). Faster and saves memory but may affect metric values slightly. Only applies during evaluation. - fp16_full_eval (
bool, optional, defaults toFalse) — Use full FP16 precision for evaluation (not just mixed precision). Faster and saves memory but may affect metric values slightly. Only applies during evaluation. - tf32 (
bool, optional) — Enable TensorFloat-32 (TF32) mode on Ampere and newer GPUs. TF32 uses 19-bit precision for matrix multiplications (instead of FP32’s 23-bit), providing up to 8x speedup with negligible accuracy loss. Default depends on PyTorch version. See TF32 docs.
Gradient Checkpointing
- gradient_checkpointing (
bool, optional, defaults toFalse) — Enable gradient checkpointing to trade compute for memory. Reduces memory usage by clearing activations during forward pass and recomputing them during backward pass. Enables training larger models or batch sizes at the cost of ~20% slower training. - gradient_checkpointing_kwargs (
dict, optional, defaults toNone) — Keyword arguments passed togradient_checkpointing_enable().
Compilation
- torch_compile (
bool, optional, defaults toFalse) — Compile the model using PyTorch 2.0’storch.compile()for faster training. Can provide 20-50% speedup with no code changes. Uses default compilation settings unlesstorch_compile_backendortorch_compile_modeare specified. - torch_compile_backend (
str, optional) — Backend fortorch.compile(). If set, automatically enablestorch_compile. Options include"inductor"(default),"aot_eager","cudagraphs". Backends vary by PyTorch version - see PyTorch docs for available options. - torch_compile_mode (
str, optional) — Compilation mode fortorch.compile(). If set, automatically enablestorch_compile. Options:"default","reduce-overhead"(minimize Python overhead),"max-autotune"(aggressive optimization, slower compile time).
Kernels
- use_liger_kernel (
bool, optional, defaults toFalse) — Enable Liger Kernel optimizations. Increases multi-GPU throughput by ~20% and reduces memory usage by ~60%. Works with Flash Attention, FSDP, and DeepSpeed. Currently supports Llama, Mistral, Mixtral, and Gemma models. - liger_kernel_config (
Optional[dict], optional) — Configuration for Liger Kernel. Passed as kwargs to_apply_liger_kernel_to_instance(). Options typically include:"rope","swiglu","cross_entropy","fused_linear_cross_entropy","rms_norm". IfNone, uses default configuration.
Additional Optimizations
- use_cache (
bool, optional, defaults toFalse) — Whether or not to enable cache for the model. For training, this is usually not needed apart from some PEFT methods that usespast_key_values. - neftune_noise_alpha (
Optional[float]) — If notNone, this will activate NEFTune noise embeddings. This can drastically improve model performance for instruction fine-tuning. Check out the original paper and the original code. Support transformersPreTrainedModeland alsoPeftModelfrom peft. The original paper used values in the range [5.0, 15.0]. - torch_empty_cache_steps (
int, optional) — Number of steps to wait before callingtorch.<device>.empty_cache(). If left unset or set to None, cache will not be emptied. This can help avoid CUDA out-of-memory errors by lowering peak VRAM usage at a cost of about 10% slower performance. - auto_find_batch_size (
bool, optional, defaults toFalse) — Whether to find a batch size that will fit into memory automatically through exponential decay, avoiding CUDA Out-of-Memory errors.
Logging & Monitoring Training
- logging_strategy (
stror 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 everylogging_steps.
- logging_steps (
intorfloat, optional, defaults to 500) — Number of update steps between two logs iflogging_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_first_step (
bool, optional, defaults toFalse) — Whether to log the firstglobal_stepor not. - log_on_each_node (
bool, optional, defaults toTrue) — In multinode distributed training, whether to log usinglog_levelonce per node, or only on the main node. - logging_nan_inf_filter (
bool, optional, defaults toTrue) — Filter out NaN and Inf losses when logging. IfTrue, replaces NaN/Inf losses with the average of recent valid losses. Does not affect gradient computation, only logging. - 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.
Logging
- log_level (
str, optional, defaults topassive) — Logging level for the main process. Options:"debug","info","warning","error","critical", or"passive"(doesn’t change the current Transformers logging level, which defaults to"warning") - log_level_replica (
str, optional, defaults to"warning") — Logging level for replica processes in distributed training. Same options aslog_level. - disable_tqdm (
bool, optional) — Disable tqdm progress bars. Defaults toTrueiflog_levelis warning or lower,Falseotherwise.
Experiment Tracking Integration
- report_to (
strorlist[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","swanlab","tensorboard","trackio"and"wandb". Use"all"to report to all integrations installed,"none"for no integrations. - run_name (
str, optional) — A descriptor for the run. Typically used for trackio, wandb, mlflow, comet and swanlab logging. - project (
str, optional, defaults to"huggingface") — The name of the project to use for logging. Currently, only used by Trackio. - trackio_space_id (
strorNone, 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. IfNone, will log to a local directory. Note that this Space will be public unless you sethub_private_repo=Trueor your organization’s default is to create private Spaces.”
Evaluation
- eval_strategy (
stror IntervalStrategy, optional, defaults to"no") — When to run evaluation. Options:"no": No evaluation during training"steps": Evaluate everyeval_steps"epoch": Evaluate at the end of each epoch
- eval_steps (
intorfloat, optional) — Number of update steps between two evaluations ifeval_strategy="steps". Will default to the same value aslogging_stepsif 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. - eval_delay (
float, optional) — Number of epochs or steps to wait for before the first evaluation can be performed, depending on the eval_strategy. - per_device_eval_batch_size (
int, optional, defaults to 8) — The batch size per device accelerator core/CPU for evaluation. - prediction_loss_only (
bool, optional, defaults toFalse) — When performing evaluation and generating predictions, only returns the loss. - eval_on_start (
bool, optional, defaults toFalse) — Whether to perform a evaluation step (sanity check) before the training to ensure the validation steps works correctly. - eval_do_concat_batches (
bool, optional, defaults toTrue) — Whether to recursively concat inputs/losses/labels/predictions across batches. IfFalse, will instead store them as lists, with each batch kept separate. - eval_use_gather_object (
bool, optional, defaults toFalse) — 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. This is useful when the labels structure is non standard, like in computer vision tasks. - 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).
Metrics Computation
- include_for_metrics (
list[str], optional, defaults to[]) — Include additional data in thecompute_metricsfunction if needed for metrics computation. Possible options to add toinclude_for_metricslist:"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.
- batch_eval_metrics (
bool, optional, defaults toFalse) — If set toTrue, evaluation will call compute_metrics at the end of each batch to accumulate statistics rather than saving all eval logits in memory. When set toTrue, you must pass a compute_metrics function that takes a boolean argumentcompute_result, which when passedTrue, will trigger the final global summary statistics from the batch-level summary statistics you’ve accumulated over the evaluation set.
Checkpointing & Saving
- save_only_model (
bool, optional, defaults toFalse) — Save only model weights, not optimizer/scheduler/RNG state. Significantly reduces checkpoint size but prevents resuming training from the checkpoint. Use when you only need the trained model for inference, not continued training. You can only load the model usingfrom_pretrainedwith this option set toTrue. - save_strategy (
strorSaveStrategy, 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 everysave_steps."best": Save is done whenever a newbest_metricis achieved.
- save_steps (
intorfloat, optional, defaults to 500) — Number of updates steps before two checkpoint saves ifsave_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_on_each_node (
bool, optional, defaults toFalse) — 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_total_limit (
int, optional) — Maximum number of checkpoints to keep. Deletes older checkpoints inoutput_dir. Whenload_best_model_at_end=True, the best checkpoint is always retained plus the most recent ones. For example,save_total_limit=5keeps the 4 most recent plus the best - enable_jit_checkpoint (
bool, optional, defaults toFalse) — Enable Just-In-Time checkpointing on SIGTERM signal for graceful termination on preemptible workloads. Important: Configure your orchestrator’s graceful shutdown period to allow sufficient time. For Kubernetes, setterminationGracePeriodSeconds(default 30s is usually insufficient). For Slurm, use--signal=USR1@<seconds>. Required grace period ≥ longest iteration time + checkpoint save time.
Hugging Face Hub Integration
- push_to_hub (
bool, optional, defaults toFalse) — Whether or not to push the model to the Hub every time the model is saved. If this is activated,output_dirwill begin a git directory synced with the repo (determined byhub_model_id) and the content will be pushed each time a save is triggered (depending on yoursave_strategy). Calling save_model() will also trigger a push. - 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 withhf auth login. - hub_private_repo (
bool, optional) — Whether to make the repo private. IfNone(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_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 touser_name/output_dir_namewith output_dir_name being the name ofoutput_dir. - hub_strategy (
strorHubStrategy, optional, defaults to"every_save") — Defines what and when to push to Hub. Options:"end": Push only at the end of training"every_save": Push on each save (async to not block training)"checkpoint": Like"every_save"plus push latest checkpoint to"last-checkpoint"subfolder for easy resuming"all_checkpoints": Push all checkpoints as they appear
- hub_always_push (
bool, optional, defaults toFalse) — Unless this isTrue, theTrainerwill 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.
Best Model Tracking
- load_best_model_at_end (
bool, optional, defaults toFalse) — Load the best checkpoint at the end of training. Requireseval_strategyto be set. When enabled, the best checkpoint is always saved (seesave_total_limit).When `True`, `save_strategy` must match `eval_strategy`, and if using `"steps"`, `save_steps` must be a multiple of `eval_steps`. - metric_for_best_model (
str, optional) — Metric to use for comparing models whenload_best_model_at_end=True. Must be a metric name returned by evaluation, with or without the"eval_"prefix. Defaults to"loss". If you set this,greater_is_betterwill default toTrueunless the name ends with"loss". Examples:"accuracy","f1","eval_bleu". - greater_is_better (
bool, optional) — Whether higher metric values are better. Defaults based onmetric_for_best_model:Trueif the metric name doesn’t end in"loss",Falseotherwise.
Resuming Training
- ignore_data_skip (
bool, optional, defaults toFalse) — When resuming training, skip fast-forwarding through the dataset to reach the previous state. IfTrue, training starts from the beginning of the dataset (faster resume but results won’t match interrupted training). IfFalse, skips seen data (slower resume but exact continuation). - restore_callback_states_from_checkpoint (
bool, optional, defaults toFalse) — Restore callback states from checkpoint when resuming. IfTrue, will override callbacks passed to Trainer if they exist in the checkpoint.
Reproducibility
- full_determinism (
bool, optional, defaults toFalse) — IfTrue, enable_full_determinism() is called instead of set_seed() to ensure reproducible results in distributed training. Important: this will negatively impact the performance, so only use it for debugging. - 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_initfunction 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 asseed. This can be used to ensure reproducibility of data sampling, independent of the model seed.
Hardware Configuration
- use_cpu (
bool, optional, defaults toFalse) — Whether or not to use cpu. If set to False, we will use the available torch device/backend.
Accelerate Configuration
- accelerator_config (
str,dict, orAcceleratorConfig, optional) — Configuration for the internal Accelerate integration. Can be:- Path to JSON config file:
"accelerator_config.json" - Dictionary with config options
AcceleratorConfiginstance Key options:split_batches(bool, defaults toFalse): Whether to split batches across devices. IfTrue, actual batch size is the same on all devices (total must be divisible by num_processes). IfFalse, each device gets the specified batch size.dispatch_batches(bool): IfTrue, only main process iterates through dataloader and dispatches batches to devices. Defaults toTrueforIterableDataset,Falseotherwise.even_batches(bool, defaults toTrue): Duplicate samples from dataset start to ensure all workers get equal batch sizes.use_seedable_sampler(bool, defaults toTrue): Use fully seedable random sampler for reproducibility.use_configured_state(bool, defaults toFalse): Use pre-initializedAcceleratorState/PartialStateinstead of creating new one. May cause issues with hyperparameter tuning.
- Path to JSON config file:
- parallelism_config (
ParallelismConfig, optional) — Parallelism configuration for the training run. Requires Accelerate1.10.1
Dataloader
- dataloader_drop_last (
bool, optional, defaults toFalse) — Whether to drop the last incomplete batch (if the length of the dataset is not divisible by the batch size) or not. - 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. - dataloader_pin_memory (
bool, optional, defaults toTrue) — Whether you want to pin memory in data loaders or not. Will default toTrue. - dataloader_persistent_workers (
bool, optional, defaults toFalse) — 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 toFalse. - 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. - remove_unused_columns (
bool, optional, defaults toTrue) — 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 theXxxForQuestionAnsweringin which case it will also include the["start_positions", "end_positions"]keys. You should only specifylabel_namesif you’re using custom label names or if your model’sforwardconsumes multiple label tensors (e.g., extractive QA). - group_by_length (
bool, optional, defaults toFalse) — 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 unlessgroup_by_lengthisTrueand the dataset is an instance ofDataset.
DDP (DistributedDataParallel)
- ddp_find_unused_parameters (
bool, optional) — When using distributed training, the value of the flagfind_unused_parameterspassed toDistributedDataParallel. Will default toFalseif gradient checkpointing is used,Trueotherwise. - ddp_bucket_cap_mb (
int, optional) — When using distributed training, the value of the flagbucket_cap_mbpassed toDistributedDataParallel. - ddp_broadcast_buffers (
bool, optional) — When using distributed training, the value of the flagbroadcast_bufferspassed toDistributedDataParallel. Will default toFalseif gradient checkpointing is used,Trueotherwise. - ddp_backend (
str, optional) — The backend to use for distributed training. Must be one of"nccl","mpi","xccl","gloo","hccl". - ddp_timeout (
int, optional, defaults to 1800) — The timeout fortorch.distributed.init_process_groupcalls, used to avoid GPU socket timeouts when performing slow operations in distributed runnings. Please refer to the PyTorch documentation for more information.
FSDP (Fully Sharded Data Parallel)
- fsdp (
bool,stror list ofFSDPOption, optional, defaults toNone) — Enable PyTorch Fully Sharded Data Parallel (FSDP) for distributed training. Options:"full_shard": Shard parameters, gradients, and optimizer states (most memory efficient)"shard_grad_op": Shard only optimizer states and gradients (ZeRO-2)"hybrid_shard": Full shard within nodes, replicate across nodes"hybrid_shard_zero2": Shard gradients/optimizer within nodes, replicate across nodes"offload": Offload parameters and gradients to CPU (only with"full_shard"or"shard_grad_op")"auto_wrap": Automatically wrap layers usingdefault_auto_wrap_policy
- fsdp_config (
strordict, 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 asdict.A List of config and its options:
-
fsdp_version (
int, optional, defaults to1): The version of FSDP to use. Defaults to 1. -
min_num_params (
int, optional, defaults to0): FSDP’s minimum number of parameters for Default Auto Wrapping. (useful only whenfsdpfield 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 whenfsdpflag is passed). -
backward_prefetch (
str, optional) FSDP’s backward prefetch mode. Controls when to prefetch next set of parameters (useful only whenfsdpfield 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 toFalse) FSDP’s forward prefetch mode (useful only whenfsdpfield 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 toFalse) FSDP’s limit_all_gathers (useful only whenfsdpfield is passed). If"True", FSDP explicitly synchronizes the CPU thread to prevent too many in-flight all-gathers. -
use_orig_params (
bool, optional, defaults toTrue) If"True", allows non-uniformrequires_gradduring 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 toTrue) 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 toFalse) 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_statesalso 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 toFalse): 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 toFalse): 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.
-
xla_fsdp_grad_ckpt (
bool, optional, defaults toFalse): 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
- deepspeed (
strordict, optional) — Enable DeepSpeed integration. Value is either:- Path to DeepSpeed JSON config file:
"ds_config.json" - Loaded config as dictionary
If using ZeRO initialization, instantiate your model after initializing
TrainingArguments, otherwise ZeRO won’t be applied.
- Path to DeepSpeed JSON config file:
Debugging & Profiling (Experimental)
- debug (
stror list ofDebugOption, 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
- skip_memory_metrics (
bool, optional, defaults toTrue) — Whether to skip adding of memory profiler reports to metrics. This is skipped by default because it slows down the training and evaluation speed.
External Script Flags (not used by Trainer)
- do_train (
bool, optional, defaults toFalse) — Whether to run training or not. This argument is not directly used by Trainer, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - do_eval (
bool, optional) — Whether to run evaluation on the validation set or not. Will be set toTrueifeval_strategyis different from"no". This argument is not directly used by Trainer, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - do_predict (
bool, optional, defaults toFalse) — Whether to run predictions on the test set or not. This argument is not directly used by Trainer, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - 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, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details.
Configuration class for controlling all aspects of model training with the Trainer. TrainingArguments centralizes all hyperparameters, optimization settings, logging preferences, and infrastructure choices needed for training.
HfArgumentParser can turn this class into argparse arguments that can be specified on the command line.
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.
Get number of steps used for a linear warmup.
main_process_first
< source >( local = True desc = 'work' )
Parameters
- local (
bool, optional, defaults toTrue) — ifTruefirst means process of rank 0 of each node ifFalsefirst means process of rank 0 of node rank 0 In multi-node environment with a shared filesystem you most likely will want to uselocal=Falseso 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
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.
set_dataloader
< source >( train_batch_size: int = 8 eval_batch_size: int = 8 drop_last: bool = False num_workers: int = 0 pin_memory: bool = True persistent_workers: bool = False prefetch_factor: int | None = None auto_find_batch_size: bool = False ignore_data_skip: bool = False sampler_seed: int | None = None )
Parameters
- drop_last (
bool, optional, defaults toFalse) — 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 toTrue) — Whether you want to pin memory in data loaders or not. Will default toTrue. - persistent_workers (
bool, optional, defaults toFalse) — 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 toFalse. - 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 toFalse) — 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 toFalse) — 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 toTrue, 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 asself.seed. This can be used to ensure reproducibility of data sampling, independent of the model seed.
A method that regroups all arguments linked to the dataloaders creation.
set_evaluate
< source >( strategy: str | transformers.trainer_utils.IntervalStrategy = 'no' steps: int = 500 batch_size: int = 8 accumulation_steps: int | None = None delay: float | None = None loss_only: bool = False )
Parameters
- strategy (
stror 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) everysteps."epoch": Evaluation is done at the end of each epoch.
Setting a
strategydifferent from"no"will setself.do_evaltoTrue. - steps (
int, optional, defaults to 500) — Number of update steps between two evaluations ifstrategy="steps". - batch_size (
intoptional, 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 toFalse) — Ignores all outputs except the loss.
A method that regroups all arguments linked to evaluation.
set_logging
< source >( strategy: str | transformers.trainer_utils.IntervalStrategy = 'steps' steps: int = 500 report_to: str | list[str] = 'none' level: str = 'passive' first_step: bool = False nan_inf_filter: bool = False on_each_node: bool = False replica_level: str = 'passive' )
Parameters
- strategy (
stror 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 everylogging_steps.
- steps (
int, optional, defaults to 500) — Number of update steps between two logs ifstrategy="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 (
strorlist[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","swanlab","tensorboard","trackio"and"wandb". Use"all"to report to all integrations installed,"none"for no integrations. - first_step (
bool, optional, defaults toFalse) — Whether to log and evaluate the firstglobal_stepor not. - nan_inf_filter (
bool, optional, defaults toTrue) — Whether to filternanandinflosses for logging. If set toTruethe loss of every step that isnanorinfis filtered and the average loss of the current logging window is taken instead.nan_inf_filteronly influences the logging of loss values, it does not change the behavior the gradient is computed or applied to the model. - on_each_node (
bool, optional, defaults toTrue) — In multinode distributed training, whether to log usinglog_levelonce per node, or only on the main node. - replica_level (
str, optional, defaults to"passive") — Logger log level to use on replicas. Same choices aslog_level
A method that regroups all arguments linked to logging.
set_lr_scheduler
< source >( name: str | transformers.trainer_utils.SchedulerType = 'linear' num_epochs: float = 3.0 max_steps: int = -1 warmup_steps: float = 0 warmup_ratio: float | None = None )
Parameters
- name (
stror SchedulerType, optional, defaults to"linear") — The scheduler type to use. See the documentation of 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. Overridesnum_train_epochs. For a finite dataset, training is reiterated through the dataset (if all data is exhausted) untilmax_stepsis reached. - warmup_steps (
float, optional, defaults to 0) — Number of steps used for a linear warmup from 0 tolearning_rate. Should be an integer or a float in range[0,1). If smaller than 1, will be interpreted as ratio of steps used for a linear warmup from 0 tolearning_rate.
A method that regroups all arguments linked to the learning rate scheduler and its hyperparameters.
set_optimizer
< source >( name: str | transformers.training_args.OptimizerNames = 'adamw_torch' learning_rate: float = 5e-05 weight_decay: float = 0 beta1: float = 0.9 beta2: float = 0.999 epsilon: float = 1e-08 args: str | None = None )
Parameters
- name (
strortraining_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 whenoptim="adamw_anyprecision").
A method that regroups all arguments linked to the optimizer and its hyperparameters.
set_push_to_hub
< source >( model_id: str strategy: str | transformers.trainer_utils.HubStrategy = 'every_save' token: str | None = None private_repo: bool | None = None always_push: bool = False revision: str | None = None )
Parameters
- 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 (
strorHubStrategy, 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) and a draft of a model card when the save_model() method is called."every_save": push the model, its configuration, the processing_class e.g. tokenizer (if passed along to the 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 withtrainer.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 withhf auth login. - private_repo (
bool, optional, defaults toFalse) — Whether to make the repo private. IfNone(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 toFalse) — Unless this isTrue, theTrainerwill 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.
A method that regroups all arguments linked to synchronizing checkpoints with the Hub.
Calling this method will set
self.push_to_hubtoTrue, which means theoutput_dirwill begin a git directory synced with the repo (determined bymodel_id) and the content will be pushed each time a save is triggered (depending on yourself.save_strategy). Calling save_model() will also trigger a push.
set_save
< source >( strategy: str | transformers.trainer_utils.IntervalStrategy = 'steps' steps: int = 500 total_limit: int | None = None on_each_node: bool = False )
Parameters
- strategy (
stror 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 everysave_steps.
- steps (
int, optional, defaults to 500) — Number of updates steps before two checkpoint saves ifstrategy="steps". - total_limit (
int, optional) — If a value is passed, will limit the total amount of checkpoints. Deletes the older checkpoints inoutput_dir. - on_each_node (
bool, optional, defaults toFalse) — 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.
A method that regroups all arguments linked to checkpoint saving.
set_testing
< source >( batch_size: int = 8 loss_only: bool = False )
A method that regroups all basic arguments linked to testing on a held-out dataset.
Calling this method will automatically set
self.do_predicttoTrue.
set_training
< source >( learning_rate: float = 5e-05 batch_size: int = 8 weight_decay: float = 0 num_epochs: float = 3 max_steps: int = -1 gradient_accumulation_steps: int = 1 seed: int = 42 gradient_checkpointing: bool = False )
Parameters
- learning_rate (
float, optional, defaults to 5e-5) — The initial learning rate for the optimizer. - batch_size (
intoptional, 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. Overridesnum_train_epochs. For a finite dataset, training is reiterated through the dataset (if all data is exhausted) untilmax_stepsis reached. - gradient_accumulation_steps (
int, optional, defaults to 1) — Number of updates steps to accumulate the gradients for, before performing a backward/update pass.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_steptraining examples. - 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_initfunction to instantiate the model if it has some randomly initialized parameters. - gradient_checkpointing (
bool, optional, defaults toFalse) — If True, use gradient checkpointing to save memory at the expense of slower backward pass.
A method that regroups all basic arguments linked to the training.
Calling this method will automatically set
self.do_traintoTrue.
Serializes this instance while replace Enum by their values (for JSON serialization support). It obfuscates
the token values by removing their value.
Serializes this instance to a JSON string.
Sanitized serialization to use with TensorBoard’s hparams
Seq2SeqTrainingArguments
class transformers.Seq2SeqTrainingArguments
< source >( output_dir: str | None = None do_train: bool = False do_eval: bool = False do_predict: bool = False eval_strategy: transformers.trainer_utils.IntervalStrategy | str = 'no' prediction_loss_only: bool = False per_device_train_batch_size: int = 8 per_device_eval_batch_size: int = 8 gradient_accumulation_steps: int = 1 eval_accumulation_steps: int | None = None eval_delay: float = 0 torch_empty_cache_steps: int | None = None learning_rate: float = 5e-05 weight_decay: float = 0.0 adam_beta1: float = 0.9 adam_beta2: float = 0.999 adam_epsilon: float = 1e-08 max_grad_norm: float = 1.0 num_train_epochs: float = 3.0 max_steps: int = -1 lr_scheduler_type: transformers.trainer_utils.SchedulerType | str = 'linear' lr_scheduler_kwargs: dict | str | None = None warmup_ratio: float | None = None warmup_steps: float = 0 log_level: str = 'passive' log_level_replica: str = 'warning' log_on_each_node: bool = True logging_dir: str | None = None logging_strategy: transformers.trainer_utils.IntervalStrategy | str = 'steps' logging_first_step: bool = False logging_steps: float = 500 logging_nan_inf_filter: bool = True save_strategy: transformers.trainer_utils.SaveStrategy | str = 'steps' save_steps: float = 500 save_total_limit: int | None = None enable_jit_checkpoint: bool = False save_on_each_node: bool = False save_only_model: bool = False restore_callback_states_from_checkpoint: bool = False use_cpu: bool = False seed: int = 42 data_seed: int | None = None bf16: bool = False fp16: bool = False bf16_full_eval: bool = False fp16_full_eval: bool = False tf32: bool | None = None local_rank: int = -1 ddp_backend: str | None = None debug: str | list[transformers.debug_utils.DebugOption] = '' dataloader_drop_last: bool = False eval_steps: float | None = None dataloader_num_workers: int = 0 dataloader_prefetch_factor: int | None = None run_name: str | None = None disable_tqdm: bool | None = None remove_unused_columns: bool = True label_names: list[str] | None = None load_best_model_at_end: bool = False metric_for_best_model: str | None = None greater_is_better: bool | None = None ignore_data_skip: bool = False fsdp: list[transformers.trainer_utils.FSDPOption] | str | None = None fsdp_config: dict[str, typing.Any] | str | None = None accelerator_config: dict | str | None = None parallelism_config: accelerate.parallelism_config.ParallelismConfig | None = None deepspeed: dict | str | None = None label_smoothing_factor: float = 0.0 optim: transformers.training_args.OptimizerNames | str = 'adamw_torch_fused' optim_args: str | None = None group_by_length: bool = False length_column_name: str = 'length' report_to: None | str | list[str] = 'none' project: str = 'huggingface' trackio_space_id: str | None = 'trackio' ddp_find_unused_parameters: bool | None = None ddp_bucket_cap_mb: int | None = None ddp_broadcast_buffers: bool | None = None dataloader_pin_memory: bool = True dataloader_persistent_workers: bool = False skip_memory_metrics: bool = True push_to_hub: bool = False resume_from_checkpoint: str | None = None hub_model_id: str | None = None hub_strategy: transformers.trainer_utils.HubStrategy | str = 'every_save' hub_token: str | None = None hub_private_repo: bool | None = None hub_always_push: bool = False hub_revision: str | None = None gradient_checkpointing: bool = False gradient_checkpointing_kwargs: dict[str, typing.Any] | str | None = None include_for_metrics: list = <factory> eval_do_concat_batches: bool = True auto_find_batch_size: bool = False full_determinism: bool = False ddp_timeout: int = 1800 torch_compile: bool = False torch_compile_backend: str | None = None torch_compile_mode: str | None = None include_num_input_tokens_seen: str | bool = 'no' neftune_noise_alpha: float | None = None optim_target_modules: None | str | list[str] = None batch_eval_metrics: bool = False eval_on_start: bool = False use_liger_kernel: bool = False liger_kernel_config: dict[str, bool] | None = None eval_use_gather_object: bool = False average_tokens_across_devices: bool = True use_cache: bool = False sortish_sampler: bool = False predict_with_generate: bool = False generation_max_length: int | None = None generation_num_beams: int | None = None generation_config: str | pathlib.Path | transformers.generation.configuration_utils.GenerationConfig | None = None )
Parameters
- output_dir (
str, optional, defaults to"trainer_output") — The output directory where the model predictions and checkpoints will be written.
Training Duration and Batch Size
- 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_devicesin multi-GPU or distributed setups. - 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) — Overridesnum_train_epochs. If set to a positive number, the total number of training steps to perform. For a finite dataset, training is reiterated through the dataset (if all data is exhausted) untilmax_stepsis reached.
Learning Rate & Scheduler
- learning_rate (
float, optional, defaults to 5e-5) — The initial learning rate for the optimizer. This is typically the peak learning rate when using a scheduler with warmup. - lr_scheduler_type (
stror SchedulerType, optional, defaults to"linear") — The learning rate scheduler type to use. See SchedulerType for all possible values. Common choices:- “linear” = get_linear_schedule_with_warmup()
- “cosine” = get_cosine_schedule_with_warmup()
- “constant” = get_constant_schedule()
- “constant_with_warmup” = get_constant_schedule_with_warmup()
- lr_scheduler_kwargs (
dictorstr, optional, defaults toNone) — The extra arguments for the lr_scheduler. See the documentation of each scheduler for possible values. - warmup_steps (
intorfloat, optional, defaults to 0) — Number of steps for a linear warmup from 0 tolearning_rate. Warmup helps stabilize training in the initial phase. Can be:- An integer: exact number of warmup steps
- A float in range [0, 1): interpreted as ratio of total training steps
Optimizer
- optim (
strortraining_args.OptimizerNames, optional, defaults to"adamw_torch"(for torch>=2.8"adamw_torch_fused")) — The optimizer to use. Common options:"adamw_torch": PyTorch’s AdamW (recommended default)"adamw_torch_fused": Fused AdamW kernel"adamw_hf": HuggingFace’s AdamW implementation"sgd": Stochastic Gradient Descent with momentum"adafactor": Memory-efficient optimizer for large models"adamw_8bit": 8-bit AdamW (requires bitsandbytes) SeeOptimizerNamesfor the complete list.
- optim_args (
str, optional) — Optional arguments that are supplied to optimizers such as AnyPrecisionAdamW, AdEMAMix, and GaLore. - weight_decay (
float, optional, defaults to 0) — Weight decay coefficient applied by the optimizer (not the loss function). Adds L2 regularization to prevent overfitting by penalizing large weights. Automatically excluded from bias and LayerNorm parameters. Typical values: 0.01 (standard), 0.1 (stronger regularization), 0.0 (no regularization). - adam_beta1 (
float, optional, defaults to 0.9) — The exponential decay rate for the first moment estimates (momentum) in Adam-based optimizers. Controls how much history of gradients to retain. - adam_beta2 (
float, optional, defaults to 0.999) — The exponential decay rate for the second moment estimates (variance) in Adam-based optimizers. Controls adaptive learning rate scaling. - adam_epsilon (
float, optional, defaults to 1e-8) — Epsilon value for numerical stability in Adam-based optimizers. Prevents division by zero in the denominator of the update rule. - 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 and APOLLO algorithm. See GaLore implementation and APOLLO implementation 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 arenn.Linearmodules only.
Regularization & Training Stability
- gradient_accumulation_steps (
int, optional, defaults to 1) — Number of update steps to accumulate gradients before performing a backward/update pass. Simulates larger batch sizes without additional memory. Effective batch size =per_device_train_batch_size × num_devices × gradient_accumulation_steps.When using gradient accumulation, one “step” is counted as one step with a backward pass. Therefore, logging, evaluation, and saving will occur every
gradient_accumulation_steps × xxx_steptraining examples. - average_tokens_across_devices (
bool, optional, defaults toTrue) — 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 - max_grad_norm (
float, optional, defaults to 1.0) — Maximum gradient norm for gradient clipping. Applied after backward pass, before optimizer step. Prevents gradient explosion by scaling down gradients when their global norm exceeds this threshold. Set to 0 to disable clipping. Typical values: 1.0 (standard), 0.5 (more conservative), 5.0 (less aggressive). - label_smoothing_factor (
float, optional, defaults to 0.0) — Label smoothing factor to prevent overconfidence. Replaces hard 0/1 targets with soft targets: 0 becomesε/num_labelsand 1 becomes1 - ε + ε/num_labels, where ε =label_smoothing_factor. Zero means no smoothing. Typical range: 0.0 to 0.1.
Mixed Precision Training
- bf16 (
bool, optional, defaults toFalse) — Enable bfloat16 (BF16) mixed precision training Generally preferred over FP16 due to better numerical stability and no loss scaling required. - fp16 (
bool, optional, defaults toFalse) — Enable float16 (FP16) mixed precision training. Consider using BF16 instead if your hardware supports it. - bf16_full_eval (
bool, optional, defaults toFalse) — Use full BF16 precision for evaluation (not just mixed precision). Faster and saves memory but may affect metric values slightly. Only applies during evaluation. - fp16_full_eval (
bool, optional, defaults toFalse) — Use full FP16 precision for evaluation (not just mixed precision). Faster and saves memory but may affect metric values slightly. Only applies during evaluation. - tf32 (
bool, optional) — Enable TensorFloat-32 (TF32) mode on Ampere and newer GPUs. TF32 uses 19-bit precision for matrix multiplications (instead of FP32’s 23-bit), providing up to 8x speedup with negligible accuracy loss. Default depends on PyTorch version. See TF32 docs.
Gradient Checkpointing
- gradient_checkpointing (
bool, optional, defaults toFalse) — Enable gradient checkpointing to trade compute for memory. Reduces memory usage by clearing activations during forward pass and recomputing them during backward pass. Enables training larger models or batch sizes at the cost of ~20% slower training. - gradient_checkpointing_kwargs (
dict, optional, defaults toNone) — Keyword arguments passed togradient_checkpointing_enable().
Compilation
- torch_compile (
bool, optional, defaults toFalse) — Compile the model using PyTorch 2.0’storch.compile()for faster training. Can provide 20-50% speedup with no code changes. Uses default compilation settings unlesstorch_compile_backendortorch_compile_modeare specified. - torch_compile_backend (
str, optional) — Backend fortorch.compile(). If set, automatically enablestorch_compile. Options include"inductor"(default),"aot_eager","cudagraphs". Backends vary by PyTorch version - see PyTorch docs for available options. - torch_compile_mode (
str, optional) — Compilation mode fortorch.compile(). If set, automatically enablestorch_compile. Options:"default","reduce-overhead"(minimize Python overhead),"max-autotune"(aggressive optimization, slower compile time).
Kernels
- use_liger_kernel (
bool, optional, defaults toFalse) — Enable Liger Kernel optimizations. Increases multi-GPU throughput by ~20% and reduces memory usage by ~60%. Works with Flash Attention, FSDP, and DeepSpeed. Currently supports Llama, Mistral, Mixtral, and Gemma models. - liger_kernel_config (
Optional[dict], optional) — Configuration for Liger Kernel. Passed as kwargs to_apply_liger_kernel_to_instance(). Options typically include:"rope","swiglu","cross_entropy","fused_linear_cross_entropy","rms_norm". IfNone, uses default configuration.
Additional Optimizations
- use_cache (
bool, optional, defaults toFalse) — Whether or not to enable cache for the model. For training, this is usually not needed apart from some PEFT methods that usespast_key_values. - neftune_noise_alpha (
Optional[float]) — If notNone, this will activate NEFTune noise embeddings. This can drastically improve model performance for instruction fine-tuning. Check out the original paper and the original code. Support transformersPreTrainedModeland alsoPeftModelfrom peft. The original paper used values in the range [5.0, 15.0]. - torch_empty_cache_steps (
int, optional) — Number of steps to wait before callingtorch.<device>.empty_cache(). If left unset or set to None, cache will not be emptied. This can help avoid CUDA out-of-memory errors by lowering peak VRAM usage at a cost of about 10% slower performance. - auto_find_batch_size (
bool, optional, defaults toFalse) — Whether to find a batch size that will fit into memory automatically through exponential decay, avoiding CUDA Out-of-Memory errors.
Logging & Monitoring Training
- logging_strategy (
stror 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 everylogging_steps.
- logging_steps (
intorfloat, optional, defaults to 500) — Number of update steps between two logs iflogging_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_first_step (
bool, optional, defaults toFalse) — Whether to log the firstglobal_stepor not. - log_on_each_node (
bool, optional, defaults toTrue) — In multinode distributed training, whether to log usinglog_levelonce per node, or only on the main node. - logging_nan_inf_filter (
bool, optional, defaults toTrue) — Filter out NaN and Inf losses when logging. IfTrue, replaces NaN/Inf losses with the average of recent valid losses. Does not affect gradient computation, only logging. - 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.
Logging
- log_level (
str, optional, defaults topassive) — Logging level for the main process. Options:"debug","info","warning","error","critical", or"passive"(doesn’t change the current Transformers logging level, which defaults to"warning") - log_level_replica (
str, optional, defaults to"warning") — Logging level for replica processes in distributed training. Same options aslog_level. - disable_tqdm (
bool, optional) — Disable tqdm progress bars. Defaults toTrueiflog_levelis warning or lower,Falseotherwise.
Experiment Tracking Integration
- report_to (
strorlist[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","swanlab","tensorboard","trackio"and"wandb". Use"all"to report to all integrations installed,"none"for no integrations. - run_name (
str, optional) — A descriptor for the run. Typically used for trackio, wandb, mlflow, comet and swanlab logging. - project (
str, optional, defaults to"huggingface") — The name of the project to use for logging. Currently, only used by Trackio. - trackio_space_id (
strorNone, 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. IfNone, will log to a local directory. Note that this Space will be public unless you sethub_private_repo=Trueor your organization’s default is to create private Spaces.”
Evaluation
- eval_strategy (
stror IntervalStrategy, optional, defaults to"no") — When to run evaluation. Options:"no": No evaluation during training"steps": Evaluate everyeval_steps"epoch": Evaluate at the end of each epoch
- eval_steps (
intorfloat, optional) — Number of update steps between two evaluations ifeval_strategy="steps". Will default to the same value aslogging_stepsif 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. - eval_delay (
float, optional) — Number of epochs or steps to wait for before the first evaluation can be performed, depending on the eval_strategy. - per_device_eval_batch_size (
int, optional, defaults to 8) — The batch size per device accelerator core/CPU for evaluation. - prediction_loss_only (
bool, optional, defaults toFalse) — When performing evaluation and generating predictions, only returns the loss. - eval_on_start (
bool, optional, defaults toFalse) — Whether to perform a evaluation step (sanity check) before the training to ensure the validation steps works correctly. - eval_do_concat_batches (
bool, optional, defaults toTrue) — Whether to recursively concat inputs/losses/labels/predictions across batches. IfFalse, will instead store them as lists, with each batch kept separate. - eval_use_gather_object (
bool, optional, defaults toFalse) — 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. This is useful when the labels structure is non standard, like in computer vision tasks. - 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).
Metrics Computation
- include_for_metrics (
list[str], optional, defaults to[]) — Include additional data in thecompute_metricsfunction if needed for metrics computation. Possible options to add toinclude_for_metricslist:"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.
- batch_eval_metrics (
bool, optional, defaults toFalse) — If set toTrue, evaluation will call compute_metrics at the end of each batch to accumulate statistics rather than saving all eval logits in memory. When set toTrue, you must pass a compute_metrics function that takes a boolean argumentcompute_result, which when passedTrue, will trigger the final global summary statistics from the batch-level summary statistics you’ve accumulated over the evaluation set.
Checkpointing & Saving
- save_only_model (
bool, optional, defaults toFalse) — Save only model weights, not optimizer/scheduler/RNG state. Significantly reduces checkpoint size but prevents resuming training from the checkpoint. Use when you only need the trained model for inference, not continued training. You can only load the model usingfrom_pretrainedwith this option set toTrue. - save_strategy (
strorSaveStrategy, 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 everysave_steps."best": Save is done whenever a newbest_metricis achieved.
- save_steps (
intorfloat, optional, defaults to 500) — Number of updates steps before two checkpoint saves ifsave_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_on_each_node (
bool, optional, defaults toFalse) — 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_total_limit (
int, optional) — Maximum number of checkpoints to keep. Deletes older checkpoints inoutput_dir. Whenload_best_model_at_end=True, the best checkpoint is always retained plus the most recent ones. For example,save_total_limit=5keeps the 4 most recent plus the best - enable_jit_checkpoint (
bool, optional, defaults toFalse) — Enable Just-In-Time checkpointing on SIGTERM signal for graceful termination on preemptible workloads. Important: Configure your orchestrator’s graceful shutdown period to allow sufficient time. For Kubernetes, setterminationGracePeriodSeconds(default 30s is usually insufficient). For Slurm, use--signal=USR1@<seconds>. Required grace period ≥ longest iteration time + checkpoint save time.
Hugging Face Hub Integration
- push_to_hub (
bool, optional, defaults toFalse) — Whether or not to push the model to the Hub every time the model is saved. If this is activated,output_dirwill begin a git directory synced with the repo (determined byhub_model_id) and the content will be pushed each time a save is triggered (depending on yoursave_strategy). Calling save_model() will also trigger a push. - 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 withhf auth login. - hub_private_repo (
bool, optional) — Whether to make the repo private. IfNone(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_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 touser_name/output_dir_namewith output_dir_name being the name ofoutput_dir. - hub_strategy (
strorHubStrategy, optional, defaults to"every_save") — Defines what and when to push to Hub. Options:"end": Push only at the end of training"every_save": Push on each save (async to not block training)"checkpoint": Like"every_save"plus push latest checkpoint to"last-checkpoint"subfolder for easy resuming"all_checkpoints": Push all checkpoints as they appear
- hub_always_push (
bool, optional, defaults toFalse) — Unless this isTrue, theTrainerwill 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.
Best Model Tracking
- load_best_model_at_end (
bool, optional, defaults toFalse) — Load the best checkpoint at the end of training. Requireseval_strategyto be set. When enabled, the best checkpoint is always saved (seesave_total_limit).When `True`, `save_strategy` must match `eval_strategy`, and if using `"steps"`, `save_steps` must be a multiple of `eval_steps`. - metric_for_best_model (
str, optional) — Metric to use for comparing models whenload_best_model_at_end=True. Must be a metric name returned by evaluation, with or without the"eval_"prefix. Defaults to"loss". If you set this,greater_is_betterwill default toTrueunless the name ends with"loss". Examples:"accuracy","f1","eval_bleu". - greater_is_better (
bool, optional) — Whether higher metric values are better. Defaults based onmetric_for_best_model:Trueif the metric name doesn’t end in"loss",Falseotherwise.
Resuming Training
- ignore_data_skip (
bool, optional, defaults toFalse) — When resuming training, skip fast-forwarding through the dataset to reach the previous state. IfTrue, training starts from the beginning of the dataset (faster resume but results won’t match interrupted training). IfFalse, skips seen data (slower resume but exact continuation). - restore_callback_states_from_checkpoint (
bool, optional, defaults toFalse) — Restore callback states from checkpoint when resuming. IfTrue, will override callbacks passed to Trainer if they exist in the checkpoint.
Reproducibility
- full_determinism (
bool, optional, defaults toFalse) — IfTrue, enable_full_determinism() is called instead of set_seed() to ensure reproducible results in distributed training. Important: this will negatively impact the performance, so only use it for debugging. - 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_initfunction 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 asseed. This can be used to ensure reproducibility of data sampling, independent of the model seed.
Hardware Configuration
- use_cpu (
bool, optional, defaults toFalse) — Whether or not to use cpu. If set to False, we will use the available torch device/backend.
Accelerate Configuration
- accelerator_config (
str,dict, orAcceleratorConfig, optional) — Configuration for the internal Accelerate integration. Can be:- Path to JSON config file:
"accelerator_config.json" - Dictionary with config options
AcceleratorConfiginstance Key options:split_batches(bool, defaults toFalse): Whether to split batches across devices. IfTrue, actual batch size is the same on all devices (total must be divisible by num_processes). IfFalse, each device gets the specified batch size.dispatch_batches(bool): IfTrue, only main process iterates through dataloader and dispatches batches to devices. Defaults toTrueforIterableDataset,Falseotherwise.even_batches(bool, defaults toTrue): Duplicate samples from dataset start to ensure all workers get equal batch sizes.use_seedable_sampler(bool, defaults toTrue): Use fully seedable random sampler for reproducibility.use_configured_state(bool, defaults toFalse): Use pre-initializedAcceleratorState/PartialStateinstead of creating new one. May cause issues with hyperparameter tuning.
- Path to JSON config file:
- parallelism_config (
ParallelismConfig, optional) — Parallelism configuration for the training run. Requires Accelerate1.10.1
Dataloader
- dataloader_drop_last (
bool, optional, defaults toFalse) — Whether to drop the last incomplete batch (if the length of the dataset is not divisible by the batch size) or not. - 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. - dataloader_pin_memory (
bool, optional, defaults toTrue) — Whether you want to pin memory in data loaders or not. Will default toTrue. - dataloader_persistent_workers (
bool, optional, defaults toFalse) — 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 toFalse. - 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. - remove_unused_columns (
bool, optional, defaults toTrue) — 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 theXxxForQuestionAnsweringin which case it will also include the["start_positions", "end_positions"]keys. You should only specifylabel_namesif you’re using custom label names or if your model’sforwardconsumes multiple label tensors (e.g., extractive QA). - group_by_length (
bool, optional, defaults toFalse) — 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 unlessgroup_by_lengthisTrueand the dataset is an instance ofDataset.
DDP (DistributedDataParallel)
- ddp_find_unused_parameters (
bool, optional) — When using distributed training, the value of the flagfind_unused_parameterspassed toDistributedDataParallel. Will default toFalseif gradient checkpointing is used,Trueotherwise. - ddp_bucket_cap_mb (
int, optional) — When using distributed training, the value of the flagbucket_cap_mbpassed toDistributedDataParallel. - ddp_broadcast_buffers (
bool, optional) — When using distributed training, the value of the flagbroadcast_bufferspassed toDistributedDataParallel. Will default toFalseif gradient checkpointing is used,Trueotherwise. - ddp_backend (
str, optional) — The backend to use for distributed training. Must be one of"nccl","mpi","xccl","gloo","hccl". - ddp_timeout (
int, optional, defaults to 1800) — The timeout fortorch.distributed.init_process_groupcalls, used to avoid GPU socket timeouts when performing slow operations in distributed runnings. Please refer to the PyTorch documentation for more information.
FSDP (Fully Sharded Data Parallel)
- fsdp (
bool,stror list ofFSDPOption, optional, defaults toNone) — Enable PyTorch Fully Sharded Data Parallel (FSDP) for distributed training. Options:"full_shard": Shard parameters, gradients, and optimizer states (most memory efficient)"shard_grad_op": Shard only optimizer states and gradients (ZeRO-2)"hybrid_shard": Full shard within nodes, replicate across nodes"hybrid_shard_zero2": Shard gradients/optimizer within nodes, replicate across nodes"offload": Offload parameters and gradients to CPU (only with"full_shard"or"shard_grad_op")"auto_wrap": Automatically wrap layers usingdefault_auto_wrap_policy
- fsdp_config (
strordict, 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 asdict.A List of config and its options:
-
fsdp_version (
int, optional, defaults to1): The version of FSDP to use. Defaults to 1. -
min_num_params (
int, optional, defaults to0): FSDP’s minimum number of parameters for Default Auto Wrapping. (useful only whenfsdpfield 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 whenfsdpflag is passed). -
backward_prefetch (
str, optional) FSDP’s backward prefetch mode. Controls when to prefetch next set of parameters (useful only whenfsdpfield 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 toFalse) FSDP’s forward prefetch mode (useful only whenfsdpfield 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 toFalse) FSDP’s limit_all_gathers (useful only whenfsdpfield is passed). If"True", FSDP explicitly synchronizes the CPU thread to prevent too many in-flight all-gathers. -
use_orig_params (
bool, optional, defaults toTrue) If"True", allows non-uniformrequires_gradduring 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 toTrue) 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 toFalse) 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_statesalso 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 toFalse): 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 toFalse): 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.
-
xla_fsdp_grad_ckpt (
bool, optional, defaults toFalse): 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
- deepspeed (
strordict, optional) — Enable DeepSpeed integration. Value is either:- Path to DeepSpeed JSON config file:
"ds_config.json" - Loaded config as dictionary
If using ZeRO initialization, instantiate your model after initializing
TrainingArguments, otherwise ZeRO won’t be applied.
- Path to DeepSpeed JSON config file:
Debugging & Profiling (Experimental)
- debug (
stror list ofDebugOption, 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
- skip_memory_metrics (
bool, optional, defaults toTrue) — Whether to skip adding of memory profiler reports to metrics. This is skipped by default because it slows down the training and evaluation speed.
External Script Flags (not used by Trainer)
- do_train (
bool, optional, defaults toFalse) — Whether to run training or not. This argument is not directly used by Trainer, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - do_eval (
bool, optional) — Whether to run evaluation on the validation set or not. Will be set toTrueifeval_strategyis different from"no". This argument is not directly used by Trainer, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - do_predict (
bool, optional, defaults toFalse) — Whether to run predictions on the test set or not. This argument is not directly used by Trainer, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - 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, it’s intended to be used by your training/evaluation scripts instead. See the example scripts for more details. - predict_with_generate (
bool, optional, defaults toFalse) — Whether to use generate to calculate generative metrics (ROUGE, BLEU). - generation_max_length (
int, optional) — Themax_lengthto use on each evaluation loop whenpredict_with_generate=True. Will default to themax_lengthvalue of the model configuration. - generation_num_beams (
int, optional) — Thenum_beamsto use on each evaluation loop whenpredict_with_generate=True. Will default to thenum_beamsvalue of the model configuration. - generation_config (
strorPathor GenerationConfig, optional) — Allows to load a GenerationConfig from thefrom_pretrainedmethod. 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() method, e.g.,
./my_model_directory/. - a GenerationConfig object.
Configuration class for controlling all aspects of model training with the Trainer. TrainingArguments centralizes all hyperparameters, optimization settings, logging preferences, and infrastructure choices needed for training.
HfArgumentParser can turn this class into argparse arguments that can be specified on the command line.
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.