Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-1243] Updates to docs on panel add, quick add, and manual workspaces for performance #1150

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
39 changes: 21 additions & 18 deletions content/guides/models/app/features/panels/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ W&B projects support two different workspace modes. The icon next to the workspa

| Icon | Workspace mode |
| --- | --- |
| {{< img src="/images/app_ui/automated_workspace.svg" alt="automated workspace icon" width="32px" >}} | **Automated workspaces** automatically generate panels for all keys logged in the project. This can help you get started by visualizing all available data for the project. |
| {{<img src="/images/app_ui/manual_workspace.svg" alt="manual workspace icon" width="32px" >}} | **Manual workspaces** start as blank slates and display only those panels intentionally added by users. Choose a manual workspace when you care mainly about a fraction of the keys logged in the project, or for a more focused analysis. |
| {{< img src="/images/app_ui/automated_workspace.svg" alt="automated workspace icon" width="32px" >}} | **Automated workspaces** automatically generate panels for all keys logged in the project. Choose an automatic workspace:<ul><li>To get started quickly by visualizing all available data for the project.</li><li>For a smaller projects that log fewer keys.</li><li>For more broad analysis.</li></ul>If you delete a panel from an automatic workspace, you can use [Quick add]({{< relref "#quick-add" >}}) to recreate it. |
| {{<img src="/images/app_ui/manual_workspace.svg" alt="manual workspace icon" width="32px" >}} | **Manual workspaces** start as blank slates and display only those panels intentionally added by users. Choose a manual workspace:<ul><li>When you care mainly about a fraction of the keys logged in the project.</li><li>For more focused analysis.</li><li>To improve the performance of a workspace, avoiding loading panels that are less useful to you.</li></ul>Use [Quick add]({{< relref "#quick-add" >}}) to easily populate a manual workspace and its sections with useful visualizations rapidly. |

To change how a workspace generates panels, [reset the workspace]({{< relref "#reset-a-workspace" >}}).

Expand Down Expand Up @@ -69,30 +69,33 @@ To get back to a panel's workspace from full-screen mode, click the left-pointin

## Add panels

You can add panels to your workspace, either globally or at the section level.
This section shows various ways to add panels to your workspace.

To add a panel:
### Quick add panels {#quick-add}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick add is less common than adding other panels so it seems like maybe shouldn't be first. I also don't think the term "standard panel" is commonly equated with "line plot"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't mean to conflate them. It looks to me like for a given key, a panel is generated automatically and the type of plot depends on the key. I deleted an automatically-generated media panel, then Quick Add let me add it back again, as a media panel. I've tried to clarify this section, an d placed it after the manual add.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Asked more questions about this in Slack.

1. To add a panel globally, click **Add panels** in the control bar near the panel search field.
1. To add a panel directly to a section instead, click the section's action `...` menu, then click **+ Add panels**.
1. Select the type of panel to add.

{{< img src="/images/app_ui/add_single_panel.gif" >}}
Use **Quick add** to generate a standard panel for each key you select, either globally or at the section level.

### Quick add

**Quick Add** allows you to select a key in the project from a list to generate a standard panel for it.
{{% alert %}}
For an automated workspace with no deleted panels, the **Quick add** option is not visible becasue the workspace already includes standard panels for all logged keys. You can use **Quick add** to re-add a panel that you deleted.
{{% /alert %}}

For an automated workspace with no deleted panels, **Quick add** is not available. You can use **Quick add** to re-add a panel that you deleted.
1. To use **Quick add** to add a panel globally, click **Add panels** in the control bar near the panel search field, then click **Quick add**.
1. To use **Quick add** to add a panel directly to a section, click the section's action `...` menu, click **Add panels**, then click **Quick add**.
1. A list of panels appears. Each panel with a checkmark is already included in the workspace.
- To add all available panels, click the **Add <N> panels** button at the top of the list. The **Quick Add** list closes and the new panels display in the workspace.
- To add an individual panel from the list, hover over the panel's row, then click **Add**. Repeat this step for each panel you want to add, then click the **X** at the top right to close the **Quick Add** list. The new panels display in the workspace.

### Custom panel add
### Add a panel manually

To add a custom panel to your workspace:
Add panels to your workspace one at a time, either globally or at the section level.

1. Select the type of panel you’d like to create.
1. Follow the prompts to configure the panel.
1. To add a panel globally, click **Add panels** in the control bar near the panel search field.
1. To add a panel directly to a section instead, click the section's action `...` menu, then click **+ Add panels**.
1. Select the type of panel to add, such as a chart. The panel's configuration details appear, with defaults selected.
1. Optionally, customize the panel and its display preferences. Configuration options depend on the type of panel you select. To learn more about the options for each type of panel, refer to the relevant section below, such as [Line plots]({{< relref "line-plot/" >}}) or [Bar plots]({{< relref "bar-plot.md" >}}).
1. Click **Apply**.

To learn more about the options for each type of panel, refer to the relevant section below, such as [Line plots]({{< relref "line-plot/" >}}) or [Bar plots]({{< relref "bar-plot.md" >}}).
{{< img src="/images/app_ui/add_single_panel.gif" alt="Demo of adding a panel" >}}

## Share a panel

Expand Down
13 changes: 12 additions & 1 deletion content/guides/models/track/limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,18 @@ For faster loading times, keep the total number of runs in a single project unde

If you find that you or your team are frequently accessing the same set of runs (for example, recent runs), consider [bulk moving _other_ runs]({{< relref "/guides/models/track/runs/manage-runs.md" >}}) to a new project used as an archive, leaving a smaller set of runs in your working project.

### Section count
### Workspace performance
This section gives tips for optimizing the performance of your workspace.

#### Panel count
By default, a workspace is _automatic_, and generates standard panels for each logged key. If a workspace for a large project includes panels for many logged keys, the workspace may be slow to load and use. To improve performance, you can:

- Delete unused panels from the workspace. If you delete a panel in error, you can re-add it using [Quick add]({{< relref "/guides/models/app/features/panels/#quick-add" >}}).
- Reset the workspace to manual mode, which includes no panels by default. You can use [Quick add]({{< relref "/guides/models/app/features/panels/#quick-add" >}}) to selectively add panels for the logged keys you need to visualize.

To learn more about configuring your workspace, refer to [Panels]({{< relref "/guides/models/app/features/panels/" >}}).

#### Section count

Having hundreds of sections in a workspace can hurt performance. Consider creating sections based on high-level groupings of metrics and avoiding an anti-pattern of one section for each metric.

Expand Down