Update docs

This commit is contained in:
Noam Wasersprung 2025-05-06 11:24:11 +03:00 committed by GitHub
commit 9701eaee19
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 22 additions and 2 deletions

View File

@ -34,6 +34,7 @@ Use frame viewer controls to navigate between frames in a Hyper-Dataset Version,
|<img src="/docs/latest/icons/ico-arrow-right.svg" alt="Next frame icon" className="icon size-md space-sm" />|Go to the next frame | Right arrow |
|<img src="/docs/latest/icons/ico-skip-next.svg" alt="Jump to next unfiltered annotation" className="icon size-md space-sm" />|Go to the next frame containing a non-filtered annotation (same filter as <img src="/docs/latest/icons/ico-skip-previous.svg" alt="Jump to previous unfiltered annotation" className="icon size-md space-sm" />).| <img src="/docs/latest/icons/ico-optional-no.svg" alt="Not applicable" className="icon size-md center-md" /> |
|<img src="/docs/latest/icons/ico-skip-forward.svg" alt="Jump forwards icon" className="icon size-md space-sm" />|Jump forwards ten frames | CTRL + Right arrow |
|`Use Source Data`|Show the frames `source` rather than its `preview_uri`| <img src="/docs/latest/icons/ico-optional-no.svg" alt="Not applicable" className="icon size-md center-md" /> |
|<img src="/docs/latest/icons/ico-revert.svg" alt="Reload frame icon" className="icon size-md space-sm" />|Reload the frame.| <img src="/docs/latest/icons/ico-optional-no.svg" alt="Not applicable" className="icon size-md center-md" /> |
|<img src="/docs/latest/icons/ico-undo.svg" alt="Undo icon" className="icon size-md space-sm" />|Undo changes.|Ctrl + Z|
|<img src="/docs/latest/icons/ico-redo.svg" alt="Redo icon" className="icon size-md space-sm" />|Redo changes.|Ctrl + Y|
@ -42,6 +43,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" /> |
|`Current Source`|When viewing multi-source FrameGroups, select which of the FrameGroups' sources to display: <ul><li>`Default preview source`: present the first available source for each frame (sources are retrieved in ASCIIbetical order)</li><li>`All sources `: Present all the FrameGroups sources in a grid</li><li>Specific source: Select an individual source by name from the list of available sources</li></ul>|<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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

@ -354,6 +354,15 @@ are on the left side of the window. The tools include:
plots to display. For example, to display specific plots, click **HIDE ALL**, and then click <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show" className="icon size-md space-sm" />
on each plot you want to view.
:::tip Default scalar display
After adjusting the scalar display (e.g. grouping, axis, smoothing), click Set as default to save the current
configuration as the default view for the projects task and model scalars.
:::
See additional [plot controls](#plot-controls) below.
#### Embedding Plots
To embed scalar plots in your [Reports](webapp_reports.md), hover over a plot and click Embed <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. To quickly get the embed codes for all plots of a
specific metric, click Embed <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />
@ -365,7 +374,7 @@ on the group section header (available when plots are [grouped by](#group_by) `N
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.
See additional [plot controls](#plot-controls) below.
#### Metric Values View

View File

@ -44,6 +44,7 @@ information:
You can apply column filters by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />,
and sort endpoints by clicking <img src="/docs/latest/icons/ico-sort-off.svg" alt="Sort order" className="icon size-md space-sm" /> on the relevant column.
Use the pages search bar to search by endpoint name, ID, and model fields.
## Active Endpoint Details
Clicking on a model endpoint opens it in detailed view.

View File

@ -66,6 +66,7 @@ When viewing a group's usage, you can select what data to view in the dropdown m
The **Resource Groups** table displays current usage numbers for each group:
* Worker count - number of workers in the group
* GPU count
* Average GPU Utilization (%)
* Average CPU Load (%)
* Available (total) RAM (GB)

View File

@ -71,7 +71,11 @@ of a project folder to open its context menu and access the following project ac
</div>
* **Edit** - Rename the project and/or modify its default output destination.
* **Project Settings**
* **General** - Set the projects name, project path and default output destination
* **Scalar View Defaults** - Configure the default scalar view configuration for tasks and models
* **Scalar view setting** - Grouping, X-axis units and plot smoothing (See [Scalar Plot Tools](webapp_exp_track_visual.md#scalar-plot-tools))
* **Default scalars** - Choose which metrics are visible by default when viewing task/model scalars.
* **New Project** - Create a new project (by default a subproject).
* **Move to** - Move the project into another project. If the target project does not exist, it is created on-the-fly.
* **Delete** - Delete the project. To delete a project, all of its contents (i.e. any pipelines/reports/datasets) must

View File

@ -65,6 +65,9 @@ information. The resource metric being monitored can be selected through the men
* Video Memory Usage
* Network Usage.
If a worker has multiple GPUs, the **CPU and GPU Usage** and **Video Memory Usage** graphs display separate usage plots
for each GPU (e.g., GPU 0, GPU 1, etc.) in addition to an overall average GPU usage plot.
The worker's details panel includes the following two tabs:
* **INFO** - Worker information:
* Worker Name