From a8be5b50c8baf62798956ee99802845d676ea8e3 Mon Sep 17 00:00:00 2001
From: pollfly <75068813+pollfly@users.noreply.github.com>
Date: Sun, 15 Oct 2023 10:59:07 +0300
Subject: [PATCH] Small edits (#691)
---
docs/clearml_sdk/model_sdk.md | 2 +-
docs/clearml_sdk/task_sdk.md | 2 +-
docs/faq.md | 1 -
docs/guides/frameworks/catboost/catboost.md | 3 +--
docs/guides/frameworks/lightgbm/lightgbm_example.md | 2 +-
.../pytorch/pytorch_distributed_example.md | 6 ++++--
.../pytorch_ignite/pytorch_ignite_mnist.md | 12 ++++++++----
.../frameworks/tensorflow/integration_keras_tuner.md | 3 ++-
.../examples_hyperparam_opt.md | 7 +++----
docs/guides/reporting/html_reporting.md | 1 -
docs/guides/reporting/hyper_parameters.md | 1 -
docs/hyperdatasets/single_frames.md | 1 -
docs/hyperdatasets/webapp/webapp_dataviews.md | 2 +-
docs/webapp/applications/apps_overview.md | 2 +-
docs/webapp/pipelines/webapp_pipeline_table.md | 2 +-
docs/webapp/webapp_exp_table.md | 2 +-
docs/webapp/webapp_exp_track_visual.md | 2 +-
docs/webapp/webapp_model_table.md | 2 +-
18 files changed, 27 insertions(+), 26 deletions(-)
diff --git a/docs/clearml_sdk/model_sdk.md b/docs/clearml_sdk/model_sdk.md
index 119cff36..28558e12 100644
--- a/docs/clearml_sdk/model_sdk.md
+++ b/docs/clearml_sdk/model_sdk.md
@@ -171,7 +171,7 @@ The default operator for a query is `or`, unless `and` is placed at the beginnin
```
* The following query will return models that have either tag `a` or tag `b` and both tag `c` and tag `d`
- (`("a" OR "b") AND "c" AND "d"` ).
+ (`("a" OR "b") AND "c" AND "d"`).
```python
model_list = Model.query_models(
tags=["__$and", "__$or", "a", "b", "__$and", "c", "d"]
diff --git a/docs/clearml_sdk/task_sdk.md b/docs/clearml_sdk/task_sdk.md
index 073f0cfa..aa70f18e 100644
--- a/docs/clearml_sdk/task_sdk.md
+++ b/docs/clearml_sdk/task_sdk.md
@@ -333,7 +333,7 @@ The default operator for a query is `or`, unless `and` is placed at the beginnin
```
* The following query will return tasks that have either tag `a` or tag `b` and both tag `c` and tag `d`
- (`("a" OR "b") AND "c" AND "d"` ).
+ (`("a" OR "b") AND "c" AND "d"`).
```python
task_list = Task.get_tasks(
tags=["__$and", "__$or", "a", "b", "__$and", "c", "d"]
diff --git a/docs/faq.md b/docs/faq.md
index 4183791f..d5426426 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -642,7 +642,6 @@ logger.report_scatter2d(
xaxis="title x",
yaxis="title y"
)
-
```
## GIT and Storage
diff --git a/docs/guides/frameworks/catboost/catboost.md b/docs/guides/frameworks/catboost/catboost.md
index d9f0f3f2..c36b8e99 100644
--- a/docs/guides/frameworks/catboost/catboost.md
+++ b/docs/guides/frameworks/catboost/catboost.md
@@ -18,8 +18,7 @@ ClearML automatically captures scalars logged by CatBoost. These scalars can be

## Hyperparameters
-ClearML automatically logs command line options defined with argparse. They appear in **CONFIGURATIONS > HYPER
-PARAMETERS > Args**.
+ClearML automatically logs command line options defined with argparse. They appear in **CONFIGURATIONS > HYPERPARAMETERS > Args**.

diff --git a/docs/guides/frameworks/lightgbm/lightgbm_example.md b/docs/guides/frameworks/lightgbm/lightgbm_example.md
index f25abd11..d5effb11 100644
--- a/docs/guides/frameworks/lightgbm/lightgbm_example.md
+++ b/docs/guides/frameworks/lightgbm/lightgbm_example.md
@@ -13,7 +13,7 @@ The example script does the following:
## Scalars
-The scalars logged in the experiment can be visualized in a plot, which appears in the ClearML web UI, in the **experiment's page > SCALARS**.
+The scalars logged in the experiment can be visualized in a plot, which appears in the ClearML web UI, in the experiment's **SCALARS** tab.

diff --git a/docs/guides/frameworks/pytorch/pytorch_distributed_example.md b/docs/guides/frameworks/pytorch/pytorch_distributed_example.md
index 459a4d3c..2bffd3d8 100644
--- a/docs/guides/frameworks/pytorch/pytorch_distributed_example.md
+++ b/docs/guides/frameworks/pytorch/pytorch_distributed_example.md
@@ -28,7 +28,8 @@ on `Task.current_task` (the main Task). The dictionary contains the `dist.rank`
```python
Task.current_task().upload_artifact(
- 'temp {:02d}'.format(dist.get_rank()), artifact_object={'worker_rank': dist.get_rank()})
+ 'temp {:02d}'.format(dist.get_rank()), artifact_object={'worker_rank': dist.get_rank()}
+)
```
All of these artifacts appear in the main Task, **ARTIFACTS** **>** **OTHER**.
@@ -43,7 +44,8 @@ same title (`loss`), but a different series name (containing the subprocess' `ra
```python
Task.current_task().get_logger().report_scalar(
- 'loss', 'worker {:02d}'.format(dist.get_rank()), value=loss.item(), iteration=i)
+ 'loss', 'worker {:02d}'.format(dist.get_rank()), value=loss.item(), iteration=i
+)
```
The single scalar plot for loss appears in **SCALARS**.
diff --git a/docs/guides/frameworks/pytorch_ignite/pytorch_ignite_mnist.md b/docs/guides/frameworks/pytorch_ignite/pytorch_ignite_mnist.md
index d2194771..e5656421 100644
--- a/docs/guides/frameworks/pytorch_ignite/pytorch_ignite_mnist.md
+++ b/docs/guides/frameworks/pytorch_ignite/pytorch_ignite_mnist.md
@@ -70,25 +70,29 @@ clearml_logger.attach(
* Log metrics for training:
```python
-clearml_logger.attach(train_evaluator,
+clearml_logger.attach(
+ train_evaluator,
log_handler=OutputHandler(
tag="training",
metric_names=["nll", "accuracy"],
global_step_transform=global_step_from_engine(trainer)
),
- event_name=Events.EPOCH_COMPLETED)
+ event_name=Events.EPOCH_COMPLETED
+)
```
* Log metrics for validation:
```python
-clearml_logger.attach(evaluator,
+clearml_logger.attach(
+ evaluator,
log_handler=OutputHandler(
tag="validation",
metric_names=["nll", "accuracy"],
global_step_transform=global_step_from_engine(trainer)
),
- event_name=Events.EPOCH_COMPLETED)
+ event_name=Events.EPOCH_COMPLETED
+)
```
To log optimizer parameters, use the `attach_opt_params_handler` method:
diff --git a/docs/guides/frameworks/tensorflow/integration_keras_tuner.md b/docs/guides/frameworks/tensorflow/integration_keras_tuner.md
index 568255d0..3da98a6c 100644
--- a/docs/guides/frameworks/tensorflow/integration_keras_tuner.md
+++ b/docs/guides/frameworks/tensorflow/integration_keras_tuner.md
@@ -29,7 +29,8 @@ tuner = kt.Hyperband(
logger=ClearMLTunerLogger(),
objective='val_accuracy',
max_epochs=10,
- hyperband_iterations=6)
+ hyperband_iterations=6
+)
```
When the script runs, it logs:
diff --git a/docs/guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt.md b/docs/guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt.md
index 375627c8..6f9c994f 100644
--- a/docs/guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt.md
+++ b/docs/guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt.md
@@ -23,7 +23,7 @@ The following search strategies can be used:
documentation.
* Random uniform sampling of hyperparameter strategy - [automation.RandomSearch](../../../references/sdk/hpo_optimization_randomsearch.md)
-* Full grid sampling strategy of every hyperparameter combination - Grid search [automation.GridSearch](../../../references/sdk/hpo_optimization_gridsearch.md).
+* Full grid sampling strategy of every hyperparameter combination - [automation.GridSearch](../../../references/sdk/hpo_optimization_gridsearch.md).
* Custom - Use a custom class and inherit from the ClearML automation base strategy class, automation.optimization.SearchStrategy.
The search strategy class that is chosen will be passed to the [automation.HyperParameterOptimizer](../../../references/sdk/hpo_optimization_hyperparameteroptimizer.md)
@@ -73,8 +73,8 @@ can be [reproduced](../../../webapp/webapp_exp_reproducing.md) and [tuned](../..
Set the Task type to `optimizer`, and create a new experiment (and Task object) each time the optimizer runs (`reuse_last_task_id=False`).
-When the code runs, it creates an experiment named **Automatic Hyper-Parameter Optimization** that is associated with
-the project **Hyper-Parameter Optimization**, which can be seen in the **ClearML Web UI**.
+When the code runs, it creates an experiment named **Automatic Hyper-Parameter Optimization** in
+the **Hyper-Parameter Optimization** project, which can be seen in the **ClearML Web UI**.
```python
# Connecting CLEARML
@@ -174,7 +174,6 @@ Specify the remaining parameters, including the time limit per Task (minutes), p
max_iteration_per_job=30,
) # done creating HyperParameterOptimizer
-
```
## Running as a Service
diff --git a/docs/guides/reporting/html_reporting.md b/docs/guides/reporting/html_reporting.md
index 52941d9a..1d58eb3f 100644
--- a/docs/guides/reporting/html_reporting.md
+++ b/docs/guides/reporting/html_reporting.md
@@ -56,7 +56,6 @@ Logger.current_logger().report_media(
iteration=iteration,
local_path="bar_pandas_groupby_nested.html",
)
-
```
### Bokeh Graph HTML
diff --git a/docs/guides/reporting/hyper_parameters.md b/docs/guides/reporting/hyper_parameters.md
index ba8deca0..532dc4f3 100644
--- a/docs/guides/reporting/hyper_parameters.md
+++ b/docs/guides/reporting/hyper_parameters.md
@@ -74,7 +74,6 @@ parameters['new_param'] = 'this is new'
# changing the value of a parameter (new value will be stored instead of previous one)
parameters['float'] = '9.9'
-
```
Parameters from dictionaries connected to Tasks appear in **HYPERPARAMETERS** **>** **General**.
diff --git a/docs/hyperdatasets/single_frames.md b/docs/hyperdatasets/single_frames.md
index 86ef1c42..7d740667 100644
--- a/docs/hyperdatasets/single_frames.md
+++ b/docs/hyperdatasets/single_frames.md
@@ -319,7 +319,6 @@ frame.meta['road_hazard'] = 'yes'
# update the SingeFrame
frames.append(frame)
myDatasetVersion.update_frames(frames)
-
```
diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md
index d7c16aa9..ba250ca3 100644
--- a/docs/hyperdatasets/webapp/webapp_dataviews.md
+++ b/docs/hyperdatasets/webapp/webapp_dataviews.md
@@ -51,7 +51,7 @@ Customize the table using any of the following:
* Dynamic column order - Drag a column title to a different position.
* Resize columns - Drag the column separator to change the width of that column. Double-click the column separator for automatic fit.
* Filter by user and/or status - When a filter is applied to a column, its filter icon will appear with a highlighted
- dot on its top right (
). To
+ dot on its top right (
). To
clear all active filters, click
in the top right corner of the table.
* Sort columns - By experiment name and/or elapsed time since creation.
diff --git a/docs/webapp/applications/apps_overview.md b/docs/webapp/applications/apps_overview.md
index 122c3b8e..f2b6087e 100644
--- a/docs/webapp/applications/apps_overview.md
+++ b/docs/webapp/applications/apps_overview.md
@@ -63,7 +63,7 @@ Access app instance actions, by right-clicking an instance, or through the menu
## Instance List Actions
-Access the instance list actions by clicking the action menu (
)
+Access the instance list actions by clicking the action menu (
)
on the instance list header:

diff --git a/docs/webapp/pipelines/webapp_pipeline_table.md b/docs/webapp/pipelines/webapp_pipeline_table.md
index 2ae1e2b1..52c011e9 100644
--- a/docs/webapp/pipelines/webapp_pipeline_table.md
+++ b/docs/webapp/pipelines/webapp_pipeline_table.md
@@ -75,7 +75,7 @@ There are a few types of filters:
options appear on the top of the tag list.
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An `X` will appear in the tag's checkbox.
-Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right (
).
+Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right (
).
To clear all active filters, click
in the top right corner of the table.
diff --git a/docs/webapp/webapp_exp_table.md b/docs/webapp/webapp_exp_table.md
index 9814e59a..fb6fd791 100644
--- a/docs/webapp/webapp_exp_table.md
+++ b/docs/webapp/webapp_exp_table.md
@@ -125,7 +125,7 @@ There are a few types of filters:
options appear on the top of the tag list.
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An `X` will appear in the tag's checkbox.
-Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right (
).
+Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right (
).
To clear all active filters, click
in the top right corner of the table.
diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md
index 08a73668..5598566a 100644
--- a/docs/webapp/webapp_exp_track_visual.md
+++ b/docs/webapp/webapp_exp_track_visual.md
@@ -325,7 +325,7 @@ These controls allow you to better analyze the results. Hover over a plot, and t
|
| Zoom into a section of a plot. Zoom in - Click
and drag over a section of the plot. Reset to original scale - Click
. |
|
| Zoom in. |
|
| Zoom out. |
-|
| Reset to autoscale after zooming (
,
, or
). |
+|
| Reset to autoscale after zooming (
,
, or
). |
|
| Reset axes after a zoom. |
|
| Show / hide spike lines. |
|
| Show the closest data point on hover, including horizontal and vertical axes values. Click
and then hover over a series on the plot. |
diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md
index 6f3809a5..57dbc18c 100644
--- a/docs/webapp/webapp_model_table.md
+++ b/docs/webapp/webapp_model_table.md
@@ -134,7 +134,7 @@ There are a couple filter types:
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An `X` will appear in the tag's checkbox.
Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right
-(
).
+(
).
To clear all active filters, click
in the top right corner of the table.
\ No newline at end of file