Skip to content

Commit

Permalink
📝 Add codecarbon callback to docs (#15563)
Browse files Browse the repository at this point in the history
  • Loading branch information
nateraw authored Feb 8, 2022
1 parent 077c00c commit fcb4f11
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/main_classes/callback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ By default a [`Trainer`] will use the following callbacks:
- [`~integrations.MLflowCallback`] if [mlflow](https://www.mlflow.org/) is installed.
- [`~integrations.AzureMLCallback`] if [azureml-sdk](https://pypi.org/project/azureml-sdk/) is
installed.
- [`~integrations.CodeCarbonCallback`] if [codecarbon](https://pypi.org/project/codecarbon/) is
installed.

The main class that implements callbacks is [`TrainerCallback`]. It gets the
[`TrainingArguments`] used to instantiate the [`Trainer`], can access that
Expand Down Expand Up @@ -66,6 +68,8 @@ Here is the list of the available [`TrainerCallback`] in the library:

[[autodoc]] integrations.AzureMLCallback

[[autodoc]] integrations.CodeCarbonCallback

## TrainerCallback

[[autodoc]] TrainerCallback
Expand Down

0 comments on commit fcb4f11

Please sign in to comment.