From 8af117876e52d77af6981ed09869acb8764e5a32 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 7 Sep 2022 13:18:40 +0300 Subject: [PATCH] Small edits (#325) --- docs/apps/clearml_param_search.md | 2 +- docs/getting_started/architecture.md | 11 ++++++----- docs/getting_started/mlops/mlops_second_steps.md | 2 +- docs/release_notes/ver_1_1.md | 2 +- docs/release_notes/ver_1_6.md | 2 +- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/apps/clearml_param_search.md b/docs/apps/clearml_param_search.md index e107cac4..7e833bc3 100644 --- a/docs/apps/clearml_param_search.md +++ b/docs/apps/clearml_param_search.md @@ -25,7 +25,7 @@ of the optimization results in table and graph forms. |Name | Description| Optional | |---|----|---| |`--project-name`|Name of the project in which the optimization task will be created. If the project does not exist, it is created. If unspecified, the repository name is used.|Yes| -|`--task-name`|The name of optimization task. If unspecified, the base Python script's file name is used.|Yes| +|`--task-name`|Name of the optimization task. If unspecified, the base Python script's file name is used.|Yes| |`--task-id`|ID of an existing ClearML task whose hyperparameters will be optimized. Required unless `--script` is specified.|Yes| |`--script`|Script to run the parameter search on. Required unless `--task-id` is specified.|Yes| |`--queue`|Queue to enqueue the experiments on.|Yes| diff --git a/docs/getting_started/architecture.md b/docs/getting_started/architecture.md index 66b1886a..685ebc9c 100644 --- a/docs/getting_started/architecture.md +++ b/docs/getting_started/architecture.md @@ -2,11 +2,12 @@ title: ClearML Modules --- -- **ClearML Python Package** (clearml) for integrating ClearML into your existing code-base. -- **ClearML Server** (clearml-server) storing experiment, model, and workflow data, and supporting the Web UI experiment manager. It is also the control plane for the MLOps. -- **ClearML Agent** (clearml-agent) The MLOps orchestration agent. Enabling experiment and workflow reproducibility, and scalability. -- **ClearML Data** (clearml-data) data management and versioning on top of file-systems/object-storage. -- **ClearML Session** (clearml-session) Launch remote instances of Jupyter Notebooks and VSCode. +- [**ClearML Python Package**](../getting_started/ds/ds_first_steps.md#install-clearml) (`clearml`) for integrating ClearML into your existing code-base. +- [**ClearML Server**](../deploying_clearml/clearml_server.md) (`clearml-server`) for storing experiment, model, and workflow data, and supporting the Web UI experiment manager. It is also the control plane for the MLOps. +- [**ClearML Agent**](../clearml_agent.md) (`clearml-agent`), the MLOps orchestration agent. Enabling experiment and workflow reproducibility, and scalability. +- [**ClearML Data**](../clearml_data/clearml_data.md) (`clearml-data`) data management and versioning on top of file-systems/object-storage. +- [**ClearML Serving**](../clearml_serving/clearml_serving.md) (`clearml-serving`) for model deployment and orchestration. +- [**ClearML Session**](../apps/clearml_session.md) (`clearml-session`) for launching remote instances of Jupyter Notebooks and VSCode. Solutions combined with the clearml-server control plane. ![clearml architecture](../img/clearml_architecture.png) diff --git a/docs/getting_started/mlops/mlops_second_steps.md b/docs/getting_started/mlops/mlops_second_steps.md index ad53d2d6..0c52c36c 100644 --- a/docs/getting_started/mlops/mlops_second_steps.md +++ b/docs/getting_started/mlops/mlops_second_steps.md @@ -61,7 +61,7 @@ new_dataset.tags = ['latest'] We passed the `parents` argument when we created v2 of the Dataset, which inherits all the parent's version content. This not only helps trace back dataset changes with full genealogy, but also makes our storage more efficient, -since it only store the changed and / or added files from the parent versions. +since it only stores the changed and / or added files from the parent versions. When we access the Dataset, it automatically merges the files from all parent versions in a fully automatic and transparent process, as if the files were always part of the requested Dataset. diff --git a/docs/release_notes/ver_1_1.md b/docs/release_notes/ver_1_1.md index ade50fc1..06ab5767 100644 --- a/docs/release_notes/ver_1_1.md +++ b/docs/release_notes/ver_1_1.md @@ -119,7 +119,7 @@ clearml-serving module --id add --preprocess /path/to/prepr **Bug Fixes** * Fix `TriggerScheduler` on Dataset change [ClearML GitHub issue #491](https://github.com/allegroai/clearml/issues/491) * Fix links in Jupyter Notebooks [ClearML GitHub issue #505](https://github.com/allegroai/clearml/issues/505) -* Fix `pandas` delta datetime conversion [ClearML GitHub issue #510](https://github.com/allegroai/clearml/issues/#510) +* Fix `pandas` delta datetime conversion [ClearML GitHub issue #510](https://github.com/allegroai/clearml/issues/510) * Fix `matplotlib` auto-magic detect bar graph series name [ClearML GitHub issue #518](https://github.com/allegroai/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/allegroai/clearml/issues/516) diff --git a/docs/release_notes/ver_1_6.md b/docs/release_notes/ver_1_6.md index 0082b3a9..9c03fcf9 100644 --- a/docs/release_notes/ver_1_6.md +++ b/docs/release_notes/ver_1_6.md @@ -26,7 +26,7 @@ title: Version 1.6 **Bug Fixes** * Fix dataset download [ClearML GitHub issue #713](https://github.com/allegroai/clearml/issues/713) -* Fix lock is not released after dataset cache is downloaded [ClearML GitHub issue #671](https://github.com/allegroai/clearml/issues/708) +* Fix lock is not released after dataset cache is downloaded [ClearML GitHub issue #671](https://github.com/allegroai/clearml/issues/671) * Fix deadlock might occur when using process pool large number processes [ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674) * Fix 'series' not appearing on UI when using `logger.report_table()` [ClearML GitHub issue #684](https://github.com/allegroai/clearml/issues/684) * Fix `Task.init()` docstring to include behavior when executing remotely [ClearML GitHub PR #737](https://github.com/allegroai/clearml/pull/737)