Skip to content

Commit c9ef6ac

Browse files
committed
Docs updates for runs:
- [DOCS-1265] Renaming run groups updates - [DOCS-1291] Rename runs updates - [DOCS-1253] Move runs between groups - [DOCS-1255] Run status when killed from the UI
1 parent 43efc88 commit c9ef6ac

File tree

4 files changed

+131
-19
lines changed

4 files changed

+131
-19
lines changed

content/guides/core/reports/edit-a-report.md

+11
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,17 @@ Add run sets from projects interactively with the App UI or the W&B SDK.
8484

8585
Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown, choose Panel Grid. This will automatically import the run set from the project the report was created from.
8686

87+
You can [rename a run]({{< relref "/guides/models/track/runs/#rename-a-run" >}}) in the run set:
88+
89+
1. In the report, click the pencil icon to open the report editor.
90+
1. In the run set, find the run to rename. Hover over the report name, click the three vertical dots, then select either:
91+
92+
- **Rename run for project**: rename the run across the entire project. To generate a new random name, leave the field blank.
93+
- **Rename run for panel grid** rename the run only in the report, preserving the existing name in other contexts. Generating a new random name is not supported.
94+
95+
Submit the form.
96+
1. Click **Publish report**.
97+
8798
{{% /tab %}}
8899

89100
{{% tab header="Workspaces API" value="sdk"%}}

content/guides/models/track/runs/_index.md

+64-9
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ If you do not specify a project name, W&B stores the run in a project called `Un
137137

138138
Each run in W&B has a [unique identifier known as a *run ID*]({{< relref "#unique-run-identifiers" >}}). [You can specify a unique ID]({{< relref "#unique-run-identifiers" >}}) or let [W&B randomly generate one for you]({{< relref "#autogenerated-run-ids" >}}).
139139

140-
Each run also has a human-readable,[ non-unique identifier known as a *run name*]({{< relref "#name-your-run" >}}). You can specify a name for your run or let W&B randomly generate one for you.
140+
Each run also has a human-readable, non-unique identifier known as a [*run name*]({{< relref "#name-your-run" >}}). You can specify a name for your run or let W&B randomly generate one for you. You can rename a run after initializing it.
141141

142142
For example, consider the proceeding code snippet:
143143

@@ -168,17 +168,20 @@ run.finish()
168168
```
169169
{{% /alert %}}
170170

171+
If you [group runs]({{< relref "grouping.md" >}}) into experiments, you can move it into or out of a group or from one group to another.
172+
171173
Each run has a state that describes the current status of the run. See [Run states]({{< relref "#run-states" >}}) for a full list of possible run states.
172174

173175
## Run states
174176
The proceeding table describes the possible states a run can be in:
175177

176178
| State | Description |
177179
| ----- | ----- |
178-
| Finished| Run ended and fully synced data, or called `wandb.finish()` |
179-
| Failed | Run ended with a non-zero exit status |
180-
| Crashed | Run stopped sending heartbeats in the internal process, which can happen if the machine crashes |
181-
| Running | Run is still running and has recently sent a heartbeat |
180+
| `Crashed` | Run stopped sending heartbeats in the internal process, which can happen if the machine crashes. |
181+
| `Failed` | Run ended with a non-zero exit status. |
182+
| `Finished`| Run ended and fully synced data, or called `wandb.finish()`. |
183+
| `Killed` | Run was forcibly stopped before it could finish. |
184+
| `Running` | Run is still running and has recently sent a heartbeat. |
182185

183186

