Skip to content

Commit ac33d5d

Browse files
committed
[DOCS-1243] Updates to docs on panel add, quick add, and manual workspaces for perfmance
1 parent a69ede2 commit ac33d5d

File tree

1 file changed

+21
-18
lines changed
  • content/guides/models/app/features/panels

1 file changed

+21
-18
lines changed

content/guides/models/app/features/panels/_index.md

+21-18
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ W&B projects support two different workspace modes. The icon next to the workspa
1818

1919
| Icon | Workspace mode |
2020
| --- | --- |
21-
| {{< 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. |
22-
| {{<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. |
21+
| {{< 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. |
22+
| {{<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. |
2323

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

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

7070
## Add panels
7171

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

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

76-
1. To add a panel globally, click **Add panels** in the control bar near the panel search field.
77-
1. To add a panel directly to a section instead, click the section's action `...` menu, then click **+ Add panels**.
78-
1. Select the type of panel to add.
79-
80-
{{< img src="/images/app_ui/add_single_panel.gif" >}}
76+
Use **Quick add** to generate a standard panel for each key you select, either globally or at the section level.
8177

82-
### Quick add
83-
84-
**Quick Add** allows you to select a key in the project from a list to generate a standard panel for it.
78+
{{% alert %}}
79+
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.
80+
{{% /alert %}}
8581

86-
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.
82+
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**.
83+
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**.
84+
1. A list of panels appears. Each panel with a checkmark is already included in the workspace.
85+
- 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.
86+
- 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.
8787

88-
### Custom panel add
88+
### Add a panel manually
8989

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

92-
1. Select the type of panel you’d like to create.
93-
1. Follow the prompts to configure the panel.
92+
1. To add a panel globally, click **Add panels** in the control bar near the panel search field.
93+
1. To add a panel directly to a section instead, click the section's action `...` menu, then click **+ Add panels**.
94+
1. Select the type of panel to add, such as a chart. The panel's configuration details appear, with defaults selected.
95+
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" >}}).
96+
1. Click **Apply**.
9497

95-
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" >}}).
98+
{{< img src="/images/app_ui/add_single_panel.gif" alt="Demo of adding a panel" >}}
9699

97100
## Share a panel
98101

0 commit comments

Comments
 (0)