From 586d0a736285cf5d77995b51b6cef7c3bfb951f6 Mon Sep 17 00:00:00 2001 From: revital Date: Tue, 15 Apr 2025 07:55:57 +0300 Subject: [PATCH 1/2] Small edits --- docs/webapp/settings/webapp_settings_resource_configs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/webapp/settings/webapp_settings_resource_configs.md b/docs/webapp/settings/webapp_settings_resource_configs.md index 165beae6..d87cbb28 100644 --- a/docs/webapp/settings/webapp_settings_resource_configs.md +++ b/docs/webapp/settings/webapp_settings_resource_configs.md @@ -15,7 +15,7 @@ The Resource Configuration settings page shows the [currently provisioned](#appl the defined resource pools, resource profiles, and the resource allocation architecture. ## Resource Pools -A resource pool is an aggregation of resources available for use, such as a Kubernetes cluster or a GPU superpod. +A resource pool is an aggregation of resources available for use, such as a Kubernetes cluster or a GPU SuperPOD. Administrators specify the total number of resources available in each pool. The resource policy manager ensures workload assignment up to the available number of resources. From bd06c98927955eaf1e5f4d122e01db05e5f0ca27 Mon Sep 17 00:00:00 2001 From: revital Date: Tue, 15 Apr 2025 08:24:47 +0300 Subject: [PATCH 2/2] Small edits --- docs/clearml_sdk/hpo_sdk.md | 6 +++--- docs/deploying_clearml/enterprise_deploy/k8s.md | 2 +- docs/hyperdatasets/webapp/webapp_datasets_versioning.md | 4 ++-- docs/release_notes/clearml_serving/ver_1_2.md | 2 +- docs/release_notes/sdk/open_source/ver_1_0.md | 4 ++-- docs/release_notes/sdk/open_source/ver_1_1.md | 4 ++-- docs/release_notes/sdk/open_source/ver_1_13.md | 2 +- docs/user_management/admin_vaults.md | 4 ++-- docs/webapp/settings/webapp_settings_resource_configs.md | 2 +- docs/webapp/webapp_overview.md | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/clearml_sdk/hpo_sdk.md b/docs/clearml_sdk/hpo_sdk.md index 6f5e7c2b..41e51664 100644 --- a/docs/clearml_sdk/hpo_sdk.md +++ b/docs/clearml_sdk/hpo_sdk.md @@ -49,11 +49,11 @@ optimization. documentation. * **BOHB** - [`automation.hpbandster.OptimizerBOHB`](../references/sdk/hpo_hpbandster_bandster_optimizerbohb.md). BOHB performs robust and efficient hyperparameter optimization at scale by combining the speed of Hyperband searches with the guidance and guarantees of convergence of Bayesian Optimization. - For more information about HpBandSter BOHB, see the [HpBandSter](../https://automl.github.io/HpBandSter/build/html/index.html) + For more information about HpBandSter BOHB, see the [HpBandSter](https://automl.github.io/HpBandSter/build/html/index.html) documentation and a [code example](../guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md). * **Random** uniform sampling of hyperparameters - [`automation.RandomSearch`](../references/sdk/hpo_optimization_randomsearch.md). * **Full grid** sampling strategy of every hyperparameter combination - [`automation.GridSearch`](../references/sdk/hpo_optimization_gridsearch.md). -* **Custom** - [`automation.optimization.SearchStrategy`](../https://github.com/clearml/clearml/blob/master/clearml/automation/optimization.py#L268) - Use a custom class and inherit from the ClearML automation base strategy class. +* **Custom** - [`automation.optimization.SearchStrategy`](https://github.com/clearml/clearml/blob/master/clearml/automation/optimization.py#L295) - Use a custom class and inherit from the ClearML automation base strategy class. ## Defining a Hyperparameter Optimization Search Example @@ -131,7 +131,7 @@ optimization. ## Optimizer Execution Options The `HyperParameterOptimizer` provides options to launch the optimization tasks locally or through a ClearML [queue](../fundamentals/agents_and_queues.md#what-is-a-queue). Start a `HyperParameterOptimizer` instance using either [`HyperParameterOptimizer.start()`](../references/sdk/hpo_optimization_hyperparameteroptimizer.md#start) -or [`HyperParameterOptimizer.start_locally()`](references/sdk/hpo_optimization_hyperparameteroptimizer.md#start_locally). +or [`HyperParameterOptimizer.start_locally()`](../references/sdk/hpo_optimization_hyperparameteroptimizer.md#start_locally). Both methods run the optimizer controller locally. `start()` launches the base task clones through a queue specified when instantiating the controller, while `start_locally()` runs the tasks locally. diff --git a/docs/deploying_clearml/enterprise_deploy/k8s.md b/docs/deploying_clearml/enterprise_deploy/k8s.md index e237919b..67127b24 100644 --- a/docs/deploying_clearml/enterprise_deploy/k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/k8s.md @@ -127,7 +127,7 @@ clearmlApplications: ``` -The credentials specified in `` and `` can be used to login as the +The credentials specified in `` and `` can be used to log in as the supervisor user from the ClearML Web UI accessible using the URL `app.`. diff --git a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md index c8cd0441..6e7e2068 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md @@ -402,7 +402,7 @@ appear in a tooltip and its usage percentage will appear at the center of the ch ![Version label statistics](../../img/hyperdatasets/dataset_version_statistics.png#light-mode-only) ![Version label statistics](../../img/hyperdatasets/dataset_version_statistics_dark.png#dark-mode-only) -## Metadata +## Metadata The **Metadata** tab presents any additional metadata that has been attached to the dataset version. **To edit a version's metadata,** @@ -414,7 +414,7 @@ The **Metadata** tab presents any additional metadata that has been attached to ![Version metadata](../../img/hyperdatasets/dataset_version_metadata.png#light-mode-only) ![Version metadata](../../img/hyperdatasets/dataset_version_metadata_dark.png#dark-mode-only) -## Info +## Info The **Info** tab presents a version's general information: * Version ID diff --git a/docs/release_notes/clearml_serving/ver_1_2.md b/docs/release_notes/clearml_serving/ver_1_2.md index 2390462d..c4913a48 100644 --- a/docs/release_notes/clearml_serving/ver_1_2.md +++ b/docs/release_notes/clearml_serving/ver_1_2.md @@ -6,7 +6,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 +* Improve performance on CPU, optimize uvloop + multiprocessing * Add Hugging Face Transformer example * Add binary input support ([ClearML Serving PR #37](https://github.com/clearml/clearml-serving/pull/37) ) diff --git a/docs/release_notes/sdk/open_source/ver_1_0.md b/docs/release_notes/sdk/open_source/ver_1_0.md index e2f9ef68..4ca9685d 100644 --- a/docs/release_notes/sdk/open_source/ver_1_0.md +++ b/docs/release_notes/sdk/open_source/ver_1_0.md @@ -48,11 +48,11 @@ title: Version 1.0 - Fix `default_output_uri` for Dataset creation ([ClearML GitHub issue 371](https://github.com/clearml/clearml/issues/371)) - Fix `clearml-task` failing without a docker script ([ClearML GitHub issue 378](https://github.com/clearml/clearml/issues/378)) -- Fix PyTorch DDP sub-process spawn multi-process +- Fix PyTorch DDP sub-process spawn multiprocess - Fix `Task.execute_remotely()` on created Task (not initialized Task) - Fix auto scaler custom bash script should be called last before starting agent - Fix auto scaler spins too many instances at once then kills the idle ones (spin time is longer than poll time) -- Fix multi-process spawn context using `ProcessFork` kills sub-process before parent process ends +- Fix multiprocess spawn context using `ProcessFork` kills sub-process before parent process ends ### ClearML 1.0.3 diff --git a/docs/release_notes/sdk/open_source/ver_1_1.md b/docs/release_notes/sdk/open_source/ver_1_1.md index 16bcc190..d4e28cc9 100644 --- a/docs/release_notes/sdk/open_source/ver_1_1.md +++ b/docs/release_notes/sdk/open_source/ver_1_1.md @@ -74,7 +74,7 @@ title: Version 1.1 * Fix `matplotlib` auto-magic detect bar graph series name ([ClearML GitHub issue #518](https://github.com/clearml/clearml/issues/518)) * Fix path limitation on storage services (posix, object storage) when storing target artifacts by limiting length of project name (full path) and task name used for object path ([ClearML GitHub issue #516](https://github.com/clearml/clearml/issues/516)) -* Fix multi-processing context block catching exception +* Fix multiprocessing context block catching exception * Fix Google Cloud Storage with no default project causes a crash * Fix main process's reporting subprocess lost, switch back to thread mode * Fix forked `StorageHelper` should use its own `ThreadExecuter` @@ -239,7 +239,7 @@ title: Version 1.1 - Fix Python2 compatibility - Fix *clearml-task* exit with error when failing to verify `output_uri` (output warning instead) - Fix unsafe Google Storage delete object -- Fix multi-process spawning wait-for-uploads can create a deadlock in very rare cases +- Fix multiprocess spawning wait-for-uploads can create a deadlock in very rare cases - Fix `task.set_parent()` fails when passing Task object - Fix `PipelineController` skipping queued Tasks - Remove `humanfriendly` dependency (unused) diff --git a/docs/release_notes/sdk/open_source/ver_1_13.md b/docs/release_notes/sdk/open_source/ver_1_13.md index 0994ff93..946f9862 100644 --- a/docs/release_notes/sdk/open_source/ver_1_13.md +++ b/docs/release_notes/sdk/open_source/ver_1_13.md @@ -49,7 +49,7 @@ title: Version 1.13 **New Features** * Add support for recursive list, dict, and tuple ref parsing for `PipelineController.add step()` parameter overrides ([ClearML GitHub issue #1089](https://github.com/clearml/clearml/issues/1089)) * Update PyNVML to the latest NVIDIA version for better GPU monitoring -* Add `force_single_script_file` argument to `Task.create()` to avoid git repository auto detection +* Add `force_single_script_file` argument to `Task.create()` to avoid git repository auto-detection * Use `os.register_at_fork` instead of monkey patching fork for `python>3.6` * Add support to programmatically archive and unarchive models from the model registry using the `Model.archive()` and `Model.unarchive()` methods ([ClearML GitHub issue #1096](https://github.com/clearml/clearml/issues/1096)) diff --git a/docs/user_management/admin_vaults.md b/docs/user_management/admin_vaults.md index 3e80e349..a1c98cf7 100644 --- a/docs/user_management/admin_vaults.md +++ b/docs/user_management/admin_vaults.md @@ -26,7 +26,7 @@ Manage administrator vaults in ClearML UI, under **SETTINGS \> Administrator Vau * **Create** vaults * **Edit** vault contents. -For more information see [Administrator Vaults](../webapp/settings/webapp_settings_admin_vaults) settings page. +For more information see [Administrator Vaults](../webapp/settings/webapp_settings_admin_vaults.md) settings page. ## Managing Vaults via the REST API @@ -116,7 +116,7 @@ curl -s -XPUT $CLEARML_SERVER/users.add_or_update_vault \ ``` In the example above, the group ID `"30795571-a470-4717-a80d-e8705fc776bf"` refers to the Users group (to which all users -belong). You can define other groups in the [Users & Groups](../webapp/settings/webapp_settings_users#user-groups) +belong). You can define other groups in the [Users & Groups](../webapp/settings/webapp_settings_users.md#user-groups) settings page and create vaults for these specific groups. The command returns the ID of the newly created vault. For example: diff --git a/docs/webapp/settings/webapp_settings_resource_configs.md b/docs/webapp/settings/webapp_settings_resource_configs.md index d87cbb28..14e09ae6 100644 --- a/docs/webapp/settings/webapp_settings_resource_configs.md +++ b/docs/webapp/settings/webapp_settings_resource_configs.md @@ -148,7 +148,7 @@ resources from the H100 pool. All available resources having been assigned - 2 jobs of each team will remain pending until some of the currently running jobs finish and resources become available. -## Applying Resource Configuration +## Applying Resource Configuration Administrators can globally activate/deactivate resource policy management. To enable the currently provisioned configuration, click on the `Enable resource management` toggle. Enabling resource management will service the policy queues according to the provisioned resource profile and pool assignments. Disabling the resource management will stop diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 025774a8..ed41e7c0 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -89,7 +89,7 @@ and [datasets](datasets/webapp_dataset_page.md)) provide column filters to easil Click the help menu button Help menu in the top right corner of the web UI screen to access the self-help resources including: * ClearML Python Package setup - Instruction to get started with the `clearml` Python package -* [ClearML on YouTube](https://www.youtube.com/c/ClearML/featured) Youtube - Instructional videos on integrating ClearML into your workflow +* [ClearML on YouTube](https://www.youtube.com/c/ClearML/featured) YouTube - Instructional videos on integrating ClearML into your workflow * Online Documentation * Pro Tips - Tips for working with ClearML efficiently * [Contact Us](https://clear.ml/contact-us) - Quick access to ClearML contact form