ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#257)

Browse Source
This commit is contained in:
pollfly
2022-05-22 10:27:30 +03:00
committed by GitHub
parent bd1c132578
commit c20e9ef111
57 changed files with 129 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K.md
View File

@@ -6,13 +6,13 @@ The example [audio_classification_UrbanSound8K.ipynb](https://github.com/allegro
## Scalars
The accuracy, learning rate, and training loss scalars are automatically logged, along with the resource utilization plots (titled **:monitor: machine**), and appear **RESULTS** **>** **SCALARS**.
The accuracy, learning rate, and training loss scalars are automatically logged, along with the resource utilization plots (titled **:monitor: machine**), and appear in **SCALARS**.
![image](../../../../../img/examples_audio_classification_UrbanSound8K_03.png)
## Debug Samples
The audio samples and spectrogram plots are automatically logged and appear in **RESULTS** **>** **DEBUG SAMPLES**.
The audio samples and spectrogram plots are automatically logged and appear in **DEBUG SAMPLES**.
### Audio Samples
@@ -46,6 +46,6 @@ TensorFlow Definitions appear in the **TF_DEFINE** subsection.
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../../../img/examples_audio_classification_UrbanSound8K_02.png)

4
docs/guides/frameworks/pytorch/notebooks/audio/audio_preprocessing_example.md
View File

@@ -7,13 +7,13 @@ demonstrates integrating ClearML into a Jupyter Notebook which uses PyTorch and
## Plots
ClearML automatically logs the waveform which the example reports by calling a Matplotlib method. These appear in **RESULTS** **>** **PLOTS**.
ClearML automatically logs the waveform which the example reports by calling a Matplotlib method. These appear in **PLOTS**.
![image](../../../../../img/examples_audio_preprocessing_example_08.png)
## Debug Samples
ClearML automatically logs the audio samples which the example reports by calling TensorBoard methods, and the spectrogram visualizations reported by calling Matplotlib methods. They appear in **RESULTS** **>** **DEBUG SAMPLES**.
ClearML automatically logs the audio samples which the example reports by calling TensorBoard methods, and the spectrogram visualizations reported by calling Matplotlib methods. They appear in **DEBUG SAMPLES**.
### Audio Samples

6
docs/guides/frameworks/pytorch/notebooks/image/hyperparameter_search.md
View File

@@ -58,14 +58,14 @@ optimizer = HyperParameterOptimizer(
### Console
All console output appears in the optimizer task's **RESULTS > CONSOLE**.
All console output appears in the optimizer task's **CONSOLE**.
![Experiment console](../../../../../img/examples_hyperparameter_search_03.png)
### Scalars
Scalar metrics for total accuracy and remaining budget by iteration, and a plot of total accuracy by iteration appear in the
experiment's **RESULTS** **>** **SCALARS**. Remaining budget indicates the percentage of total iterations for all jobs left before that total is reached.
experiment's **SCALARS**. Remaining budget indicates the percentage of total iterations for all jobs left before that total is reached.
ClearML automatically reports the scalars generated by `HyperParameterOptimizer`.
@@ -74,7 +74,7 @@ ClearML automatically reports the scalars generated by `HyperParameterOptimizer`
### Plots
The optimization task automatically records and monitors the different trial tasks' configuration and execution details, and
provides a summary of the optimization results in tabular and parallel coordinate formats. View these plots in the task's **RESULTS** **>**
provides a summary of the optimization results in tabular and parallel coordinate formats. View these plots in the task's
**PLOTS**.
![Experiment scatter plot](../../../../../img/examples_hyperparameter_search_05.png)

6
docs/guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10.md
View File

@@ -13,13 +13,13 @@ Another example optimizes the hyperparameters for this image classification exam
## Scalars
The accuracy, accuracy per class, and training loss scalars are automatically logged, along with the resource utilization plots (titled **:monitor: machine**), and appear **RESULTS** **>** **SCALARS**.
The accuracy, accuracy per class, and training loss scalars are automatically logged, along with the resource utilization plots (titled **:monitor: machine**), and appear **SCALARS**.
![image](../../../../../img/examples_image_classification_CIFAR10_05.png)
## Debug Samples
The image samples are automatically logged and appear in **RESULTS** **>** **DEBUG SAMPLES**.
The image samples are automatically logged and appear in **DEBUG SAMPLES**.
![image](../../../../../img/examples_image_classification_CIFAR10_07.png)
@@ -45,6 +45,6 @@ TensorFlow Definitions appear in the **TF_DEFINE** subsection.
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../../../img/examples_image_classification_CIFAR10_04.png)

