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

Small edits (#900)

Browse Source
This commit is contained in:
pollfly 2024-08-11 12:31:49 +03:00 committed by GitHub
parent 452d1aeca1
commit 3021efd45c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/clearml_sdk/clearml_sdk.md
View File

@ -82,7 +82,7 @@ See [ClearML Data](../clearml_data/clearml_data.md) or the [Dataset SDK referenc
The `StorageManager` class provides support for downloading and uploading from storage, The `StorageManager` class provides support for downloading and uploading from storage,
including local folders, S3, Google Cloud Storage, Azure Storage, and http(s). including local folders, S3, Google Cloud Storage, Azure Storage, and http(s).
See the [StorageManager SDK reference page](../references/sdk/storage.md). See [examples](../guides/storage/examples_storagehelper.md) of `StorageManager` usage or the [StorageManager SDK reference page](../references/sdk/storage.md).
### APIClient ### APIClient
The `APIClient` class provides a Pythonic interface to access ClearML's backend REST API. The `APIClient` class provides a Pythonic interface to access ClearML's backend REST API.

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

@ -11,7 +11,7 @@ The example script does the following:
label of each random color is associated with the normal distribution that generated it. label of each random color is associated with the normal distribution that generated it.
* Computes the probability that each color belongs to the class, using three other normal distributions. * Computes the probability that each color belongs to the class, using three other normal distributions.
* Generate PR curves using those probabilities. * Generate PR curves using those probabilities.
* Creates a summary per class using [tensorboard.plugins.pr_curve.summary](https://github.com/tensorflow/tensorboard/blob/master/tensorboard/plugins/pr_curve/summary.py). * Creates a summary per class using [`tensorboard.plugins.pr_curve.summary`](https://github.com/tensorflow/tensorboard/blob/master/tensorboard/plugins/pr_curve/summary.py).
* ClearML automatically captures TensorBoard output, TensorFlow Definitions, and output to the console. * ClearML automatically captures TensorBoard output, TensorFlow Definitions, and output to the console.
## Plots ## Plots
@ -19,10 +19,15 @@ The example script does the following:
In the **ClearML Web UI**, the PR Curve summaries appear in the experiment's page under **PLOTS**. In the **ClearML Web UI**, the PR Curve summaries appear in the experiment's page under **PLOTS**.
* Blue PR curves * Blue PR curves
![image](../../../img/examples_tensorboard_pr_curve_01.png) ![image](../../../img/examples_tensorboard_pr_curve_01.png)
* Green PR curves * Green PR curves
![image](../../../img/examples_tensorboard_pr_curve_02.png) ![image](../../../img/examples_tensorboard_pr_curve_02.png)
* Red PR curves * Red PR curves
![image](../../../img/examples_tensorboard_pr_curve_03.png) ![image](../../../img/examples_tensorboard_pr_curve_03.png)
## Hyperparameters ## Hyperparameters

7
docs/webapp/webapp_exp_table.md
View File

@ -13,8 +13,9 @@ using the buttons on the top left of the page. Use the table view for a comparat
to columns of interest. Use the details view to access a selected experiment's details, while keeping the experiment list to columns of interest. Use the details view to access a selected experiment's details, while keeping the experiment list
in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view. in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view.
Use the [comparison view](#comparing-experiments) to compare your experiments' scalar and plot results (for a more in Use the [comparison view](#comparing-experiments) to compare your experiments' scalar and plot results (for a more in
depth comparison, see [Comparing Experiments](webapp_exp_comparing.md)). When selected, this view presents a comparison depth comparison, see [Comparing Experiments](webapp_exp_comparing.md)). This view compares
of all selected experiments. If no experiments are selected, all currently visible experiments in the table are compared. the scalars/plots of currently selected experiments. If no experiments are selected, the first 100
visible experiments in the table are compared.
You can archive experiments so the experiments table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the You can archive experiments so the experiments table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the
table to open the archive and view all archived experiments. From the archive, you can restore table to open the archive and view all archived experiments. From the archive, you can restore
@ -266,7 +267,7 @@ selecting items beyond the items currently on-screen:
The comparison view compares experiment scalar and plot results (for a more in depth comparison, see [Comparing Experiments](webapp_exp_comparing.md)). The comparison view compares experiment scalar and plot results (for a more in depth comparison, see [Comparing Experiments](webapp_exp_comparing.md)).
When selected, the view presents a comparison of all [selected experiments](#selecting-multiple-experiments). If no When selected, the view presents a comparison of all [selected experiments](#selecting-multiple-experiments). If no
experiments are selected, all currently visible experiments in the table are displayed in the comparison. experiments are selected, the first 100 visible experiments in the table are displayed in the comparison.
In the dropdown menu, select to view **Scalars** or **Plots**. **Scalars** shows experiment scalar results as time In the dropdown menu, select to view **Scalars** or **Plots**. **Scalars** shows experiment scalar results as time
series line graphs. **Plots** shows the last reported iteration sample of each metric/variant combination per compared series line graphs. **Plots** shows the last reported iteration sample of each metric/variant combination per compared