Update docs (#563)

This commit is contained in:
pollfly
2023-05-17 11:38:28 +03:00
committed by GitHub
parent 62be2cc493
commit 0a96748deb
34 changed files with 277 additions and 53 deletions

View File

@@ -7,6 +7,8 @@ In the models table, double-click on a model to view and/or modify the following
* Model configuration
* Model label enumeration
* Model metadata
* Model scalars and other plots
Models in *Draft* status are editable, so you can modify their configuration, label enumeration, and metadata.
*Published* models are read-only, so only their metadata can be modified.
@@ -78,17 +80,29 @@ Use the search bar to look for experiments based on their name, ID, or descripti
## Scalars
The **SCALARS** tab displays all scalar plots attached to a model. Scalar values are presented as time series line
charts. To see the series for a metric in high resolution, view it in full screen mode by hovering over the graph and
plots. To see the series for a metric in high resolution, view it in full screen mode by hovering over the graph and
clicking <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" />.
Reported single value scalars are aggregated into a table plot displaying scalar names and values.
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
are retrieved when the report is displayed allowing your reports to show the latest up-to-date data.
For better plot analysis, see [Plot Controls](webapp_exp_track_visual.md#plot-controls).
Reported single value scalars are aggregated into a table plot displaying scalar names and values.
![Model scalars](../img/webapp_model_scalars.png)
## Plots
The **PLOTS** tab displays plots attached to a model. For better plot analysis, see [Plot Controls](webapp_exp_track_visual.md#plot-controls).
The **PLOTS** tab displays plots attached to a model.
To embed 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
are retrieved when the report is displayed allowing your reports to show the latest up-to-date data.
For better plot analysis, see [Plot Controls](webapp_exp_track_visual.md#plot-controls).
![Model plots](../img/webapp_model_plots.png)