From 5ac1c7ea855e0f2d80e6ec531e4f3445710c17ba Mon Sep 17 00:00:00 2001 From: Jinen Setpal Date: Mon, 6 Feb 2023 09:24:18 -0500 Subject: [PATCH] Added documentation for DagsHubCallback (#21452) updated documentation --- docs/source/en/main_classes/callback.mdx | 3 +++ src/transformers/integrations.py | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/en/main_classes/callback.mdx b/docs/source/en/main_classes/callback.mdx index f591f80d25..33ae17c66d 100644 --- a/docs/source/en/main_classes/callback.mdx +++ b/docs/source/en/main_classes/callback.mdx @@ -38,6 +38,7 @@ By default a [`Trainer`] will use the following callbacks: - [`~integrations.CodeCarbonCallback`] if [codecarbon](https://pypi.org/project/codecarbon/) is installed. - [`~integrations.ClearMLCallback`] if [clearml](https://github.com/allegroai/clearml) is installed. +- [`~integrations.DagsHubCallback`] if [dagshub](https://dagshub.com/) is installed. The main class that implements callbacks is [`TrainerCallback`]. It gets the [`TrainingArguments`] used to instantiate the [`Trainer`], can access that @@ -76,6 +77,8 @@ Here is the list of the available [`TrainerCallback`] in the library: [[autodoc]] integrations.ClearMLCallback +[[autodoc]] integrations.DagsHubCallback + ## TrainerCallback [[autodoc]] TrainerCallback diff --git a/src/transformers/integrations.py b/src/transformers/integrations.py index 0c67b299dd..f1fa04d193 100644 --- a/src/transformers/integrations.py +++ b/src/transformers/integrations.py @@ -1053,7 +1053,7 @@ class MLflowCallback(TrainerCallback): class DagsHubCallback(MLflowCallback): """ - A [`TrainerCallback`] that logs to [DagsHub](https://dagshub.com/). + A [`TrainerCallback`] that logs to [DagsHub](https://dagshub.com/). Extends [`MLflowCallback`] """ def __init__(self): @@ -1070,7 +1070,7 @@ class DagsHubCallback(MLflowCallback): Setup the DagsHub's Logging integration. Environment: - HF_DAGSHUB_LOG_ARTIFACTS (`str`, *optional*): + - **HF_DAGSHUB_LOG_ARTIFACTS** (`str`, *optional*): Whether to save the data and model artifacts for the experiment. Default to `False`. """