184187
## Unique run identifiers
@@ -236,6 +239,30 @@ import wandb
236239
run = wandb.init(entity="<project>", project="<project>", name="<run-name>")
237240
```
238241

242+
### Rename a run
243+
244+
After it is initialized, you can rename a run from your workspace or its **Runs** page.
245+
246+
1. Navigate to your W&B project.
247+
1. Select the **Workspace** or **Runs** tab from the project sidebar.
248+
1. Search or scroll to the run you want to rename.
249+
250+
Hover over the run name, click the three vertical dots, then click **Rename run**.
251+
1. Type a new name for the run. To generate a new random name, leave the field blank.
252+
1. Submit the form. The run's new name displays.
253+
254+
You can also rename a run from a run set in a [report]({{< relref "/guides/core/reports/edit-a-report.md" >}}):
255+
256+
1. In the report, click the pencil icon to open the report editor.
257+
1. In the run set, find the run to rename. Hover over the report name, click the three vertical dots, then select either:
258+
259+
- **Rename run for project**: rename the run across the entire project. To generate a new random name, leave the field blank.
260+
- **Rename run for panel grid** rename the run only in the report, preserving the existing name in other contexts. Generating a new random name is not supported.
261+
262+
Submit the form.
263+
1. Click **Publish report**.
264+
265+
239266
## Add a note to a run
240267
Notes that you add to a specific run appear on the run page in the **Overview** tab and in the table of runs on the project page.
241268

@@ -245,7 +272,6 @@ Notes that you add to a specific run appear on the run page in the **Overview**
245272
4. Choose the **Overview** tab
246273
5. Select the pencil icon next to the **Description** field and add your notes
247274

248-
249275
## Stop a run
250276
Stop a run from the W&B App or programmatically.
251277

@@ -305,8 +331,6 @@ To view a specific run:
305331
3. Within the project sidebar, select the **Workspace** tab.
306332
4. Within the run selector, click the run you want to view, or enter a partial run name to filter for matching runs.
307333

308-
By default, long run names are truncated in the middle for readability. To truncate run names at the beginning or end instead, click the action `...` menu at the top of the list of runs, then set **Run name cropping** to crop the end, middle, or beginning.
309-
310334
Note that the URL path of a specific run has the proceeding format:
311335

312336
```text
@@ -315,6 +339,32 @@ https://wandb.ai/<team-name>/<project-name>/runs/<run-id>
315339

316340
Where values enclosed in angle brackets (`< >`) are placeholders for the actual values of the team name, project name, and run ID.
317341

342+
### Customize how runs are displayed
343+
You can customize how runs are displayed in your project from the **Workspace** or **Runs** tab, which share display settings.
344+
345+
To customize which columns are visible:
346+
1. Above the list of runs, click **Columns**.
347+
1. Click the name of a hidden column to show it. Click the name of a visible column to hide it.
348+
349+
You can optionally search by column name using fuzzy search, an exact match, or regular expressions. Drag columns to change their order.
350+
1. Click **Done** to close the column browser.
351+
352+
To sort the list of runs by any visible column:
353+
354+
1. Hover over the column name, then click its action `...` menu.
355+
1. Click **Sort ascending** or **Sort descending**.
356+
357+
Pinned columns are shown on the right-hand side. To pin or unpin a column:
358+
1. Hover over the column name, then click its action `...` menu.
359+
1. Click **Pin column** or **Unpin column**.
360+
361+
By default, long run names are truncated in the middle for readability. To customize the truncation of run names:
362+
363+
1. Click the action `...` menu at the top of the list of runs.
364+
1. Set **Run name cropping** to crop the end, middle, or beginning.
365+
366+
[Learn more about the **Runs** tab]({{< relref "/guides/models/track/project-page.md#runs-tab" >}}).
367+
318368
### Overview tab
319369
Use the **Overview** tab to learn about specific run information in a project, such as:
320370

@@ -415,7 +465,12 @@ Group all rows by the value in a particular column with the **Group by** button
415465

416466
{{< img src="/images/data_vis/group.png" alt="The truth distribution shows small errors: 8s and 2s are confused for 7s and 9s for 2s." >}}
417467

