SUMIN/HuggingFace_transformer
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

Added documentation for DagsHubCallback (#21452)

Browse Source 
updated documentation
This commit is contained in:
Jinen Setpal
2023-02-06 09:24:18 -05:00
committed by GitHub
parent ae31831879
commit 5ac1c7ea85
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/source/en/main_classes/callback.mdx
View File

@@ -38,6 +38,7 @@ By default a [`Trainer`] will use the following callbacks:
- [`~integrations.CodeCarbonCallback`] if [codecarbon](https://pypi.org/project/codecarbon/) is - [`~integrations.CodeCarbonCallback`] if [codecarbon](https://pypi.org/project/codecarbon/) is
installed. installed.
- [`~integrations.ClearMLCallback`] if [clearml](https://github.com/allegroai/clearml) 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 The main class that implements callbacks is [`TrainerCallback`]. It gets the
[`TrainingArguments`] used to instantiate the [`Trainer`], can access that [`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.ClearMLCallback
[[autodoc]] integrations.DagsHubCallback
## TrainerCallback ## TrainerCallback
[[autodoc]] TrainerCallback [[autodoc]] TrainerCallback

4
src/transformers/integrations.py
View File

@@ -1053,7 +1053,7 @@ class MLflowCallback(TrainerCallback):
class DagsHubCallback(MLflowCallback): 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): def __init__(self):
@@ -1070,7 +1070,7 @@ class DagsHubCallback(MLflowCallback):
Setup the DagsHub's Logging integration. Setup the DagsHub's Logging integration.
Environment: 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`. Whether to save the data and model artifacts for the experiment. Default to `False`.
""" """