Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
chenpangpang
transformers
Commits
5ac1c7ea
Unverified
Commit
5ac1c7ea
authored
Feb 06, 2023
by
Jinen Setpal
Committed by
GitHub
Feb 06, 2023
Browse files
Added documentation for DagsHubCallback (#21452)
updated documentation
parent
ae318318
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
5 additions
and
2 deletions
+5
-2
docs/source/en/main_classes/callback.mdx
docs/source/en/main_classes/callback.mdx
+3
-0
src/transformers/integrations.py
src/transformers/integrations.py
+2
-2
No files found.
docs/source/en/main_classes/callback.mdx
View file @
5ac1c7ea
...
@@ -38,6 +38,7 @@ By default a [`Trainer`] will use the following callbacks:
...
@@ -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:
...
@@ -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
...
...
src/transformers/integrations.py
View file @
5ac1c7ea
...
@@ -1053,7 +1053,7 @@ class MLflowCallback(TrainerCallback):
...
@@ -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):
...
@@ -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`.
"""
"""
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment