diff --git a/docs/guides/frameworks/huggingface/transformers.md b/docs/guides/frameworks/huggingface/transformers.md index a1901d04..9f37260b 100644 --- a/docs/guides/frameworks/huggingface/transformers.md +++ b/docs/guides/frameworks/huggingface/transformers.md @@ -2,9 +2,9 @@ title: Transformers --- -The [HuggingFace Transformers example](https://github.com/allegroai/clearml/blob/master/examples/frameworks/huggingface/transformers.ipynb) +The [Hugging Face Transformers example](https://github.com/allegroai/clearml/blob/master/examples/frameworks/huggingface/transformers.ipynb) demonstrates how to integrate ClearML into your Transformer's [Trainer](https://huggingface.co/docs/transformers/v4.34.1/en/main_classes/trainer) -code. The HuggingFace Trainer automatically uses the built-in [`ClearMLCallback`](https://huggingface.co/docs/transformers/v4.34.1/en/main_classes/callback#transformers.integrations.ClearMLCallback) +code. The Hugging Face Trainer automatically uses the built-in [`ClearMLCallback`](https://huggingface.co/docs/transformers/v4.34.1/en/main_classes/callback#transformers.integrations.ClearMLCallback) if the `clearml` package is already installed, to log Transformers models, parameters, scalars, and more. In the example, ClearML is installed and set up in the training environment. This way ClearML can log models, parameters, @@ -13,7 +13,7 @@ scalars, and more. When the example runs, it creates a ClearML task called `Trainer` in the `HuggingFace Transformers` project. To change the task's name or project, use the `CLEARML_PROJECT` and `CLEARML_TASK` environment variables respectively. -For more information about integrating ClearML into your Transformers code, see [HuggingFace Transformers](../../../integrations/transformers.md). +For more information about integrating ClearML into your Transformers code, see [Hugging Face Transformers](../../../integrations/transformers.md). ## WebApp diff --git a/docs/integrations/accelerate.md b/docs/integrations/accelerate.md index 3ce0dfb3..4835cd7f 100644 --- a/docs/integrations/accelerate.md +++ b/docs/integrations/accelerate.md @@ -2,7 +2,7 @@ title: Accelerate --- -HuggingFace's [Accelerate](https://huggingface.co/docs/accelerate/main/en/index) library simplifies DL model training +Hugging Face's [Accelerate](https://huggingface.co/docs/accelerate/main/en/index) library simplifies DL model training and inference. ClearML is a supported tracker in Accelerate: It automatically logs experiment environment information, such as required packages and uncommitted changes, and supports reporting scalars, parameters, debug samples, and plots. diff --git a/docs/release_notes/ver_1_1.md b/docs/release_notes/ver_1_1.md index b9b0e628..23d3def1 100644 --- a/docs/release_notes/ver_1_1.md +++ b/docs/release_notes/ver_1_1.md @@ -16,7 +16,7 @@ This release is not backwards compatible - see notes below on upgrading * Add version number of serving session task * Triton engine support for variable request (matrix) sizes * Triton support, fix `--aux-config` to support more configurations elements -* Huggingface Transformer support +* Hugging Face Transformer support * `Preprocess` class as module diff --git a/docs/release_notes/ver_1_13.md b/docs/release_notes/ver_1_13.md index 78fd5ea0..d6916c9f 100644 --- a/docs/release_notes/ver_1_13.md +++ b/docs/release_notes/ver_1_13.md @@ -71,7 +71,7 @@ title: Version 1.13 * Support ignoring `default_output_uri` on remote runs when `Task.init(output_uri=False)` was specified and the backend task data has no `output_uri` specified * Add configuration files logging [example](https://github.com/allegroai/clearml/blob/e6f1cc8a5c65f7007cf6452745d09795e776a548/examples/reporting/config_files.py) * Support raising `LoginError` when initializing -* Add HuggingFace Transformers example ([ClearML GitHub PR #1146](https://github.com/allegroai/clearml/pull/1146)) +* Add Hugging Face Transformers example ([ClearML GitHub PR #1146](https://github.com/allegroai/clearml/pull/1146)) * Improve docstrings for tag filters * Add a security policy file to the repository ([ClearML GitHub issue #1148](https://github.com/allegroai/clearml/issues/1148)) diff --git a/docs/release_notes/ver_1_2.md b/docs/release_notes/ver_1_2.md index 73166c82..3ac6eff7 100644 --- a/docs/release_notes/ver_1_2.md +++ b/docs/release_notes/ver_1_2.md @@ -7,7 +7,7 @@ title: Version 1.2 **New Features and Improvements** * Improve GPU Performance, 50%-300% improvement over vanilla Triton * Improve performance on CPU, optimize uvloop + multi-processing -* Add Huggingface Transformer example +* Add Hugging Face Transformer example * Add binary input support ([ClearML Serving PR #37](https://github.com/allegroai/clearml-serving/pull/37) ) **Bug Fix** diff --git a/docs/release_notes/ver_1_3.md b/docs/release_notes/ver_1_3.md index 1dd57991..057fa610 100644 --- a/docs/release_notes/ver_1_3.md +++ b/docs/release_notes/ver_1_3.md @@ -19,7 +19,7 @@ title: Version 1.3 **New Features and Improvements** * 20% Overall performance increase * gRPC channel configuration ([ClearML Serving GitHub issue #49](https://github.com/allegroai/clearml-serving/issues/49)) -* Huggingface Transformer example +* Hugging Face Transformer example **Bug fixes** * Fix NumPy compatibility ([ClearML Serving GitHub issue #47](https://github.com/allegroai/clearml-serving/issues/47) and [#46](https://github.com/allegroai/clearml-serving/issues/46)) diff --git a/sidebars.js b/sidebars.js index 5f6d610b..39b79d8c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -93,7 +93,7 @@ module.exports = { 'integrations/catboost', 'integrations/click', 'integrations/fastai', - {"HuggingFace": ['integrations/transformers', 'integrations/accelerate']}, + {"Hugging Face": ['integrations/transformers', 'integrations/accelerate']}, 'integrations/hydra', 'integrations/jsonargparse', 'integrations/keras', 'integrations/keras_tuner', 'integrations/langchain', @@ -201,7 +201,7 @@ module.exports = { 'guides/frameworks/autokeras/autokeras_imdb_example', 'guides/frameworks/catboost/catboost', 'guides/frameworks/fastai/fastai_with_tensorboard', - {'HuggingFace': ['guides/frameworks/huggingface/transformers']}, + {'Hugging Face': ['guides/frameworks/huggingface/transformers']}, {'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']}, 'guides/frameworks/lightgbm/lightgbm_example', 'guides/frameworks/matplotlib/matplotlib_example',