From fcb4f11c9232cee2adce8140a3a7689578ea97de Mon Sep 17 00:00:00 2001 From: Nathan Raw Date: Tue, 8 Feb 2022 14:10:53 -0500 Subject: [PATCH] :memo: Add codecarbon callback to docs (#15563) --- docs/source/main_classes/callback.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/main_classes/callback.mdx b/docs/source/main_classes/callback.mdx index 032f1b571b..1d7d0b03d2 100644 --- a/docs/source/main_classes/callback.mdx +++ b/docs/source/main_classes/callback.mdx @@ -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