📝 Add codecarbon callback to docs (#15563)

This commit is contained in:
Nathan Raw 2022-02-08 14:10:53 -05:00 committed by GitHub
parent 077c00c0b2
commit fcb4f11c92
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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
@ -66,6 +68,8 @@ Here is the list of the available [`TrainerCallback`] in the library:
[[autodoc]] integrations.AzureMLCallback
[[autodoc]] integrations.CodeCarbonCallback
## TrainerCallback
[[autodoc]] TrainerCallback