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-1209][DOCS-1204] Document full-screen panel view, various panel sharing options, customizing number of panels per section #1087

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open
Binary file added assets/images/app_ui/panel_fullscreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 54 additions & 11 deletions content/guides/models/app/features/panels/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,53 @@ To add a custom panel to your workspace:

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" >}}).

## Share panels

This section describes the various ways to share a panel and how each way differs.

The settings of a project determine who can view the panel. This means that if the project is private, only members of the project can view the panel. If the project is public, anyone with the link can view the panel.

### Share a panel with a direct link

To share a panel with a specific user or team:

1. Hover over the panel, then click the panel's action menu `...`.
1. Click **Share panel in report**.
1. To invite a specific user by email, select the **Invite** tab.
1. Enter an email address or username.
1. Optionally, change **can view** to **can edit**.
1. Click **Invite**. W&B sends an email to the user with a clickable link to the report.
1. To copy a shareable link to the panel, click the **Share** tab.
1. Change **Only those who are invited have access** to **Anyone with the link can view**.
1. Click **Copy report link**, then share the link with the user or team.
1. Choose **Share on Twitter**, **Share on Reddit**, **Share on LinkedIn**, or **Copy embed link**.

When the user access the link, the panel opens in the normal view. You can instead [view and share a panel in full-screen mode]({{< relref "#view-and-share-a-panel-in-full-screen-mode" >}}).

### View and share a panel in full-screen mode
In full-screen mode, the panel plots 10,000 buckets rather than 1,000 when not in full-screen mode. The state of the run selector is preserved, so you can toggle runs on or off or search for runs.

To view and share a panel in full-screen mode:

1. Hover over the panel, then click the panel's action menu `...`.
1. Click the full-screen button, which looks like a viewfinder.
{{< img src="/images/app_ui/panel_fullscreen.png" alt="View panel full-screen" >}}

The panel opens in full-screen mode.
1. Copy the URL from the browser or click the action menu `...` and select **Copy panel URL**.
1. Share the link with the user or team. When they access the link, the panel opens in full-screen mode automatically.

The proceeding section shows how to compose a panel's full-screen URL programmatically instead of finding it interactively.

#### Compose a panel's full-screen URL programmatically
In certain situations, such as when [creating an automation]({{< relref "/guides/models/automations/" >}}), it can be useful to include the panel's full-screen URL. This section shows the format for a panel's full-screen URL. In the proceeding example, replace the entity, project, panel, and section names in brackets.

```text
https://wandb.ai/<ENTITY_NAME>/<PROJECT_NAME>?panelDisplayName=<PANEL_NAME>&panelSectionName=<SECTON_NAME>
```

If multiple panels in the same section have the same name, this URL opens the first panel with the name.


## Manage panels

Expand All @@ -83,17 +130,6 @@ To move a panel to a different section, you can use the drag handle on the panel

You can also use the drag handle to rearrange panels within a section.

### Share a full-screen panel directly
Direct colleagues to a specific panel in your project. The link redirects users to a full screen view of that panel when they click that link. To create a link to a panel:

1. Hover your mouse over the panel.
2. Select the action `...` menu.
3. Click **Copy panel URL**.

The settings of the project determine who can view the panel. This means that if the project is private, only members of the project can view the panel. If the project is public, anyone with the link can view the panel.

If multiple panels have the same name, W&B shares the first panel with the name.

### Duplicate a panel

To duplicate a panel:
Expand Down Expand Up @@ -125,6 +161,13 @@ To add a section, click **Add section** after the last section.

To add a new section before or after an existing section, you can instead click the section's action `...` menu, then click **New section below** or **New section above**.


### Manage a section's visible panels
By default, each section shows 6 panels, but you can show a maximum of 100 panels. To customize a section that has more than 6 panels:

1. At the top of the section, click **1 to 6 of <X>**, where `<X>` is the total number of panels.
1. Choose how many panels to show.

### Rename a section

To rename a section, click its action `...` menu, then click **Rename section**.
Expand Down
Loading