transformers/pr_33892/en/main_classes/callback.md

# Callbacks

Callbacks are objects that can customize the behavior of the training loop in the PyTorch
[Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) that can inspect the training loop state (for progress reporting, logging on TensorBoard or other ML
platforms...) and take decisions (like early stopping).

Callbacks are "read only" pieces of code, apart from the [TrainerControl](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerControl) object they return, they
cannot change anything in the training loop. For customizations that require changes in the training loop, you should
subclass [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) and override the methods you need (see [trainer](trainer) for examples).

By default, `TrainingArguments.report_to` is set to `"all"`, so a [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) will use the following callbacks.

- [DefaultFlowCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.DefaultFlowCallback) which handles the default behavior for logging, saving and evaluation.
- [PrinterCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.PrinterCallback) or [ProgressCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.ProgressCallback) to display progress and print the
  logs (the first one is used if you deactivate tqdm through the [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments), otherwise
  it's the second one).
- [TensorBoardCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.TensorBoardCallback) if tensorboard is accessible (either through PyTorch >= 1.4
  or tensorboardX).
- [TrackioCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.TrackioCallback) if [trackio](https://github.com/gradio-app/trackio) is installed.
- [WandbCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.WandbCallback) if [wandb](https://www.wandb.com/) is installed.
- [CometCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.CometCallback) if [comet_ml](https://www.comet.com/site/) is installed.
- [MLflowCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.MLflowCallback) if [mlflow](https://www.mlflow.org/) is installed.
- [NeptuneCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.NeptuneCallback) if [neptune](https://neptune.ai/) is installed.
- [AzureMLCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.AzureMLCallback) if [azureml-sdk](https://pypi.org/project/azureml-sdk/) is
  installed.
- [CodeCarbonCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.CodeCarbonCallback) if [codecarbon](https://pypi.org/project/codecarbon/) is
  installed.
- [ClearMLCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.ClearMLCallback) if [clearml](https://github.com/allegroai/clearml) is installed.
- [DagsHubCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.DagsHubCallback) if [dagshub](https://dagshub.com/) is installed.
- [FlyteCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.FlyteCallback) if [flyte](https://flyte.org/) is installed.
- [DVCLiveCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.DVCLiveCallback) if [dvclive](https://dvc.org/doc/dvclive) is installed.
- [SwanLabCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.integrations.SwanLabCallback) if [swanlab](http://swanlab.cn/) is installed.

If a package is installed but you don't wish to use the accompanying integration, you can change `TrainingArguments.report_to` to a list of just those integrations you want to use (e.g. `["azure_ml", "wandb"]`).

The main class that implements callbacks is [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback). It gets the
[TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) used to instantiate the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer), can access that
Trainer's internal state via [TrainerState](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerState), and can take some actions on the training loop via
[TrainerControl](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerControl).

## Available Callbacks[[transformers.integrations.CometCallback]]

Here is the list of the available [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) in the library:

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


<docstring><name>class transformers.integrations.CometCallback</name><anchor>transformers.integrations.CometCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1061</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [Comet ML](https://www.comet.com/site/).



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


<docstring><name>setup</name><anchor>transformers.integrations.CometCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1075</source><parameters>[{"name": "args", "val": ""}, {"name": "state", "val": ""}, {"name": "model", "val": ""}]</parameters></docstring>

Setup the optional Comet integration.

Environment:
- **COMET_MODE** (`str`, *optional*, default to `get_or_create`):
  Control whether to create and log to a new Comet experiment or append to an existing experiment.
  It accepts the following values:
  * `get_or_create`: Decides automatically depending if
    `COMET_EXPERIMENT_KEY` is set and whether an Experiment
    with that key already exists or not.
  * `create`: Always create a new Comet Experiment.
  * `get`: Always try to append to an Existing Comet Experiment.
    Requires `COMET_EXPERIMENT_KEY` to be set.
- **COMET_START_ONLINE** (`bool`, *optional*):
  Whether to create an online or offline Experiment.
- **COMET_PROJECT_NAME** (`str`, *optional*):
  Comet project name for experiments.
- **COMET_LOG_ASSETS** (`str`, *optional*, defaults to `TRUE`):
  Whether or not to log training assets (checkpoints, etc), to Comet. Can be `TRUE`, or
  `FALSE`.

For a number of configurable items in the environment, see
[here](https://www.comet.com/docs/v2/guides/experiment-management/configure-sdk/#explore-comet-configuration-options).


</div></div>

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


<docstring><name>class transformers.DefaultFlowCallback</name><anchor>transformers.DefaultFlowCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L571</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that handles the default flow of the training loop for logs, evaluation and checkpoints.


</div>

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


<docstring><name>class transformers.PrinterCallback</name><anchor>transformers.PrinterCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L698</source><parameters>[]</parameters></docstring>

A bare [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that just prints the logs.


</div>

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


<docstring><name>class transformers.ProgressCallback</name><anchor>transformers.ProgressCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L624</source><parameters>[{"name": "max_str_len", "val": ": int = 100"}]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that displays the progress of training or evaluation.
You can modify `max_str_len` to control how long strings are truncated when logging.


</div>

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


<docstring><name>class transformers.EarlyStoppingCallback</name><anchor>transformers.EarlyStoppingCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L709</source><parameters>[{"name": "early_stopping_patience", "val": ": int = 1"}, {"name": "early_stopping_threshold", "val": ": typing.Optional[float] = 0.0"}]</parameters><paramsdesc>- **early_stopping_patience** (`int`) --
  Use with `metric_for_best_model` to stop training when the specified metric worsens for
  `early_stopping_patience` evaluation calls.
- **early_stopping_threshold(`float`,** *optional*) --
  Use with TrainingArguments `metric_for_best_model` and `early_stopping_patience` to denote how much the
  specified metric must improve to satisfy early stopping conditions. `</paramsdesc><paramgroups>0</paramgroups></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that handles early stopping.



This callback depends on [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) argument *load_best_model_at_end* functionality to set best_metric
in [TrainerState](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerState). Note that if the [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments) argument *save_steps* differs from *eval_steps*, the
early stopping will not occur until the next save step.


</div>

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


<docstring><name>class transformers.integrations.TensorBoardCallback</name><anchor>transformers.integrations.TensorBoardCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L571</source><parameters>[{"name": "tb_writer", "val": " = None"}]</parameters><paramsdesc>- **tb_writer** (`SummaryWriter`, *optional*) --
  The writer to use. Will instantiate one if not set.</paramsdesc><paramgroups>0</paramgroups></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [TensorBoard](https://www.tensorflow.org/tensorboard).



Environment:
- **TENSORBOARD_LOGGING_DIR** (`str`, *optional*, defaults to `None`):
  The logging dir to log the results. Default value is os.path.join(args.output_dir, default_logdir())


</div>

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


<docstring><name>class transformers.integrations.TrackioCallback</name><anchor>transformers.integrations.TrackioCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L929</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that logs metrics to Trackio.

It records training metrics, model (and PEFT) configuration, and GPU memory usage.
If `nvidia-ml-py` is installed, GPU power consumption is also tracked.

<ExampleCodeBlock anchor="transformers.integrations.TrackioCallback.example">

**Requires**:
```bash
pip install trackio
```

</ExampleCodeBlock>



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


<docstring><name>setup</name><anchor>transformers.integrations.TrackioCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L952</source><parameters>[{"name": "args", "val": ""}, {"name": "state", "val": ""}, {"name": "model", "val": ""}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Setup the optional Trackio integration.

To customize the setup you can also set the arguments `project`, `trackio_space_id` and `hub_private_repo` in
[TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments). Please refer to the docstring of for more details.


</div></div>

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


<docstring><name>class transformers.integrations.WandbCallback</name><anchor>transformers.integrations.WandbCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L689</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that logs metrics, media, model checkpoints to [Weight and Biases](https://www.wandb.com/).



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


<docstring><name>setup</name><anchor>transformers.integrations.WandbCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L705</source><parameters>[{"name": "args", "val": ""}, {"name": "state", "val": ""}, {"name": "model", "val": ""}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Setup the optional Weights & Biases (*wandb*) integration.

One can subclass and override this method to customize the setup if needed. Find more information
[here](https://docs.wandb.ai/guides/integrations/huggingface). You can also override the following environment
variables:

Environment:
- **WANDB_LOG_MODEL** (`str`, *optional*, defaults to `"false"`):
  Whether to log model and checkpoints during training. Can be `"end"`, `"checkpoint"` or `"false"`. If set
  to `"end"`, the model will be uploaded at the end of training. If set to `"checkpoint"`, the checkpoint
  will be uploaded every `args.save_steps` . If set to `"false"`, the model will not be uploaded. Use along
  with `load_best_model_at_end()` to upload best model.
- **WANDB_WATCH** (`str`, *optional* defaults to `"false"`):
  Can be `"gradients"`, `"all"`, `"parameters"`, or `"false"`. Set to `"all"` to log gradients and
  parameters.
- **WANDB_PROJECT** (`str`, *optional*, defaults to `"huggingface"`):
  Set this to a custom string to store results in a different project.


</div></div>

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


<docstring><name>class transformers.integrations.MLflowCallback</name><anchor>transformers.integrations.MLflowCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1214</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [MLflow](https://www.mlflow.org/). Can be disabled by setting
environment variable `DISABLE_MLFLOW_INTEGRATION = TRUE`.



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


<docstring><name>setup</name><anchor>transformers.integrations.MLflowCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1233</source><parameters>[{"name": "args", "val": ""}, {"name": "state", "val": ""}, {"name": "model", "val": ""}]</parameters></docstring>

Setup the optional MLflow integration.

Environment:
- **HF_MLFLOW_LOG_ARTIFACTS** (`str`, *optional*):
  Whether to use MLflow `.log_artifact()` facility to log artifacts. This only makes sense if logging to a
  remote server, e.g. s3 or GCS. If set to `True` or *1*, will copy each saved checkpoint on each save in
  [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments)'s `output_dir` to the local or remote artifact storage. Using it without a remote
  storage will just copy the files to your artifact location.
- **MLFLOW_TRACKING_URI** (`str`, *optional*):
  Whether to store runs at a specific path or remote server. Unset by default, which skips setting the
  tracking URI entirely.
- **MLFLOW_EXPERIMENT_NAME** (`str`, *optional*, defaults to `None`):
  Whether to use an MLflow experiment_name under which to launch the run. Default to `None` which will point
  to the `Default` experiment in MLflow. Otherwise, it is a case sensitive name of the experiment to be
  activated. If an experiment with this name does not exist, a new experiment with this name is created.
- **MLFLOW_TAGS** (`str`, *optional*):
  A string dump of a dictionary of key/value pair to be added to the MLflow run as tags. Example:
  `os.environ['MLFLOW_TAGS']='{"release.candidate": "RC1", "release.version": "2.2.0"}'`.
- **MLFLOW_NESTED_RUN** (`str`, *optional*):
  Whether to use MLflow nested runs. If set to `True` or *1*, will create a nested run inside the current
  run.
- **MLFLOW_RUN_ID** (`str`, *optional*):
  Allow to reattach to an existing run which can be useful when resuming training from a checkpoint. When
  `MLFLOW_RUN_ID` environment variable is set, `start_run` attempts to resume a run with the specified run ID
  and other parameters are ignored.
- **MLFLOW_FLATTEN_PARAMS** (`str`, *optional*, defaults to `False`):
  Whether to flatten the parameters dictionary before logging.
- **MLFLOW_MAX_LOG_PARAMS** (`int`, *optional*):
  Set the maximum number of parameters to log in the run.


</div></div>

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


<docstring><name>class transformers.integrations.AzureMLCallback</name><anchor>transformers.integrations.AzureMLCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1191</source><parameters>[{"name": "azureml_run", "val": " = None"}]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [AzureML](https://pypi.org/project/azureml-sdk/).


</div>

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


<docstring><name>class transformers.integrations.CodeCarbonCallback</name><anchor>transformers.integrations.CodeCarbonCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1728</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that tracks the CO2 emission of training.


</div>

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


<docstring><name>class transformers.integrations.NeptuneCallback</name><anchor>transformers.integrations.NeptuneCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1455</source><parameters>[{"name": "api_token", "val": ": typing.Optional[str] = None"}, {"name": "project", "val": ": typing.Optional[str] = None"}, {"name": "name", "val": ": typing.Optional[str] = None"}, {"name": "base_namespace", "val": ": str = 'finetuning'"}, {"name": "run", "val": " = None"}, {"name": "log_parameters", "val": ": bool = True"}, {"name": "log_checkpoints", "val": ": typing.Optional[str] = None"}, {"name": "**neptune_run_kwargs", "val": ""}]</parameters><paramsdesc>- **api_token** (`str`, *optional*) -- Neptune API token obtained upon registration.
  You can leave this argument out if you have saved your token to the `NEPTUNE_API_TOKEN` environment
  variable (strongly recommended). See full setup instructions in the
  [docs](https://docs.neptune.ai/setup/installation).
- **project** (`str`, *optional*) -- Name of an existing Neptune project, in the form "workspace-name/project-name".
  You can find and copy the name in Neptune from the project settings -> Properties. If None (default), the
  value of the `NEPTUNE_PROJECT` environment variable is used.
- **name** (`str`, *optional*) -- Custom name for the run.
- **base_namespace** (`str`, *optional*, defaults to "finetuning") -- In the Neptune run, the root namespace
  that will contain all of the metadata logged by the callback.
- **log_parameters** (`bool`, *optional*, defaults to `True`) --
  If True, logs all Trainer arguments and model parameters provided by the Trainer.
- **log_checkpoints** (`str`, *optional*) -- If "same", uploads checkpoints whenever they are saved by the Trainer.
  If "last", uploads only the most recently saved checkpoint. If "best", uploads the best checkpoint (among
  the ones saved by the Trainer). If `None`, does not upload checkpoints.
- **run** (`Run`, *optional*) -- Pass a Neptune run object if you want to continue logging to an existing run.
  Read more about resuming runs in the [docs](https://docs.neptune.ai/logging/to_existing_object).
- ****neptune_run_kwargs** (*optional*) --
  Additional keyword arguments to be passed directly to the
  [`neptune.init_run()`](https://docs.neptune.ai/api/neptune#init_run) function when a new run is created.</paramsdesc><paramgroups>0</paramgroups></docstring>
TrainerCallback that sends the logs to [Neptune](https://app.neptune.ai).



For instructions and examples, see the [Transformers integration
guide](https://docs.neptune.ai/integrations/transformers) in the Neptune documentation.


</div>

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


<docstring><name>class transformers.integrations.ClearMLCallback</name><anchor>transformers.integrations.ClearMLCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1762</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [ClearML](https://clear.ml/).

Environment:
- **CLEARML_PROJECT** (`str`, *optional*, defaults to `HuggingFace Transformers`):
  ClearML project name.
- **CLEARML_TASK** (`str`, *optional*, defaults to `Trainer`):
  ClearML task name.
- **CLEARML_LOG_MODEL** (`bool`, *optional*, defaults to `False`):
  Whether to log models as artifacts during training.


</div>

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


<docstring><name>class transformers.integrations.DagsHubCallback</name><anchor>transformers.integrations.DagsHubCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1395</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that logs to [DagsHub](https://dagshub.com/). Extends `MLflowCallback`



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


<docstring><name>setup</name><anchor>transformers.integrations.DagsHubCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L1409</source><parameters>[{"name": "*args", "val": ""}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Setup the DagsHub's Logging integration.

Environment:
- **HF_DAGSHUB_LOG_ARTIFACTS** (`str`, *optional*):
  Whether to save the data and model artifacts for the experiment. Default to `False`.


</div></div>

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


<docstring><name>class transformers.integrations.FlyteCallback</name><anchor>transformers.integrations.FlyteCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L2013</source><parameters>[{"name": "save_log_history", "val": ": bool = True"}, {"name": "sync_checkpoints", "val": ": bool = True"}]</parameters><paramsdesc>- **save_log_history** (`bool`, *optional*, defaults to `True`) --
  When set to True, the training logs are saved as a Flyte Deck.

- **sync_checkpoints** (`bool`, *optional*, defaults to `True`) --
  When set to True, checkpoints are synced with Flyte and can be used to resume training in the case of an
  interruption.</paramsdesc><paramgroups>0</paramgroups></docstring>
A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [Flyte](https://flyte.org/).
NOTE: This callback only works within a Flyte task.



<ExampleCodeBlock anchor="transformers.integrations.FlyteCallback.example">

Example:

```python
# Note: This example skips over some setup steps for brevity.
from flytekit import current_context, task


@task
def train_hf_transformer():
    cp = current_context().checkpoint
    trainer = Trainer(..., callbacks=[FlyteCallback()])
    output = trainer.train(resume_from_checkpoint=cp.restore())
```

</ExampleCodeBlock>


</div>

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


<docstring><name>class transformers.integrations.DVCLiveCallback</name><anchor>transformers.integrations.DVCLiveCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L2076</source><parameters>[{"name": "live", "val": ": typing.Optional[typing.Any] = None"}, {"name": "log_model", "val": ": typing.Union[typing.Literal['all'], bool, NoneType] = None"}, {"name": "**kwargs", "val": ""}]</parameters><paramsdesc>- **live** (`dvclive.Live`, *optional*, defaults to `None`) --
  Optional Live instance. If None, a new instance will be created using **kwargs.
- **log_model** (Union[Literal["all"], bool], *optional*, defaults to `None`) --
  Whether to use `dvclive.Live.log_artifact()` to log checkpoints created by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer). If set to `True`,
  the final checkpoint is logged at the end of training. If set to `"all"`, the entire
  [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments)'s `output_dir` is logged at each checkpoint.</paramsdesc><paramgroups>0</paramgroups></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that sends the logs to [DVCLive](https://www.dvc.org/doc/dvclive).

Use the environment variables below in `setup` to configure the integration. To customize this callback beyond
those environment variables, see [here](https://dvc.org/doc/dvclive/ml-frameworks/huggingface).





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


<docstring><name>setup</name><anchor>transformers.integrations.DVCLiveCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L2117</source><parameters>[{"name": "args", "val": ""}, {"name": "state", "val": ""}, {"name": "model", "val": ""}]</parameters></docstring>

Setup the optional DVCLive integration. To customize this callback beyond the environment variables below, see
[here](https://dvc.org/doc/dvclive/ml-frameworks/huggingface).

Environment:
- **HF_DVCLIVE_LOG_MODEL** (`str`, *optional*):
  Whether to use `dvclive.Live.log_artifact()` to log checkpoints created by [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer). If set to `True` or
  *1*, the final checkpoint is logged at the end of training. If set to `all`, the entire
  [TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments)'s `output_dir` is logged at each checkpoint.


</div></div>

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


<docstring><name>class transformers.integrations.SwanLabCallback</name><anchor>transformers.integrations.SwanLabCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L2181</source><parameters>[]</parameters></docstring>

A [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) that logs metrics, media, model checkpoints to [SwanLab](https://swanlab.cn/).



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


<docstring><name>setup</name><anchor>transformers.integrations.SwanLabCallback.setup</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/integrations/integration_utils.py#L2195</source><parameters>[{"name": "args", "val": ""}, {"name": "state", "val": ""}, {"name": "model", "val": ""}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Setup the optional SwanLab (*swanlab*) integration.

One can subclass and override this method to customize the setup if needed. Find more information
[here](https://docs.swanlab.cn/guide_cloud/integration/integration-huggingface-transformers.html).

You can also override the following environment variables. Find more information about environment
variables [here](https://docs.swanlab.cn/en/api/environment-variable.html#environment-variables)

Environment:
- **SWANLAB_API_KEY** (`str`, *optional*, defaults to `None`):
  Cloud API Key. During login, this environment variable is checked first. If it doesn't exist, the system
  checks if the user is already logged in. If not, the login process is initiated.

  - If a string is passed to the login interface, this environment variable is ignored.
  - If the user is already logged in, this environment variable takes precedence over locally stored
  login information.

- **SWANLAB_PROJECT** (`str`, *optional*, defaults to `None`):
  Set this to a custom string to store results in a different project. If not specified, the name of the current
  running directory is used.

- **SWANLAB_LOG_DIR** (`str`, *optional*, defaults to `swanlog`):
  This environment variable specifies the storage path for log files when running in local mode.
  By default, logs are saved in a folder named swanlog under the working directory.

- **SWANLAB_MODE** (`Literal["local", "cloud", "disabled"]`, *optional*, defaults to `cloud`):
  SwanLab's parsing mode, which involves callbacks registered by the operator. Currently, there are three modes:
  local, cloud, and disabled. Note: Case-sensitive. Find more information
  [here](https://docs.swanlab.cn/en/api/py-init.html#swanlab-init)

- **SWANLAB_LOG_MODEL** (`str`, *optional*, defaults to `None`):
  SwanLab does not currently support the save mode functionality.This feature will be available in a future
  release

- **SWANLAB_WEB_HOST** (`str`, *optional*, defaults to `None`):
  Web address for the SwanLab cloud environment for private version (its free)

- **SWANLAB_API_HOST** (`str`, *optional*, defaults to `None`):
  API address for the SwanLab cloud environment for private version (its free)



</div></div>

## TrainerCallback[[transformers.TrainerCallback]]

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


<docstring><name>class transformers.TrainerCallback</name><anchor>transformers.TrainerCallback</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L296</source><parameters>[]</parameters><paramsdesc>- **args** ([TrainingArguments](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.TrainingArguments)) --
  The training arguments used to instantiate the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer).
- **state** ([TrainerState](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerState)) --
  The current state of the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer).
- **control** ([TrainerControl](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerControl)) --
  The object that is returned to the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) and can be used to make some decisions.
- **model** ([PreTrainedModel](/docs/transformers/pr_33892/en/main_classes/model#transformers.PreTrainedModel) or `torch.nn.Module`) --
  The model being trained.
- **processing_class** ([`PreTrainedTokenizer` or `BaseImageProcessor` or `ProcessorMixin` or `FeatureExtractionMixin`]) --
  The processing class used for encoding the data. Can be a tokenizer, a processor, an image processor or a feature extractor.
- **optimizer** (`torch.optim.Optimizer`) --
  The optimizer used for the training steps.
- **lr_scheduler** (`torch.optim.lr_scheduler.LambdaLR`) --
  The scheduler used for setting the learning rate.
- **train_dataloader** (`torch.utils.data.DataLoader`, *optional*) --
  The current dataloader used for training.
- **eval_dataloader** (`torch.utils.data.DataLoader`, *optional*) --
  The current dataloader used for evaluation.
- **metrics** (`dict[str, float]`) --
  The metrics computed by the last evaluation phase.

  Those are only accessible in the event `on_evaluate`.
- **logs**  (`dict[str, float]`) --
  The values to log.

  Those are only accessible in the event `on_log`.</paramsdesc><paramgroups>0</paramgroups></docstring>

A class for objects that will inspect the state of the training loop at some events and take some decisions. At
each of those events the following arguments are available:



The `control` object is the only one that can be changed by the callback, in which case the event that changes it
should return the modified version.

The argument `args`, `state` and `control` are positionals for all events, all the others are grouped in `kwargs`.
You can unpack the ones you need in the signature of the event using them. As an example, see the code of the
simple [PrinterCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.PrinterCallback).

<ExampleCodeBlock anchor="transformers.TrainerCallback.example">

Example:

```python
class PrinterCallback(TrainerCallback):
    def on_log(self, args, state, control, logs=None, **kwargs):
        _ = logs.pop("total_flos", None)
        if state.is_local_process_zero:
            print(logs)
```

</ExampleCodeBlock>


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


<docstring><name>on_epoch_begin</name><anchor>transformers.TrainerCallback.on_epoch_begin</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L365</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the beginning of an epoch.


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


<docstring><name>on_epoch_end</name><anchor>transformers.TrainerCallback.on_epoch_end</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L371</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the end of an epoch.


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


<docstring><name>on_evaluate</name><anchor>transformers.TrainerCallback.on_evaluate</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L409</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called after an evaluation phase.


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


<docstring><name>on_init_end</name><anchor>transformers.TrainerCallback.on_init_end</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L347</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the end of the initialization of the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer).


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


<docstring><name>on_log</name><anchor>transformers.TrainerCallback.on_log</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L427</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called after logging the last logs.


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


<docstring><name>on_optimizer_step</name><anchor>transformers.TrainerCallback.on_optimizer_step</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L390</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called after the optimizer step but before gradients are zeroed out. Useful for monitoring gradients.


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


<docstring><name>on_pre_optimizer_step</name><anchor>transformers.TrainerCallback.on_pre_optimizer_step</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L384</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called before the optimizer step but after gradient clipping. Useful for monitoring gradients.


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


<docstring><name>on_predict</name><anchor>transformers.TrainerCallback.on_predict</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L415</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "metrics", "val": ""}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called after a successful prediction.


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


<docstring><name>on_prediction_step</name><anchor>transformers.TrainerCallback.on_prediction_step</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L433</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called after a prediction step.


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


<docstring><name>on_save</name><anchor>transformers.TrainerCallback.on_save</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L421</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called after a checkpoint save.


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


<docstring><name>on_step_begin</name><anchor>transformers.TrainerCallback.on_step_begin</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L377</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the beginning of a training step. If using gradient accumulation, one training step might take
several inputs.


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


<docstring><name>on_step_end</name><anchor>transformers.TrainerCallback.on_step_end</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L402</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the end of a training step. If using gradient accumulation, one training step might take
several inputs.


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


<docstring><name>on_substep_end</name><anchor>transformers.TrainerCallback.on_substep_end</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L396</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the end of an substep during gradient accumulation.


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


<docstring><name>on_train_begin</name><anchor>transformers.TrainerCallback.on_train_begin</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L353</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the beginning of training.


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


<docstring><name>on_train_end</name><anchor>transformers.TrainerCallback.on_train_end</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L359</source><parameters>[{"name": "args", "val": ": TrainingArguments"}, {"name": "state", "val": ": TrainerState"}, {"name": "control", "val": ": TrainerControl"}, {"name": "**kwargs", "val": ""}]</parameters></docstring>

Event called at the end of training.


</div></div>

Here is an example of how to register a custom callback with the PyTorch [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer):

```python
class MyCallback(TrainerCallback):
    "A callback that prints a message at the beginning of training"

    def on_train_begin(self, args, state, control, **kwargs):
        print("Starting training")


trainer = Trainer(
    model,
    args,
    train_dataset=train_dataset,
    eval_dataset=eval_dataset,
    callbacks=[MyCallback],  # We can either pass the callback class this way or an instance of it (MyCallback())
)
```

Another way to register a callback is to call `trainer.add_callback()` as follows:

```python
trainer = Trainer(...)
trainer.add_callback(MyCallback)
# Alternatively, we can pass an instance of the callback class
trainer.add_callback(MyCallback())
```

## TrainerState[[transformers.TrainerState]]

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


<docstring><name>class transformers.TrainerState</name><anchor>transformers.TrainerState</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L36</source><parameters>[{"name": "epoch", "val": ": typing.Optional[float] = None"}, {"name": "global_step", "val": ": int = 0"}, {"name": "max_steps", "val": ": int = 0"}, {"name": "logging_steps", "val": ": int = 500"}, {"name": "eval_steps", "val": ": int = 500"}, {"name": "save_steps", "val": ": int = 500"}, {"name": "train_batch_size", "val": ": typing.Optional[int] = None"}, {"name": "num_train_epochs", "val": ": int = 0"}, {"name": "num_input_tokens_seen", "val": ": int = 0"}, {"name": "total_flos", "val": ": float = 0"}, {"name": "log_history", "val": ": list = None"}, {"name": "best_metric", "val": ": typing.Optional[float] = None"}, {"name": "best_global_step", "val": ": typing.Optional[int] = None"}, {"name": "best_model_checkpoint", "val": ": typing.Optional[str] = None"}, {"name": "is_local_process_zero", "val": ": bool = True"}, {"name": "is_world_process_zero", "val": ": bool = True"}, {"name": "is_hyper_param_search", "val": ": bool = False"}, {"name": "trial_name", "val": ": typing.Optional[str] = None"}, {"name": "trial_params", "val": ": typing.Optional[dict[str, typing.Union[str, float, int, bool]]] = None"}, {"name": "stateful_callbacks", "val": ": typing.Optional[list['TrainerCallback']] = None"}]</parameters><paramsdesc>- **epoch** (`float`, *optional*) --
  Only set during training, will represent the epoch the training is at (the decimal part being the
  percentage of the current epoch completed).
- **global_step** (`int`, *optional*, defaults to 0) --
  During training, represents the number of update steps completed.
- **max_steps** (`int`, *optional*, defaults to 0) --
  The number of update steps to do during the current training.
- **logging_steps** (`int`, *optional*, defaults to 500) --
  Log every X updates steps
- **eval_steps** (`int`, *optional*) --
  Run an evaluation every X steps.
- **save_steps** (`int`, *optional*, defaults to 500) --
  Save checkpoint every X updates steps.
- **train_batch_size** (`int`, *optional*) --
  The batch size for the training dataloader. Only needed when
  `auto_find_batch_size` has been used.
- **num_input_tokens_seen** (`int`, *optional*, defaults to 0) --
  When tracking the inputs tokens, the number of tokens seen during training (number of input tokens, not the
  number of prediction tokens).
- **total_flos** (`float`, *optional*, defaults to 0) --
  The total number of floating operations done by the model since the beginning of training (stored as floats
  to avoid overflow).
- **log_history** (`list[dict[str, float]]`, *optional*) --
  The list of logs done since the beginning of training.
- **best_metric** (`float`, *optional*) --
  When tracking the best model, the value of the best metric encountered so far.
- **best_global_step** (`int`, *optional*) --
  When tracking the best model, the step at which the best metric was encountered.
  Used for setting `best_model_checkpoint`.
- **best_model_checkpoint** (`str`, *optional*) --
  When tracking the best model, the value of the name of the checkpoint for the best model encountered so
  far.
- **is_local_process_zero** (`bool`, *optional*, defaults to `True`) --
  Whether or not this process is the local (e.g., on one machine if training in a distributed fashion on
  several machines) main process.
- **is_world_process_zero** (`bool`, *optional*, defaults to `True`) --
  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).
- **is_hyper_param_search** (`bool`, *optional*, defaults to `False`) --
  Whether we are in the process of a hyper parameter search using Trainer.hyperparameter_search. This will
  impact the way data will be logged in TensorBoard.
- **stateful_callbacks** (`list[StatefulTrainerCallback]`, *optional*) --
  Callbacks attached to the `Trainer` that should have their states be saved or restored.
  Relevant callbacks should implement a `state` and `from_state` function.</paramsdesc><paramgroups>0</paramgroups></docstring>

A class containing the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) inner state that will be saved along the model and optimizer when checkpointing
and passed to the [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback).

<Tip>

In all this class, one step is to be understood as one update step. When using gradient accumulation, one update
step may require several forward and backward passes: if you use `gradient_accumulation_steps=n`, then one update
step requires going through *n* batches.

</Tip>





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


<docstring><name>compute_steps</name><anchor>transformers.TrainerState.compute_steps</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L157</source><parameters>[{"name": "args", "val": ""}, {"name": "max_steps", "val": ""}]</parameters></docstring>

Calculates and stores the absolute value for logging,
eval, and save steps based on if it was a proportion
or not.


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


<docstring><name>init_training_references</name><anchor>transformers.TrainerState.init_training_references</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L170</source><parameters>[{"name": "trainer", "val": ""}, {"name": "max_steps", "val": ""}, {"name": "num_train_epochs", "val": ""}, {"name": "trial", "val": ""}]</parameters></docstring>

Stores the initial training references needed in `self`


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


<docstring><name>load_from_json</name><anchor>transformers.TrainerState.load_from_json</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L150</source><parameters>[{"name": "json_path", "val": ": str"}]</parameters></docstring>
Create an instance from the content of `json_path`.

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


<docstring><name>save_to_json</name><anchor>transformers.TrainerState.save_to_json</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L144</source><parameters>[{"name": "json_path", "val": ": str"}]</parameters></docstring>
Save the content of this instance in JSON format inside `json_path`.

</div></div>

## TrainerControl[[transformers.TrainerControl]]

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


<docstring><name>class transformers.TrainerControl</name><anchor>transformers.TrainerControl</anchor><source>https://github.com/huggingface/transformers/blob/vr_33892/src/transformers/trainer_callback.py#L235</source><parameters>[{"name": "should_training_stop", "val": ": bool = False"}, {"name": "should_epoch_stop", "val": ": bool = False"}, {"name": "should_save", "val": ": bool = False"}, {"name": "should_evaluate", "val": ": bool = False"}, {"name": "should_log", "val": ": bool = False"}]</parameters><paramsdesc>- **should_training_stop** (`bool`, *optional*, defaults to `False`) --
  Whether or not the training should be interrupted.

  If `True`, this variable will not be set back to `False`. The training will just stop.
- **should_epoch_stop** (`bool`, *optional*, defaults to `False`) --
  Whether or not the current epoch should be interrupted.

  If `True`, this variable will be set back to `False` at the beginning of the next epoch.
- **should_save** (`bool`, *optional*, defaults to `False`) --
  Whether or not the model should be saved at this step.

  If `True`, this variable will be set back to `False` at the beginning of the next step.
- **should_evaluate** (`bool`, *optional*, defaults to `False`) --
  Whether or not the model should be evaluated at this step.

  If `True`, this variable will be set back to `False` at the beginning of the next step.
- **should_log** (`bool`, *optional*, defaults to `False`) --
  Whether or not the logs should be reported at this step.

  If `True`, this variable will be set back to `False` at the beginning of the next step.</paramsdesc><paramgroups>0</paramgroups></docstring>

A class that handles the [Trainer](/docs/transformers/pr_33892/en/main_classes/trainer#transformers.Trainer) control flow. This class is used by the [TrainerCallback](/docs/transformers/pr_33892/en/main_classes/callback#transformers.TrainerCallback) to activate some
switches in the training loop.




</div>

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