ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-19 22:07:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Transformers integration (#1071)
Some checks are pending
CI / build (push) Waiting to run
Details

Browse Source
This commit is contained in:
pollfly 2025-03-10 15:00:31 +02:00 committed by GitHub
parent 42b9807b72
commit d19a70b263
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/integrations/integrations.md
View File

@ -8,6 +8,7 @@ ClearML seamlessly integrates with a wide range of popular machine learning fram
* [Keras](keras.md) * [Keras](keras.md)
* [YOLO v5](yolov5.md) * [YOLO v5](yolov5.md)
* [YOLO v8](yolov8.md) * [YOLO v8](yolov8.md)
* [Hugging Face Transformers](transformers.md)
* [MMEngine](mmengine.md) * [MMEngine](mmengine.md)
* [MMCV](mmcv.md) * [MMCV](mmcv.md)
* [MONAI](monai.md) * [MONAI](monai.md)

25
docs/integrations/transformers.md
View File

@ -77,16 +77,29 @@ cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents:
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)
Use ClearML's web interface to edit task details, like configuration parameters or input models, then execute the task Use ClearML's web interface to reproduce tasks and edit their details, like hyperparameters or input models, then execute the tasks
with the new configuration on a remote machine: with the new configuration on a remote machine.
* Clone the task
* Edit the hyperparameters and/or other details When ClearML is integrated into a script, it captures and stores configurations, such as hyperparameters
* Enqueue the task and model settings. When executing a task, the ClearML Agent will, by default, override runtime configuration values
(such as hyperparameters and environment variables) with the values specified in the task.
However, for tasks using Transformers, the default behavior is different. By default, Transformers tasks ignore UI
overrides and use execution-time parameters (such as environment variables). This is done to prevent potential issues
with environment-specific settings when running tasks on different machines.
**To rerun a task with modified configuration:**
1. Clone the task
1. Edit the hyperparameters and/or other details.
1. In the **CONFIGURATION > HYPERPARAMETERS > Transformers** section, set both `_ignore_hparams_ui_overrides_` and `_ignore_model_config_ui_overrides_`
to `False` . This allows the task to use the new hyperparameter and model
configuration values respectively during execution.
1. Enqueue the task
The ClearML Agent executing the task will use the new values to [override any hard coded values](../clearml_agent.md). The ClearML Agent executing the task will use the new values to [override any hard coded values](../clearml_agent.md).