diff --git a/docs/img/reports_step_2.png b/docs/img/reports_step_2.png new file mode 100644 index 00000000..66135d32 Binary files /dev/null and b/docs/img/reports_step_2.png differ diff --git a/docs/img/reports_step_2a.png b/docs/img/reports_step_2a.png new file mode 100644 index 00000000..99ad198e Binary files /dev/null and b/docs/img/reports_step_2a.png differ diff --git a/docs/img/reports_step_3.png b/docs/img/reports_step_3.png new file mode 100644 index 00000000..4ae3a636 Binary files /dev/null and b/docs/img/reports_step_3.png differ diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 8784a29f..b321c808 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -232,8 +232,8 @@ General experiment details appear in the **INFO** tab. This includes information :::tip Embedding ClearML Visualization You can embed experiment plots and debug samples into ClearML [Reports](webapp_reports.md). These visualizations are -updated live as the experiment(s) updates. The Enterprise Plan supports embedding resources in external documents. See -[Plot Controls](#plot-controls). +updated live as the experiment(s) updates. The Enterprise Plan and Hosted Service support embedding resources in external +tools (e.g. Notion). See [Plot Controls](#plot-controls). ::: ### Console @@ -349,7 +349,7 @@ These controls allow you to better analyze the results. Hover over a plot, and t | Maximize plot icon | Expand plot to entire window. When used with scalar graphs, full screen mode displays plots with all data points, as opposed to an averaged plot | | Refresh | Refresh scalar graphs in full screen mode to update it. | | Embed code | Copy to clipboard the resource embed code to put in your [Reports](webapp_reports.md). In contrast to static screenshots, embedded resources are retrieved when the report is displayed allowing your reports to show the latest up-to-date data. | -| Embed code externally | Copy to clipboard the resource embed code to put in external editors (e.g. Notion). In contrast to static screenshots, embedded resources are retrieved when the report is displayed allowing your reports to show the latest up-to-date data (available in the ClearML Enterprise plan). | +| Embed code externally | Copy to clipboard the resource embed code to put in external tools (e.g. Notion). In contrast to static screenshots, embedded resources are retrieved when the report is displayed allowing your reports to show the latest up-to-date data (available in the ClearML Enterprise plan and Hosted Service). | #### 3D Plot Controls |Icon|Description| diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index 90f3fd14..c60dd89a 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -32,12 +32,19 @@ experiment(s) updates. To add a graphic resource: 1. Go to the resource you want to embed in your report (a plot or debug sample from an individual experiment or experiment comparison) -2. Hover over the resource and -click Generate embed code. -This generates the embed code for accessing the resource and copies it to your clipboard. +2. Hover over the resource and click Generate embed code. + + ![Reports step 2](../img/reports_step_2.png) + + Click `Embed in ClearML report`. This generates the embed code for accessing the resource, and copies + it to your clipboard. + + ![Reports step 2a](../img/reports_step_2a.png) + 3. Return to your report page and paste the code snippet - + ![Reports step 3](../img/reports_step_3.png) + ## Reports Page Use the Reports Page to navigate between and manage reports. The page shows summaries for all reports.