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

Update webapp images (#200)

Browse Source
This commit is contained in:
pollfly
2022-03-13 15:07:06 +02:00
committed by GitHub
parent 1ba4fb73b8
commit 913aac4bec
232 changed files with 195 additions and 333 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/reporting/3d_plots_reporting.md
View File

@@ -7,7 +7,7 @@ example demonstrates reporting a series as a surface plot and as a 3D scatter pl
When the script runs, it creates an experiment named `3D plot reporting`, which is associated with the `examples` project.
**ClearML** reports these plots in the **ClearML Web UI** **>** experiment page **>** **RESULTS** tab **>** **PLOTS** sub-tab.
ClearML reports these plots in the **ClearML Web UI** **>** experiment page **>** **RESULTS** tab **>** **PLOTS** sub-tab.
## Surface Plot

14
docs/guides/reporting/artifacts.md
View File

@@ -14,9 +14,9 @@ These artifacts include:
Artifacts can be uploaded and dynamically tracked, or uploaded without tracking.
Configure **ClearML** for uploading artifacts to any of the supported types of storage, which include local and shared folders,
Configure ClearML for uploading artifacts to any of the supported types of storage, which include local and shared folders,
S3 buckets, Google Cloud Storage, and Azure Storage ([debug sample storage](../../references/sdk/logger.md#set_default_upload_destination)
is different). Configure **ClearML** in any of the following ways:
is different). Configure ClearML in any of the following ways:
* In the configuration file, set [default_output_uri](../../configs/clearml_conf.md#sdkdevelopment).
* In code, when [initializing a Task](../../references/sdk/task.md#taskinit), use the `output_uri` parameter.
@@ -24,14 +24,14 @@ is different). Configure **ClearML** in any of the following ways:
When the script runs, it creates an experiment named `artifacts example`, which is associated with the `examples` project.
**ClearML** reports artifacts in the **ClearML Web UI** **>** experiment details **>** **ARTIFACTS** tab.
ClearML reports artifacts in the **ClearML Web UI** **>** experiment details **>** **ARTIFACTS** tab.
![image](../../img/examples_reporting_03.png)
## Dynamically Tracked Artifacts
Currently, **ClearML** supports uploading and dynamically tracking Pandas DataFrames. Use the [Task.register_artifact](../../references/sdk/task.md#register_artifact)
method. If the Pandas DataFrame changes, **ClearML** uploads the changes. The updated artifact is associated with the experiment.
Currently, ClearML supports uploading and dynamically tracking Pandas DataFrames. Use the [Task.register_artifact](../../references/sdk/task.md#register_artifact)
method. If the Pandas DataFrame changes, ClearML uploads the changes. The updated artifact is associated with the experiment.
For example:
@@ -51,7 +51,7 @@ task.register_artifact('train', df, metadata={'counting': 'legs', 'max legs': 69
```
By changing the artifact, and calling the [Task.get_registered_artifacts](../../references/sdk/task.md#get_registered_artifacts)
method to retrieve it, we can see that **ClearML** tracked the change.
method to retrieve it, we can see that ClearML tracked the change.
```python
# change the artifact object
@@ -62,7 +62,7 @@ Task.current_task().get_registered_artifacts()['train'].sample(frac=0.5, replace
## Artifacts Without Tracking
**ClearML** supports several types of objects that can be uploaded and are not tracked. Use the [Task.upload_artifact](../../references/sdk/task.md#upload_artifact)
ClearML supports several types of objects that can be uploaded and are not tracked. Use the [Task.upload_artifact](../../references/sdk/task.md#upload_artifact)
method.
Artifacts without tracking include:

8
docs/guides/reporting/hyper_parameters.md
View File

@@ -4,7 +4,7 @@ title: Hyperparameters Reporting
The [hyper_parameters.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/hyper_parameters.py) example
script demonstrates:
* **ClearML**'s automatic logging of `argparse` command line options and TensorFlow Definitions
* ClearML's automatic logging of `argparse` command line options and TensorFlow Definitions
* Logging user-defined hyperparameters with a parameter dictionary and connecting the dictionary to a Task.
Hyperparameters appear in the **web UI** in the experiment's page, under **CONFIGURATIONS** **>** **HYPER PARAMETERS**.
@@ -15,7 +15,7 @@ When the script runs, it creates an experiment named `hyper-parameters example`,
## Argparse Command Line Options
If a code uses argparse and initializes a Task, **ClearML** automatically logs the argparse arguments.
If a code uses argparse and initializes a Task, ClearML automatically logs the argparse arguments.
```python
parser = ArgumentParser()
@@ -34,7 +34,7 @@ Command line options appears in **HYPER PARAMETERS** **>** **Args**.
## TensorFlow Definitions
**ClearML** automatically logs TensorFlow Definitions, whether they are defined before or after the Task is initialized.
ClearML automatically logs TensorFlow Definitions, whether they are defined before or after the Task is initialized.
```python
flags.DEFINE_string('echo', None, 'Text to echo.')
@@ -55,7 +55,7 @@ TensorFlow Definitions appear in **HYPER PARAMETERS** **>** **TF_DEFINE**.
## Parameter Dictionaries
Connect a parameter dictionary to a Task by calling the [Task.connect](../../references/sdk/task.md#connect)
method, and **ClearML** logs the parameters. **ClearML** also tracks changes to the parameters.
method, and ClearML logs the parameters. ClearML also tracks changes to the parameters.
```python
parameters = {

2
docs/guides/reporting/manual_matplotlib_reporting.md
View File

@@ -3,7 +3,7 @@ title: Manual Matplotlib Reporting
---
The [matplotlib_manual_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/matplotlib_manual_reporting.py)
example demonstrates reporting using Matplotlib and Seaborn with **ClearML**.
example demonstrates reporting using Matplotlib and Seaborn with ClearML.
When the script runs, it creates an experiment named `Manual Matplotlib example`, which is associated with the
`examples` project.

6
docs/guides/reporting/media_reporting.md
View File

@@ -9,11 +9,11 @@ method to upload from:
* BytesIO stream
* URL of media already uploaded to some storage
**ClearML** uploads media to the bucket specified in the **ClearML** configuration file or **ClearML** can be configured for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination)
(storage for [artifacts](../../fundamentals/artifacts.md#setting-upload-destination) is different). Set credentials for storage in the **ClearML**
ClearML uploads media to the bucket specified in the ClearML configuration file or ClearML can be configured for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination)
(storage for [artifacts](../../fundamentals/artifacts.md#setting-upload-destination) is different). Set credentials for storage in the ClearML
[configuration file](../../configs/clearml_conf.md).
**ClearML** reports media in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **DEBUG SAMPLES**
ClearML reports media in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **DEBUG SAMPLES**
sub-tab.
When the script runs, it creates an experiment named `audio and video reporting`, which is associated with the `examples`

4
docs/guides/reporting/pandas_reporting.md
View File

@@ -4,10 +4,10 @@ title: Tables Reporting (Pandas and CSV Files)
The [pandas_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/pandas_reporting.py) example demonstrates reporting tabular data from Pandas DataFrames and CSV files as tables.
**ClearML** reports these tables in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
ClearML reports these tables in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
sub-tab.
When the script runs, it creates an experiment named `pandas table reporting`, which is associated with the `examples` project.
When the script runs, it creates an experiment named `table reporting`, which is associated with the `examples` project.
## Reporting Pandas DataFrames as Tables

6
docs/guides/reporting/plotly_reporting.md
View File

@@ -3,9 +3,9 @@ title: Plotly Reporting
---
The [plotly_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/plotly_reporting.py) example
demonstrates **ClearML**'s Plotly integration and reporting.
demonstrates ClearML's Plotly integration and reporting.
Report Plotly plots in **ClearML** by calling the [`Logger.report_plotly`](../../references/sdk/logger.md#report_plotly) method, and passing a complex
Report Plotly plots in ClearML by calling the [`Logger.report_plotly`](../../references/sdk/logger.md#report_plotly) method, and passing a complex
Plotly figure, using the `figure` parameter.
In this example, the Plotly figure is created using `plotly.express.scatter` (see [Scatter Plots in Python](https://plotly.com/python/line-and-scatter/)
@@ -33,7 +33,7 @@ task.get_logger().report_plotly(
When the script runs, it creates an experiment named `plotly reporting`, which is associated with the examples project.
**ClearML** reports Plotly plots in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
ClearML reports Plotly plots in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **PLOTS**
sub-tab.
![image](../../img/examples_reporting_13.png)

2
docs/guides/reporting/scalar_reporting.md
View File

@@ -3,7 +3,7 @@ title: Scalars Reporting
---
The [scalar_reporting.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/scalar_reporting.py) script
demonstrates explicit scalar reporting. **ClearML** reports scalars in the **ClearML Web UI** **>** experiment details **>**
demonstrates explicit scalar reporting. ClearML reports scalars in the **ClearML Web UI** **>** experiment details **>**
**RESULTS** tab **>** **SCALARS** sub-tab.
When the script runs, it creates an experiment named `scalar reporting`, which is associated with the `examples` project.

2
docs/guides/reporting/scatter_hist_confusion_mat_reporting.md
View File

@@ -8,7 +8,7 @@ example demonstrates reporting series data in the following 2D formats:
* [Confusion matrices](#confusion-matrices)
* [Scatter plots](#2d-scatter-plots)
**ClearML** reports these tables in the **ClearML Web UI**, experiment details **>** **RESULTS** tab **>** **PLOTS** sub-tab.
ClearML reports these tables in the **ClearML Web UI**, experiment details **>** **RESULTS** tab **>** **PLOTS** sub-tab.
When the script runs, it creates an experiment named `2D plots reporting`, which is associated with the `examples` project.

2
docs/guides/reporting/text_reporting.md
View File

@@ -6,7 +6,7 @@ The [text_reporting.py](https://github.com/allegroai/clearml/blob/master/example
demonstrates reporting explicit text, by calling the [Logger.report_text](../../references/sdk/logger.md#report_text)
method.
**ClearML** reports these tables in the **ClearML Web UI**, experiment details, **RESULTS** tab, **CONSOLE** sub-tab.
ClearML reports these tables in the **ClearML Web UI**, experiment details, **RESULTS** tab, **CONSOLE** sub-tab.
When the script runs, it creates an experiment named `text reporting`, which is associated with the `examples` project.