From 68f70fc50a76f881cb2b4b1f6be74c0e9c8f8c2a Mon Sep 17 00:00:00 2001 From: revital Date: Mon, 21 Apr 2025 11:03:10 +0300 Subject: [PATCH 1/2] small edits --- docs/release_notes/clearml_server/open_source/ver_0_10.md | 2 +- docs/release_notes/sdk/open_source/ver_0_10.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release_notes/clearml_server/open_source/ver_0_10.md b/docs/release_notes/clearml_server/open_source/ver_0_10.md index 414ac03d..d3cbda80 100644 --- a/docs/release_notes/clearml_server/open_source/ver_0_10.md +++ b/docs/release_notes/clearml_server/open_source/ver_0_10.md @@ -15,7 +15,7 @@ title: Version 0.10 * Replace the Python web-server with NGINX. -* Improve sub-domain support ([GitHub trains-server Issue 9](https://github.com/clearml/clearml-server/issues/9)). +* Improve subdomain support ([GitHub trains-server Issue 9](https://github.com/clearml/clearml-server/issues/9)). * Extend configuration options diff --git a/docs/release_notes/sdk/open_source/ver_0_10.md b/docs/release_notes/sdk/open_source/ver_0_10.md index 2f6662ce..af644f74 100644 --- a/docs/release_notes/sdk/open_source/ver_0_10.md +++ b/docs/release_notes/sdk/open_source/ver_0_10.md @@ -68,7 +68,7 @@ title: Version 0.10 * Add scikit-learn support (load/store using joblib) ([GitHub Issue #20](https://github.com/clearml/clearml/issues/20)). * Add xgboost support ([GitHub Issue #10](https://github.com/clearml/clearml/issues/10)). * Add loguru support ([GitHub Issue #29](https://github.com/clearml/clearml/issues/29)). -* Add sub-domain support [trains.conf](https://github.com/clearml/clearml/blob/master/docs/trains.conf#L3) ([GitHub Issue #27](https://github.com/clearml/clearml/issues/27)). +* Add subdomain support [trains.conf](https://github.com/clearml/clearml/blob/master/docs/trains.conf#L3) ([GitHub Issue #27](https://github.com/clearml/clearml/issues/27)). * Fix sub-process support. * Fix multiple TensorBoard writers ([GitHub Issue #26](https://github.com/clearml/clearml/issues/26)). From 6dc455c3f96e942fe0a9f694c92724ab49a4556f Mon Sep 17 00:00:00 2001 From: revital Date: Wed, 23 Apr 2025 09:38:45 +0300 Subject: [PATCH 2/2] Small edits --- docs/clearml_data/clearml_data_sdk.md | 4 ++-- docs/clearml_data/data_management_examples/data_man_simple.md | 2 +- docs/fundamentals/models.md | 2 +- docs/guides/reporting/hyper_parameters.md | 2 +- docs/hyperdatasets/dataviews.md | 2 +- docs/model_registry.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/clearml_data/clearml_data_sdk.md b/docs/clearml_data/clearml_data_sdk.md index 8db5d204..60e39120 100644 --- a/docs/clearml_data/clearml_data_sdk.md +++ b/docs/clearml_data/clearml_data_sdk.md @@ -246,7 +246,7 @@ dataset.get_logger().report_table( title="Raw Dataset Metadata", series="Raw Dataset Metadata", csv="path/to/csv" ) -# Attach a historgram to the table +# Attach a histogram to the table dataset.get_logger().report_histogram( title="Class distribution", series="Class distribution", @@ -261,7 +261,7 @@ dataset.get_logger().report_histogram( To upload the dataset files to network storage, use [`Dataset.upload()`](../references/sdk/dataset.md#upload). -Use the `output_url` parameter to specify storage target, such as S3 / GS / Azure. For example: +Use the `output_url` parameter to specify a storage target, such as S3 / GS / Azure. For example: * A shared folder: `/mnt/share/folder` * S3: `s3://bucket/folder` * Non-AWS S3-like services (such as MinIO): `s3://host_addr:port/bucket`. **Note that port specification is required**. diff --git a/docs/clearml_data/data_management_examples/data_man_simple.md b/docs/clearml_data/data_management_examples/data_man_simple.md index 03f4fa1c..066fa909 100644 --- a/docs/clearml_data/data_management_examples/data_man_simple.md +++ b/docs/clearml_data/data_management_examples/data_man_simple.md @@ -30,7 +30,7 @@ the needed files. ``` 1. Add a folder. File addition is recursive, so it's enough to point at the folder -to captures all files and subfolders: +to capture all files and subfolders: ```bash clearml-data add --files data_samples diff --git a/docs/fundamentals/models.md b/docs/fundamentals/models.md index 16ae3546..360895d1 100644 --- a/docs/fundamentals/models.md +++ b/docs/fundamentals/models.md @@ -58,7 +58,7 @@ ClearML provides flexibility for explicitly connecting input models and experime ## WebApp Interface -In the ClearML's web UI, model information can be located through a project's Model Table or through the model's creating +In the ClearML web UI, model information can be located through a project's Model Table or through the model's creating task. Models associated with a task appear in the task's **ARTIFACTS** tab. To see further model details, including design, diff --git a/docs/guides/reporting/hyper_parameters.md b/docs/guides/reporting/hyper_parameters.md index db6fdae6..4866da26 100644 --- a/docs/guides/reporting/hyper_parameters.md +++ b/docs/guides/reporting/hyper_parameters.md @@ -48,7 +48,7 @@ flags.DEFINE_string('echo5', '5', 'Text to echo.', module_name='test') ``` -TensorFlow Definitions appear in **HYPEPARAMETERS** **>** **TF_DEFINE**. +TensorFlow Definitions appear in **HYPERPARAMETERS** **>** **TF_DEFINE**. ![image](../../img/examples_reporting_hyper_param_03.png) diff --git a/docs/hyperdatasets/dataviews.md b/docs/hyperdatasets/dataviews.md index 1f26a841..30c26675 100644 --- a/docs/hyperdatasets/dataviews.md +++ b/docs/hyperdatasets/dataviews.md @@ -380,7 +380,7 @@ list_of_frames = myDataView.to_list() ##### Frame Query for Time Interval This example demonstrates a frame query filtering for frames containing the meta key `updated` with any value between -`08:000` and `09:00` on October 20th, 2024: +`08:00` and `09:00` on October 20th, 2024: ```python # Add a frame query for frames with the meta key's value between 08:00:00 and 09:00:00 on 2024-10-20 diff --git a/docs/model_registry.md b/docs/model_registry.md index 2bb78762..d4e8d1e8 100644 --- a/docs/model_registry.md +++ b/docs/model_registry.md @@ -138,7 +138,7 @@ output_model.update_weights(weights_filename='models/model.pth') ``` ## Analyzing Models -While experimenting, you build up your model catalog. In the ClearML's web UI, model information can be located through +While experimenting, you build up your model catalog. In the ClearML web UI, model information can be located through a project's Model Table or through the model's associated task. Models associated with a task appear in the task's **ARTIFACTS** tab. To see further model details, including design,