Update report docs ()

This commit is contained in:
pollfly 2022-12-28 11:09:56 +02:00 committed by GitHub
parent 439d86a46b
commit 928190e0dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 14 additions and 7 deletions

BIN
docs/img/reports_step_2.png Normal file

Binary file not shown.

After

(image error) Size: 25 KiB

Binary file not shown.

After

(image error) Size: 25 KiB

BIN
docs/img/reports_step_3.png Normal file

Binary file not shown.

After

(image error) Size: 91 KiB

View File

@ -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
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | 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 |
| <img src="/docs/latest/icons/ico-reset.svg" alt="Refresh" className="icon size-sm space-sm" /> | Refresh scalar graphs in full screen mode to update it. |
| <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-sm space-sm" /> | 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. |
| <img src="/docs/latest/icons/ico-uri-copy.svg" alt="Embed code externally" className="icon size-sm space-sm" /> | 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). |
| <img src="/docs/latest/icons/ico-uri-copy.svg" alt="Embed code externally" className="icon size-sm space-sm" /> | 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|

View File

@ -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 <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Generate embed code" className="icon size-md space-sm" />.
This generates the embed code for accessing the resource and copies it to your clipboard.
2. Hover over the resource and click <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Generate embed code" className="icon size-md space-sm" />.
![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.