418-
By default, this turns other numeric columns into histograms showing the distribution of values for that column across the group. Grouping is helpful for understanding higher-level patterns in your data.
468+
By default, this turns other numeric columns into histograms showing the distribution of values for that column across the group. Grouping is helpful for understanding higher-level patterns in your data.
469+
470+
{{% alert %}}
471+
The **Group by** feature is distinct from a [run's run group]({{< relref "grouping.md" >}}). You can group runs by run group. To move a run to a different run group, refer to [Assign a group or job type to a run]({{< relref "#assign-a-group-or-job-type-to-a-run" >}}).
472+
{{% /alert %}}
473+
419474
{{% /tab %}}
420475
{{< /tabpane >}}
421476

content/guides/models/track/runs/grouping.md

+52-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Group individual jobs into experiments by passing a unique **group** name to **w
1515
2. **Multiple processes**: Group multiple smaller processes together into an experiment.
1616
3. **K-fold cross-validation**: Group together runs with different random seeds to see a larger experiment. Here's [an example](https://github.com/wandb/examples/tree/master/examples/wandb-sweeps/sweeps-cross-validation) of k-fold cross-validation with sweeps and grouping.
1717

18-
There are three ways to set grouping:
18+
There are several ways to set grouping:
1919

2020
### 1. Set group in your script
2121

@@ -25,9 +25,58 @@ Pass an optional group and job_type to wandb.init(). This gives you a dedicated
2525

2626
Use `WANDB_RUN_GROUP` to specify a group for your runs as an environment variable. For more on this, check our docs for [**Environment Variables**]({{< relref "/guides/models/track/environment-variables.md" >}})**. Group** should be unique within your project and shared by all runs in the group. You can use `wandb.util.generate_id()` to generate a unique 8 character string to use in all your processes— for example, `os.environ["WANDB_RUN_GROUP"] = "experiment-" + wandb.util.generate_id()`
2727

28-
### 3. Toggle grouping in the UI
28+
### 3. Set a group in the UI
2929

30-
You can dynamically group by any config column. For example, if you use `wandb.config` to log batch size or learning rate, you can then group by those hyperparameters dynamically in the web app.
30+
To set a run's group in the UI:
31+
32+
After a run is initialized, you can move it to a new group from your workspace or its **Runs** page.
33+
34+
1. Navigate to your W&B project.
35+
1. Select the **Workspace** or **Runs** tab from the project sidebar.
36+
1. Search or scroll to the run you want to rename.
37+
38+
Hover over the run name, click the three vertical dots, then click **Move to another group**.
39+
1. To create a new group, click **New group**. Type a group name, then submit the form.
40+
1. Select the run's new group from the list, then click **Move**.
41+
42+
### 4. Toggle grouping by columns in the UI
43+
44+
You can dynamically group by any column, including a column that is hidden. For example, if you use `wandb.config` to log batch size or learning rate, you can then group by those hyperparameters dynamically in the web app. The **Group by** feature is distinct from a [run's run group]({{< relref "grouping.md" >}}). You can group runs by run group. To move a run to a different run group, refer to [Set a group in the UI]({{< relref "#set-a-group-in-the-ui" >}}).
45+
46+
{{% alert title='optional_title' %}}
47+
In the list of runs, the **Group** column is hidden by default.
48+
{{% /alert %}}
49+
50+
To group runs by one or more columns:
51+
52+
1. Click **Group**.
53+
1. Click the names of one or more columns.
54+
1. If you selected more than one column, drag them to change the grouping order.
55+
1. Click anywhere outside of the form to dismiss it.
56+
57+
### Customize how runs are displayed
58+
You can customize how runs are displayed in your workspace from the **Workspace** or **Runs** tab, which share display settings.
59+
60+
To customize which columns are visible:
61+
1. Above the list of runs, click **Columns**.
62+
1. Click the name of a hidden column to show it. Click the name of a visible column to hide it.
63+
64+
You can optionally search by column name using fuzzy search, an exact match, or regular expressions. Drag columns to change their order.
65+
1. Click **Done** to close the column browser.
66+
67+
To sort the list of runs by any visible column:
68+
69+
1. Hover over the column name, then click its action `...` menu.
70+
1. Click **Sort ascending** or **Sort descending**.
71+
72+
Pinned columns are shown on the right-hand side. To pin or unpin a column:
73+
1. Hover over the column name, then click its action `...` menu.
74+
1. Click **Pin column** or **Unpin column**.
75+
76+
By default, long run names are truncated in the middle for readability. To customize the truncation of run names:
77+
78+
1. Click the action `...` menu at the top of the list of runs.
79+
1. Set **Run name cropping** to crop the end, middle, or beginning.
3180

3281
## Distributed training with grouping
3382

content/guides/models/track/runs/manage-runs.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ menu:
55
parent: what-are-runs
66
title: Move runs
77
---
8-
98
Move runs between your projects or to a team you are a member of.
109

1110
To customize the **Runs** tab, refer to [Project page]({{< relref "/guides/models/track/project-page.md#runs-tab" >}}).
1211

12+
If you group runs into experiments, refer to [Set a group in the UI]({{< relref "grouping.md#set-a-group-in-the-ui" >}}).
13+
1314
## Move runs between your projects
1415

1516
To move runs from one project to another:
@@ -20,11 +21,7 @@ To move runs from one project to another:
2021
4. Choose the **Move** button above the table.
2122
5. Select the destination project from the dropdown.
2223

23-
24-
25-
{{< img src="/images/app_ui/howto_move_runs.gif" alt="" >}}
26-
27-
24+
{{< img src="/images/app_ui/howto_move_runs.gif" alt="Demo of moving a run between projects" >}}
2825

2926
## Move runs to a team
3027

@@ -36,4 +33,4 @@ Move runs to a team you are a member of:
3633
4. Choose the **Move** button above the table.
3734
5. Select the destination team and project from the dropdown.
3835

39-
{{< img src="/images/app_ui/demo_move_runs.gif" alt="" >}}
36+
{{< img src="/images/app_ui/demo_move_runs.gif" alt="Demo of moving a run to a team" >}}

0 commit comments

Comments
 (0)