From 774f452312b8b89f118b8b6f0caa896634d6480c Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 18 Jul 2023 11:08:20 +0300 Subject: [PATCH] Update docs (#608) --- docs/hyperdatasets/webapp/webapp_datasets_frames.md | 7 +++---- docs/hyperdatasets/webapp/webapp_dataviews.md | 7 +++++++ docs/webapp/datasets/webapp_dataset_viewing.md | 9 +++++++++ docs/webapp/pipelines/webapp_pipeline_table.md | 7 +++++++ docs/webapp/webapp_exp_table.md | 6 ++++++ docs/webapp/webapp_exp_track_visual.md | 11 ++++++----- docs/webapp/webapp_model_table.md | 7 +++++++ docs/webapp/webapp_reports.md | 12 ++++++++---- 8 files changed, 53 insertions(+), 13 deletions(-) diff --git a/docs/hyperdatasets/webapp/webapp_datasets_frames.md b/docs/hyperdatasets/webapp/webapp_datasets_frames.md index b40a20a9..9eac961a 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_frames.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_frames.md @@ -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, |Zoom in icon|Zoom in| **+** or Ctrl + Mouse wheel| |Zoom out icon|Zoom out| **-** or Ctrl + Mouse wheel | |Percentage textbox|Zoom percentage| Not applicable | - +|Copy URL| Copy frame URL. A direct link to view the current frame|Not applicable | #### Additional Keyboard Shortcuts diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index e36da3ed..d7c16aa9 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -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 Download +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: diff --git a/docs/webapp/datasets/webapp_dataset_viewing.md b/docs/webapp/datasets/webapp_dataset_viewing.md index bd5e286d..0cddcb1a 100644 --- a/docs/webapp/datasets/webapp_dataset_viewing.md +++ b/docs/webapp/datasets/webapp_dataset_viewing.md @@ -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 Download +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 diff --git a/docs/webapp/pipelines/webapp_pipeline_table.md b/docs/webapp/pipelines/webapp_pipeline_table.md index 6b20c4ae..c42b2e8a 100644 --- a/docs/webapp/pipelines/webapp_pipeline_table.md +++ b/docs/webapp/pipelines/webapp_pipeline_table.md @@ -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 Download +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 diff --git a/docs/webapp/webapp_exp_table.md b/docs/webapp/webapp_exp_table.md index 82a79d5d..b642a05b 100644 --- a/docs/webapp/webapp_exp_table.md +++ b/docs/webapp/webapp_exp_table.md @@ -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 Download +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) diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 6541a7a1..753a8830 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -278,13 +278,14 @@ are on the left side of the window. The tools include: +* 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 Eye Show All 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 Embed code, which will copy to clipboard the embed code to put in your Reports. In contrast to static screenshots, embedded resources diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md index 41f0c49c..89d563ec 100644 --- a/docs/webapp/webapp_model_table.md +++ b/docs/webapp/webapp_model_table.md @@ -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 Download +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 diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index fca0b0d1..e6ba1025 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -70,7 +70,7 @@ A standard embed code is formatted like this: ``` ``` @@ -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="/widgets/?objectType=task&type=scalar&metrics=&variants=&project=&page_size=1&page=0&order_by[]=-last_update + src="/widgets/?objectType=task&xaxis=iter&type=scalar&metrics=&variants=&project=&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="/widgets/?objectType=task&type=scalar&metrics=&variants=&tags[]=__$or, + src="/widgets/?objectType=task&xaxis=iter&type=scalar&metrics=&variants=&tags[]=__$or, ``` 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="/widgets/?objectType=task&type=scalar&metrics=training&variants=accuracy&project=4043a1657f374e9298649c6ba72ad233&page_size=5&page=0&order_by[]=-last_metrics...value" + src="/widgets/?objectType=task&xaxis=iter&type=scalar&metrics=training&variants=accuracy&project=4043a1657f374e9298649c6ba72ad233&page_size=5&page=0&order_by[]=-last_metrics...value" ```