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

4
docs/guides/frameworks/autokeras/autokeras_imdb_example.md
View File

@@ -13,7 +13,7 @@ the autokeras [TextClassifier](https://autokeras.com/text_classifier/) class, an
## Scalars
The loss and accuracy metric scalar plots appear in **RESULTS** **>** **SCALARS**, along with the resource utilization plots,
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots,
which are titled **:monitor: machine**.
![image](../../../img/examples_keras_14.png)
@@ -26,7 +26,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_keras_15.png)

4
docs/guides/frameworks/catboost/catboost.md
View File

@@ -13,7 +13,7 @@ The example script does the following:
## Scalars
ClearML automatically captures scalars logged by CatBoost. 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**.
[ClearML web UI](../../../webapp/webapp_overview.md), in the experiment's page **> SCALARS**.
![Experiment scalars](../../../img/examples_catboost_scalars.png)
@@ -24,7 +24,7 @@ PARAMETERS > Args**.
![Experiment hyperparameters](../../../img/examples_catboost_configurations.png)
## 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**.
![Experiment console](../../../img/examples_catboost_console.png)

6
docs/guides/frameworks/fastai/fastai_with_tensorboard.md
View File

@@ -16,18 +16,18 @@ The example code does the following:
## Scalars
ClearML automatically logs the histogram output to TensorBoard. They appear in **RESULTS** **>** **PLOTS**.
ClearML automatically logs the histogram output to TensorBoard. They appear in **PLOTS**.
![image](../../../img/examples_reporting_fastai_01.png)
## Plots
Histograms output to TensorBoard. They appear in **RESULTS** **>** **PLOTS**.
Histograms output to TensorBoard. They appear in **PLOTS**.
![image](../../../img/examples_reporting_fastai_02.png)
## Logs
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_reporting_fastai_03.png)

8
docs/guides/frameworks/keras/jupyter.md
View File

@@ -16,14 +16,14 @@ The example does the following:
## Scalars
The loss and accuracy metric scalar plots appear in **RESULTS** **>** **SCALARS**, along with the resource utilization plots, which are titled **:monitor: machine**.
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots, which are titled **:monitor: machine**.
![image](../../../img/examples_keras_jupyter_08.png)
## Plots
The example calls Matplotlib methods to create several sample plots, and TensorBoard methods to plot histograms for layer density.
They appear in **RESULTS** **>** **PLOTS**.
They appear in **PLOTS**.
![image](../../../img/examples_keras_jupyter_03.png)
@@ -33,7 +33,7 @@ They appear in **RESULTS** **>** **PLOTS**.
## Debug Samples
The example calls Matplotlib methods to log debug sample images. They appear in **RESULTS** **>** **DEBUG SAMPLES**.
The example calls Matplotlib methods to log debug sample images. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_keras_jupyter_04.png)
@@ -65,7 +65,7 @@ The TensorFlow Definitions appear in the **TF_DEFINE** subsection.
## Console
Text printed to the console for training appears in **RESULTS** **>** **CONSOLE**.
Text printed to the console for training appears in **CONSOLE**.
![image](../../../img/examples_keras_jupyter_07.png)

6
docs/guides/frameworks/keras/keras_tensorboard.md
View File

@@ -22,14 +22,14 @@ The example script does the following:
## Scalars
The loss and accuracy metric scalar plots appear in **RESULTS** **>** **SCALARS**, along with the resource utilization plots,
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots,
which are titled **:monitor: machine**.
![image](../../../img/examples_keras_01.png)
## Histograms
Histograms for layer density appear in **RESULTS** **>** **PLOTS**.
Histograms for layer density appear in **PLOTS**.
![image](../../../img/examples_keras_02.png)
@@ -47,7 +47,7 @@ TensorFlow Definitions appear in **TF_DEFINE**.
## 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/keras_colab_01.png)

4
docs/guides/frameworks/lightgbm/lightgbm_example.md
View File

@@ -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 > RESULTS > 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**.
![LightGBM scalars](../../../img/examples_lightgbm_scalars.png)
@@ -32,7 +32,7 @@ models and any snapshots created using LightGBM.
## Console
All other console output appears in **RESULTS > CONSOLE**.
All other console output appears in **CONSOLE**.
![LightGBM console](../../../img/examples_lightgbm_console.png)

4
docs/guides/frameworks/matplotlib/matplotlib_example.md
View File