4
docs/guides/frameworks/pytorch/notebooks/table/download_and_preprocessing.md
View File

@@ -29,7 +29,7 @@ For example, the raw data is read into a Pandas DataFrame named `train_set`, and
train_set = pd.read_csv(Path(path_to_ShelterAnimal) / 'train.csv')
Logger.current_logger().report_table(title='ClearMLet - raw',series='pandas DataFrame',iteration=0, table_plot=train_set.head())
The tables appear in **RESULTS** **>** **PLOTS**.
The tables appear in **PLOTS**.
![image](../../../../../img/download_and_preprocessing_07.png)
@@ -48,6 +48,6 @@ Parameter dictionaries appear in the **General** subsection.
## Console
Output to the console appears in **RESULTS** **>** **CONSOLE**.
Output to the console appears in **CONSOLE**.
![image](../../../../../img/download_and_preprocessing_06.png)

8
docs/guides/frameworks/pytorch/notebooks/table/tabular_training_pipeline.md
View File

@@ -85,7 +85,7 @@ configuration_dict = task.connect(configuration_dict) # enabling configuration
ClearML tracks and reports each instance of the preprocessing Task.
The raw data appears as a table in **RESULTS** **>** **PLOTS**.
The raw data appears as a table in **PLOTS**.
These images are from one of the two preprocessing Tasks.
@@ -159,7 +159,7 @@ configuration_dict = task.connect(configuration_dict) # enabling configuration
ClearML tracks and reports the training step with each instance of the newly cloned and executed training Task.
ClearML automatically logs training loss and learning. They appear in **RESULTS** **>** **SCALARS**.
ClearML automatically logs training loss and learning. They appear in **SCALARS**.
The following images show one of the two training Tasks.
@@ -209,7 +209,7 @@ configuration_dict = {
configuration_dict = task.connect(configuration_dict) # enabling configuration override by clearml
```
The logs show the Task ID and accuracy for the best model in **RESULTS** **>** **LOGS**.
The logs show the Task ID and accuracy for the best model in **CONSOLE**.
![image](../../../../../img/tabular_training_pipeline_02.png)
@@ -242,7 +242,7 @@ pipe.stop()
<summary className="cml-expansion-panel-summary">ClearML tracks and reports the pipeline's execution</summary>
<div className="cml-expansion-panel-content">
ClearML reports the pipeline with its steps in **RESULTS** **>** **PLOTS**.
ClearML reports the pipeline with its steps in **PLOTS**.
![image](../../../../../img/tabular_training_pipeline_01.png)

4
docs/guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS.md
View File

@@ -8,7 +8,7 @@ to classify text in the `torchtext` [AG_NEWS](https://pytorch.org/text/stable/da
## Scalars
Accuracy, learning rate, and training loss appear in **RESULTS** **>** **SCALARS**, along with the resource utilization plots, which are titled **:monitor: machine**.
Accuracy, learning rate, and training loss appear in **SCALARS**, along with the resource utilization plots, which are titled **:monitor: machine**.
![image](../../../../../img/text_classification_AG_NEWS_03.png)
@@ -36,7 +36,7 @@ Parameter dictionaries appear in the **General** subsection.
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../../../img/text_classification_AG_NEWS_02.png)

4
docs/guides/frameworks/pytorch/pytorch_abseil.md
View File

@@ -41,7 +41,7 @@ Logger.current_logger().report_scalar(
```
These scalars can be visualized in plots, which appear in the [ClearML web UI](../../../webapp/webapp_overview.md), in
the experiment's page **>** **RESULTS** **>** **SCALARS**.
the experiment's page **>** **SCALARS**.
![image](../../../img/examples_pytorch_mnist_07.png)
@@ -54,7 +54,7 @@ ClearML automatically logs command line options defined with abseil flags. They
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_mnist_06.png)

