ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-05 13:45:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs (#608)

Browse Source
This commit is contained in:
pollfly 2023-07-18 11:08:20 +03:00 committed by GitHub
parent b63ad7aa7e
commit 774f452312
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 53 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/hyperdatasets/webapp/webapp_datasets_frames.md
View File

@ -11,9 +11,8 @@ filtering logic.
## Frame Viewer
Frame viewer lets you view and edit annotations which can be FrameGroup objects (Regions of Interest) and FrameGroup
labels applied to the entire frame not a region of the frame, the frame details (see [frames](../frames.md)),
frame metadata, the raw data source URI, as well as providing navigation and viewing tools.
Use the frame viewer to view and edit annotations (ROIs and frame labels), frame details (see [frames](../frames.md)),
and frame metadata, as well as view frame masks of your dataset version frames.
![Frame viewer](../../img/hyperdatasets/web-app/dataset_example_frame_editor.png)
@ -36,7 +35,7 @@ Use frame viewer controls to navigate between frames in a Hyper-Dataset Version,
|<img src="/docs/latest/icons/ico-zoom-in.svg" alt="Zoom in icon" className="icon size-md space-sm" />|Zoom in| **+** or Ctrl + Mouse wheel|
|<img src="/docs/latest/icons/ico-zoom-out.svg" alt="Zoom out icon" className="icon size-md space-sm" />|Zoom out| **-** or Ctrl + Mouse wheel |
|Percentage textbox|Zoom percentage| <img src="/docs/latest/icons/ico-optional-no.svg" alt="Not applicable" className="icon size-md center-md" /> |
|<img src="/docs/latest/icons/ico-shared-item.svg" alt="Copy URL" className="icon size-md space-sm" />| Copy frame URL. A direct link to view the current frame|<img src="/docs/latest/icons/ico-optional-no.svg" alt="Not applicable" className="icon size-md center-md" /> |
#### Additional Keyboard Shortcuts

7
docs/hyperdatasets/webapp/webapp_dataviews.md
View File

@ -18,6 +18,13 @@ You can archive Dataviews so the Dataviews table doesn't get too cluttered. Clic
table to open the archive and view all archived Dataviews. From the archive, you can restore
Dataviews to remove them from the archive. You can also permanently delete Dataviews.
You can download the Dataviews table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
and choosing one of these options:
* **Download onscreen items** - Download the values for Dataviews currently visible on screen
* **Download all items** - Download the values for all Dataviews in this project that match the current active filters
The downloaded data consists of the currently displayed table columns.
![Dataviews table](../../img/hyperdatasets/webapp_dataviews_table.png)
The Dataviews table includes the following columns:

9
docs/webapp/datasets/webapp_dataset_viewing.md
View File

@ -32,6 +32,15 @@ the list to open the archive and view all archived versions. From the archive, y
versions to remove them from the archive. You can also permanently delete versions.
:::
:::tip Download Version List
You can download the dataset version list as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
and choosing one of these options:
* **Download onscreen items** - Download the values for versions currently visible on screen
* **Download all items** - Download the values for all versions in this dataset that match the current active filters
The downloaded data consists of the currently displayed table columns.
:::
## Version Details
### Version Info

7
docs/webapp/pipelines/webapp_pipeline_table.md
View File

@ -16,6 +16,13 @@ You can archive pipeline runs so the runs table doesn't get too cluttered. Click
table to open the archive and view all archived runs. From the archive, you can restore
runs to remove them from the archive. You can also permanently delete runs.
You can download the pipeline runs table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
and choosing one of these options:
* **Download onscreen items** - Download the values for pipeline runs currently visible on screen
* **Download all items** - Download the values for all runs in this pipeline that match the current active filters
The downloaded data consists of the currently displayed table columns.
![Pipeline runs table](../../img/webapp_pipeline_runs_table.png)
## Run Table Columns

6
docs/webapp/webapp_exp_table.md
View File

@ -16,6 +16,12 @@ You can archive experiments so the experiments table doesn't get too cluttered.
table to open the archive and view all archived experiments. From the archive, you can restore
experiments to remove them from the archive. You can also permanently delete experiments.
You can download the experiments table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
and choosing one of these options:
* **Download onscreen items** - Download the values for experiments currently visible on screen
* **Download all items** - Download the values for all experiments in this project that match the current active filters
The downloaded data consists of the currently displayed table columns.
![Experiment table](../img/webapp_experiment_table.png)

11
docs/webapp/webapp_exp_track_visual.md
View File

@ -278,13 +278,14 @@ are on the left side of the window. The tools include:
</Collapsible>
* Horizontal axis - Select the x-axis units:
* Iterations
* Time from start - Time since experiment began
* Wall time - Local clock time
* Curve smoothing - Choose which smoothing algorithm to use from the dropdown menu: Exponential moving average, Gaussian,
or Running Average. Use the slider to configure the smoothing factor or specify a value manually.
* Show / hide plots - Click **HIDE ALL**, and then click <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />
on those you want to see.
* **Horizontal axis** modes (scalars, only) - Select one of the following:
* **ITERATIONS**
* **RELATIVE** - Time since experiment began
* **WALL** - Local clock time
* Curve smoothing (scalars, only) - In **Smoothing** **>** Move the slider or type a smoothing factor between **0** and **0.999**.
To embed scalar plots in your [Reports](webapp_reports.md), hover over a plot and click <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />,
which will copy to clipboard the embed code to put in your Reports. In contrast to static screenshots, embedded resources

7
docs/webapp/webapp_model_table.md
View File

@ -15,6 +15,13 @@ You can archive models so the models table doesn't get too cluttered. Click **OP
table to open the archive and view all archived models. From the archive, you can restore
models to remove them from the archive, and permanently delete models.
You can download the models table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />
and choosing one of these options:
* **Download onscreen items** - Download the values for models currently visible on screen
* **Download all items** - Download the values for all models in this project that match the current active filters
The downloaded data consists of the currently displayed table columns.
![Models table](../img/webapp_models_01.png)
## Models Table Columns

12
docs/webapp/webapp_reports.md
View File

@ -70,7 +70,7 @@ A standard embed code is formatted like this:
```
<iframe
src="<web_server>/widgets/?type=sample&objectType=task&objects=<object_id>&metrics=<metric_name>&variants=Plot%20as%20an%20image&company=<company/workspace_id>"
src="<web_server>/widgets/?type=sample&objectType=task&objects=<object_id>&xaxis=iter&metrics=<metric_name>&variants=Plot%20as%20an%20image&company=<company/workspace_id>"
width="100%" height="400"
></iframe>
```
@ -100,6 +100,10 @@ resources will be displayed. See [Dynamic Queries](#dynamic-queries) below.
* `min_value`
* `max_value`
* `value` (last value)
* `xaxis` - Set the x-axis units for plots. The options are:
* `iter` - Iteration (default)
* `timestamp` - Time from start
* `iso_time` - Wall time
* `metrics` - Metric name
* `variants` - Variant’s name
* `company` - Workspace ID. Applicable to the ClearML hosted service, for embedding content from a different workspace
@ -129,7 +133,7 @@ used.
* Request the scalars plot of a specific metric variant for the latest experiment in a project:
```
src="<web_server>/widgets/?objectType=task&type=scalar&metrics=<metric_name>&variants=<variant>&project=<project_id>&page_size=1&page=0&order_by[]=-last_update
src="<web_server>/widgets/?objectType=task&xaxis=iter&type=scalar&metrics=<metric_name>&variants=<variant>&project=<project_id>&page_size=1&page=0&order_by[]=-last_update
```
Notice that the `project` parameter is specified. In order to get the most recent single experiment,
`page_size=1&page=0&order_by[]=-last_update` is added. `page_size` specifies how many results are returned in each
@ -139,14 +143,14 @@ used.
* Request the scalars plot of a specific metric variant for the experiments with a specific tag:
```
src="<web_server>/widgets/?objectType=task&type=scalar&metrics=<metric_name>&variants=<variant>&tags[]=__$or,<tag>
src="<web_server>/widgets/?objectType=task&xaxis=iter&type=scalar&metrics=<metric_name>&variants=<variant>&tags[]=__$or,<tag>
```
A list of tags that the experiment should contain is specified in the `tags` argument. You can also specify tags that
exclude experiments. See tag filter syntax examples [here](../clearml_sdk/task_sdk.md#tag-filters).
* Request the `training/accuracy` scalar plot of the 5 experiments with the best accuracy scores (see Metric/Variant IDs note [below](#event_id)):
```
src="<web_server>/widgets/?objectType=task&type=scalar&metrics=training&variants=accuracy&project=4043a1657f374e9298649c6ba72ad233&page_size=5&page=0&order_by[]=-last_metrics.<metric_id>.<variant_id>.value"
src="<web_server>/widgets/?objectType=task&xaxis=iter&type=scalar&metrics=training&variants=accuracy&project=4043a1657f374e9298649c6ba72ad233&page_size=5&page=0&order_by[]=-last_metrics.<metric_id>.<variant_id>.value"
```
<a id="event_id"></a>