@@ -20,7 +20,7 @@ which is associated with the `examples` project (in script) or the `Colab notebo
## Plots
The scatter plots appear in the **ClearML Web UI**, in **RESULTS** **>** **PLOTS**.
The scatter plots appear in the **ClearML Web UI**, in **PLOTS**.
![image](../../../img/examples_matplotlib_example_01.png)
@@ -30,7 +30,7 @@ The scatter plots appear in the **ClearML Web UI**, in **RESULTS** **>** **PLOTS
## Debug Samples
The images appear in **RESULTS** **>** **DEBUG SAMPLES**. Each debug sample image is associated with a metric.
The images appear in **DEBUG SAMPLES**. Each debug sample image is associated with a metric.
![image](../../../img/examples_matplotlib_example_04.png)

4
docs/guides/frameworks/megengine/megengine_mnist.md
View File

@@ -25,7 +25,7 @@ The example script's `train` function calls TensorBoardX's `SummaryWriter.add_sc
ClearML automatically captures the data that is added to the `SummaryWriter` object.
These scalars can be visualized in plots, which appear in the ClearML [WebApp](../../../webapp/webapp_home.md), in the
experiment's **RESULTS** **>** **SCALARS** page.
experiment's **SCALARS** page.
![Scalars tab](../../../img/examples_megengine_mnist_scalars.png)
@@ -49,6 +49,6 @@ The model info panel contains the model details, including:
## Console
All console output during the script’s execution appears in the experiment’s **RESULTS > CONSOLE** page.
All console output during the script’s execution appears in the experiment’s **CONSOLE** page.
![Console tab](../../../img/examples_megengine_console.png)

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)

4
docs/guides/frameworks/pytorch_ignite/integration_pytorch_ignite.md
View File

@@ -35,7 +35,7 @@ into a script which uses `TensorboardLogger`, all information logged through the
ClearML automatically captures scalars logged through `TensorboardLogger`.
View the scalars in the experiment's page in the **ClearML Web UI**, in **RESULTS** **>** **SCALARS**.
View the scalars in the experiment's page in the **ClearML Web UI**, in **SCALARS**.
![image](../../../img/examples_cifar_scalars.png)
@@ -55,7 +55,7 @@ To view the model, in the **ARTIFACTS** tab, click the model name (or download i
## Debug Samples
ClearML automatically tracks images logged to TensorboardLogger. They appear in **RESULTS** **>** **DEBUG SAMPLES**.
ClearML automatically tracks images logged to TensorboardLogger. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_integration_pytorch_ignite_debug.png)

2
docs/guides/frameworks/pytorch_ignite/pytorch_ignite_mnist.md
View File

@@ -142,7 +142,7 @@ When the code runs, the experiment results can be viewed in the [ClearML Web UI]
### Scalars
View the scalars, including training and validation metrics, in the experiment's page in the ClearML Web UI, under
**RESULTS** **>** **SCALARS**.
**SCALARS**.
![image](../../../img/ignite_training.png)

4
docs/guides/frameworks/pytorch_lightning/pytorch_lightning_example.md
View File

@@ -12,7 +12,7 @@ The example script does the following:
## Scalars
The test loss and validation loss plots appear in the experiment's page in the ClearML web UI under **RESULTS > SCALARS**.
The test loss and validation loss plots appear in the experiment's page in the ClearML web UI under **SCALARS**.
Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab. All of these
plots are automatically captured by ClearML.
@@ -37,7 +37,7 @@ the model’s details and access the model.
## Console
All other console output appears in **RESULTS > CONSOLE**.
All other console output appears in **CONSOLE**.
![PyTorch Lightning console](../../../img/examples_pytorch_lightning_console.png)

2
docs/guides/frameworks/scikit-learn/sklearn_joblib_example.md
View File

@@ -10,7 +10,7 @@ and `matplotlib` to create a scatter diagram. When the script runs, it creates a
## Plots
ClearML automatically logs the scatter plot, which appears in the [experiment's page](../../../webapp/webapp_exp_track_visual.md)
in the ClearML web UI, under **RESULTS** **>** **PLOTS**.
in the ClearML web UI, under **PLOTS**.
![image](../../../img/examples_sklearn_joblib_example_06.png)

2
docs/guides/frameworks/scikit-learn/sklearn_matplotlib_example.md
View File

@@ -13,6 +13,6 @@ The example does the following:
## Plots
The learning curve plots appear in the **ClearML web UI** under **RESULTS** **>** **PLOTS**.
The learning curve plots appear in the **ClearML web UI** under **PLOTS**.
![image](../../../img/examples_sklearn_matplotlib_example_01.png)

4
docs/guides/frameworks/tensorboardx/tensorboardx.md
View File

@@ -14,7 +14,7 @@ The script does the following:
## Scalars
The loss and accuracy metric scalar plots appear in the experiment's page in the **ClearML web UI**, under
**RESULTS** **>** **SCALARS**. The also includes resource utilization plots, which are titled **:monitor: machine**.
**SCALARS**. The also includes resource utilization plots, which are titled **:monitor: machine**.
![image](../../../img/examples_pytorch_tensorboardx_03.png)
@@ -27,7 +27,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_tensorboardx_02.png)

2
docs/guides/frameworks/tensorboardx/video_tensorboardx.md
View File

@@ -12,7 +12,7 @@ the `examples` project.
## Debug Samples
ClearML automatically captures the video data that is added to the `SummaryWriter` object, using the `add_video` method.
The video appears in the experiment page in the ClearML web UI under **RESULTS > DEBUG SAMPLES**.
The video appears in the experiment page in the ClearML web UI under **DEBUG SAMPLES**.
![Debug Samples](../../../img/examples_tensorboardx_debug.png)