4
docs/guides/frameworks/pytorch/pytorch_distributed_example.md
View File

@@ -42,7 +42,7 @@ same title (`loss`), but a different series name (containing the subprocess' `ra
Task.current_task().get_logger().report_scalar(
'loss', 'worker {:02d}'.format(dist.get_rank()), value=loss.item(), iteration=i)
The single scalar plot for loss appears in **RESULTS** **>** **SCALARS**.
The single scalar plot for loss appears in **SCALARS**.
![image](../../../img/examples_pytorch_distributed_example_08.png)
@@ -73,6 +73,6 @@ Task.current_task().connect(param)
## Log
Output to the console, including the text messages printed from the main Task object and each subprocess, appears in **RESULTS** **>** **CONSOLE**.
Output to the console, including the text messages printed from the main Task object and each subprocess, appears in **CONSOLE**.
![image](../../../img/examples_pytorch_distributed_example_06.png)

2
docs/guides/frameworks/pytorch/pytorch_matplotlib.md
View File

@@ -12,7 +12,7 @@ The example does the following:
## Debug Samples
The images shown in the example script's `imshow` function appear according to metric in **RESULTS** **>** **DEBUG SAMPLES**.
The images shown in the example script's `imshow` function appear according to metric in **DEBUG SAMPLES**.
![image](../../../img/examples_pytorch_matplotlib_02.png)

4
docs/guides/frameworks/pytorch/pytorch_mnist.md
View File

@@ -34,7 +34,7 @@ Logger.current_logger().report_scalar(
```
These scalars can be visualized in plots, which appear in the ClearML [web UI](../../../webapp/webapp_overview.md),
in the experiment's page **>** **RESULTS** **>** **SCALARS**.
in the experiment's page **>** **SCALARS**.
![image](../../../img/examples_pytorch_mnist_07.png)
@@ -46,7 +46,7 @@ ClearML automatically logs command line options defined with `argparse`. They ap
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_mnist_06.png)

6
docs/guides/frameworks/pytorch/pytorch_tensorboard.md
View File

@@ -16,13 +16,13 @@ The example does the following:
In the example script, the `train` and `test` functions call the TensorBoard `SummaryWriter.add_scalar` method to log loss.
These scalars, along with the resource utilization plots, which are titled **:monitor: machine**, appear in the experiment's
page in the [ClearML web UI](../../../webapp/webapp_overview.md) under **RESULTS** **>** **SCALARS**.
page in the [ClearML web UI](../../../webapp/webapp_overview.md) under **SCALARS**.
![image](../../../img/examples_pytorch_tensorboard_07.png)
## Debug Samples
ClearML automatically tracks images and text output to TensorFlow. They appear in **RESULTS** **>** **DEBUG SAMPLES**.
ClearML automatically tracks images and text output to TensorFlow. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_pytorch_tensorboard_08.png)
@@ -34,7 +34,7 @@ ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATIO
## Console
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_tensorboard_06.png)

4
docs/guides/frameworks/pytorch/pytorch_tensorboardx.md
View File

@@ -15,7 +15,7 @@ The example does the following:
## Scalars
The loss and accuracy metric scalar plots, along with the resource utilization plots, which are titled **:monitor: machine**,
appear in the experiment's page in the [web UI](../../../webapp/webapp_overview.md), under **RESULTS** **>** **SCALARS**.
appear in the experiment's page in the [web UI](../../../webapp/webapp_overview.md), under **SCALARS**.
![image](../../../img/examples_pytorch_tensorboardx_03.png)
@@ -29,7 +29,7 @@ ClearML automatically logs command line options defined with `argparse`. They ap
## Log
Text printed to the console for training progress, as well as all other console output, appear in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_tensorboardx_02.png)

3
docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md
View File

@@ -9,8 +9,7 @@ associated with the `examples` project.
## Debug Samples
The debug sample images appear according to metric, in the experiment page in the **ClearML web UI** under **RESULTS**
**>** **DEBUG SAMPLES**.
The debug sample images appear according to metric, in the experiment page in the **ClearML web UI** under **DEBUG SAMPLES**.
![image](../../../img/examples_tensorboard_toy_pytorch_02.png)