8
docs/guides/frameworks/tensorflow/integration_keras_tuner.md
View File

@@ -36,14 +36,14 @@ When the script runs, it logs:
## Scalars
ClearML logs the scalars from training each network. They appear in the project's page in the **ClearML web UI**, under
**RESULTS** **>** **SCALARS**.
**SCALARS**.
![image](../../../img/integration_keras_tuner_06.png)
## Summary of Hyperparameter Optimization
ClearML automatically logs the parameters of each experiment run in the hyperparameter search. They appear in tabular
form in **RESULTS** **>** **PLOTS**.
form in **PLOTS**.
![image](../../../img/integration_keras_tuner_07.png)
@@ -65,13 +65,13 @@ The model configuration is stored with the model.
### Hyperparameters
ClearML automatically logs the TensorFlow Definitions, which appear in **RESULTS** **>** **CONFIGURATION** **>** **HYPER PARAMETERS**.
ClearML automatically logs the TensorFlow Definitions, which appear in **CONFIGURATION** **>** **HYPER PARAMETERS**.
![image](../../../img/integration_keras_tuner_01.png)
### Configuration
The Task configuration appears in **RESULTS** **>** **CONFIGURATION** **>** **General**.
The Task configuration appears in **CONFIGURATION** **>** **General**.
![image](../../../img/integration_keras_tuner_02.png)

4
docs/guides/frameworks/tensorflow/tensorboard_pr_curve.md
View File

@@ -16,7 +16,7 @@ The example script does the following:
## Plots
In the **ClearML Web UI**, the PR Curve summaries appear in the experiment's page under **RESULTS** **>** **PLOTS**.
In the **ClearML Web UI**, the PR Curve summaries appear in the experiment's page under **PLOTS**.
* Blue PR curves
![image](../../../img/examples_tensorboard_pr_curve_01.png)
@@ -33,6 +33,6 @@ ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATIO
## Console
All other console output appears in **RESULTS** **>** **CONSOLE**.
All other console output appears in **CONSOLE**.
![image](../../../img/examples_tensorboard_pr_curve_05.png)

6
docs/guides/frameworks/tensorflow/tensorboard_toy.md
View File

@@ -11,20 +11,20 @@ project.
## Scalars
The `tf.summary.scalar` output appears in the ClearML web UI, in the experiment's **RESULTS** **>**
The `tf.summary.scalar` output appears in the ClearML web UI, in the experiment's
**SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
![image](../../../img/examples_tensorboard_toy_03.png)
## Plots
The `tf.summary.histogram` output appears in **RESULTS** **>** **PLOTS**.
The `tf.summary.histogram` output appears in **PLOTS**.
![image](../../../img/examples_tensorboard_toy_04.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_tensorboard_toy_05.png)

6
docs/guides/frameworks/tensorflow/tensorflow_mnist.md
View File

@@ -10,8 +10,8 @@ When the script runs, it creates an experiment named `Tensorflow v2 mnist with s
## Scalars
The loss and accuracy metric scalar plots appear in the experiment's page in the **ClearML web UI** under **RESULTS**
**>** **SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
The loss and accuracy metric scalar plots appear in the experiment's page in the **ClearML web UI** under
**SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
![image](../../../img/examples_tensorflow_mnist_06.png)
@@ -24,7 +24,7 @@ ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATIO
## Console
All console output appears in **RESULTS** **>** **CONSOLE**.
All console output appears in **CONSOLE**.
![image](../../../img/examples_tensorflow_mnist_05.png)

4
docs/guides/frameworks/xgboost/xgboost_metrics.md
View File

@@ -11,7 +11,7 @@ the `examples` project.
## Scalars
ClearML automatically captures scalars logged with XGBoost, which can be visualized in plots in the
ClearML WebApp, in the experiment's **RESULTS > SCALARS** page.
ClearML WebApp, in the experiment's **SCALARS** page.
![Scalars](../../../img/examples_xgboost_metric_scalars.png)
@@ -29,6 +29,6 @@ To view the model details, click the model name in the **ARTIFACTS** page, which
## Console
All console output during the script’s execution appears in the experiment’s **RESULTS > CONSOLE** page.
All console output during the script’s execution appears in the experiment’s **CONSOLE** page.
![Console output](../../../img/examples_xgboost_metric_console.png)

4
docs/guides/frameworks/xgboost/xgboost_sample.md
View File

@@ -15,14 +15,14 @@ classification dataset using XGBoost
## Plots
The feature importance plot and tree plot appear in the project's page in the **ClearML web UI**, under **RESULTS** **>**
The feature importance plot and tree plot appear in the project's page in the **ClearML web UI**, under
**PLOTS**.
![image](../../../img/examples_xgboost_sample_06.png)
## Console
All other console output appear in **RESULTS** **>** **CONSOLE**.
All other console output appear in **CONSOLE**.
![image](../../../img/examples_xgboost_sample_05.png)