Runs: Rewrite Runs section #2011

ngrayluna · 2025-12-23T00:34:02Z

Description

Classic Noah, started off as a simple "update images" task...then grew to a complete Runs rewrite...here's a summary of what I did:

New Documentation Pages (7 added):

customize-run-display.mdx - How to customize run display settings
delete-runs.mdx - Instructions for deleting runs
run-identifiers.mdx - Explanation of run IDs and identifiers
run-states.mdx - Documentation on run states
search-runs.mdx - How to search for runs
stop-runs.mdx - How to stop runs
view-logged-runs.mdx - Viewing logged run data

Renamed File:

multiple-runs-per-process.mdx → initialize-run.mdx

Major Edits:

models/runs.mdx - Significantly reduced (597 lines removed) as content was split out
models/runs/grouping.mdx - Reorganized and updated
models/runs/forking.mdx - Expanded with more content
models/runs/filter-runs.mdx - Updates and improvements
Updated navigation in docs.json

Image Cleanup:

Removed 17 outdated images/GIFs
Added 6 new, updated images

github-actions · 2025-12-23T00:34:45Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 78%, saving 926.9 KB.

Filename	Before	After	Improvement	Visual comparison
`images/runs/unique-run-id.png`	472.9 KB	103.7 KB	78.1%	View diff
`images/runs/group_job_type.png`	384.5 KB	92.6 KB	75.9%	View diff
`images/runs/run_log_example_2.png`	330.5 KB	64.7 KB	80.4%	View diff

github-actions · 2025-12-23T00:36:31Z

📚 Mintlify Preview Links

🔗 View Full Preview

🔄 Renamed/Moved (1 total)

📄 Pages (1)

Old Path → New Path	Preview
`models/runs/multiple-runs-per-process.mdx` → `models/runs/initialize-run.mdx`	Initialize Run

✨ Added (13 total)

📄 Pages (7)

File	Preview
`models/runs/customize-run-display.mdx`	Customize Run Display
`models/runs/delete-runs.mdx`	Delete Runs
`models/runs/run-identifiers.mdx`	Run Identifiers
`models/runs/run-states.mdx`	Run States
`models/runs/search-runs.mdx`	Search Runs
`models/runs/stop-runs.mdx`	Stop Runs
`models/runs/view-logged-runs.mdx`	View Logged Runs

🖼️ Images (6)

File	Preview
`images/runs/group_job_type.png`	View Group Job Type
`images/runs/group_name_3_groups.png`	View Group Name 3 Groups
`images/runs/run_logs_info.png`	View Run Logs Info
`images/runs/run_table_all.png`	View Run Table All
`images/runs/runs_artifacts_info.png`	View Runs Artifacts Info
`images/runs/runs_files_info.png`	View Runs Files Info

📝 Changed (26 total)

📄 Pages (23)

File	Preview
`ja/models/runs.mdx`	Runs
`ja/models/runs/filter-runs.mdx`	Filter Runs
`ja/models/runs/grouping.mdx`	Grouping
`ja/models/runs/manage-runs.mdx`	Manage Runs
`ja/models/track/project-page.mdx`	Project Page
`ko/models/runs.mdx`	Runs
`ko/models/runs/filter-runs.mdx`	Filter Runs
`ko/models/runs/grouping.mdx`	Grouping
`ko/models/runs/manage-runs.mdx`	Manage Runs
`ko/models/track/project-page.mdx`	Project Page
... and 13 more files

🖼️ Images (2)

File	Preview
`images/runs/run_log_example_2.png`	View Run Log Example 2
`images/runs/unique-run-id.png`	View Unique Run Id

⚙️ Other (1)

File
`docs.json`

🗑️ Deleted (18 total)

View deleted files

🖼️ Images (18)

File
`images/app_ui/artifacts_tab.png`
`images/app_ui/demo_move_runs.gif`
`images/app_ui/export_to_csv.gif`
`images/app_ui/howto_move_runs.gif`
`images/app_ui/wandb-run-page-workspace-tab.png`
`images/app_ui/wandb_run_overview_page.png`
`images/app_ui/wandb_run_page_files_tab.png`
`images/app_ui/wandb_run_page_log_tab.png`
`images/data_vis/group.png`
`images/runs/demo-project.gif`
... and 8 more images

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: d3164d4 at 2025-12-30 23:05:31 UTC

github-actions · 2025-12-23T23:08:11Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 8.7%, saving 9.0 KB.

Filename	Before	After	Improvement	Visual comparison
`images/runs/unique-run-id.png`	103.7 KB	94.6 KB	8.7%	View diff

2 images did not require optimisation.

github-actions · 2025-12-29T23:19:58Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 79.5%, saving 241.1 KB.

Filename	Before	After	Improvement	Visual comparison
`images/runs/group_name_3_groups.png`	303.3 KB	62.2 KB	79.5%	View diff

3 images did not require optimisation.

github-actions · 2025-12-30T00:56:38Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 78.8%, saving 1.4 MB.

Filename	Before	After	Improvement	Visual comparison
`images/runs/run_logs_info.png`	623.5 KB	130.0 KB	79.1%	View diff
`images/runs/run_table_all.png`	602.3 KB	144.1 KB	76.1%	View diff
`images/runs/runs_files_info.png`	337.3 KB	62.7 KB	81.4%	View diff
`images/runs/runs_artifacts_info.png`	276.5 KB	53.2 KB	80.8%	View diff

4 images did not require optimisation.

github-actions · 2025-12-30T01:00:31Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 7.6%, saving 24.8 KB.

Filename	Before	After	Improvement	Visual comparison
`images/runs/run_table_all.png`	144.1 KB	133.8 KB	7.2%	View diff
`images/runs/run_logs_info.png`	130.0 KB	122.2 KB	6.0%	View diff
`images/runs/runs_artifacts_info.png`	53.2 KB	46.5 KB	12.5%	View diff

5 images did not require optimisation.

mdlinville · 2025-12-31T21:54:49Z

models/automations/automation-events.mdx


 ### Run events
-An automation can be triggered by a change in a [run's status](/models/#run-states) or a change in a [metric value](/models/track/log/#what-data-is-logged-with-specific-wb-api-calls).
+An automation can be triggered by a change in a [run's status](/models/(/models/runs/run-states) or a change in a [metric value](/models/track/log/#what-data-is-logged-with-specific-wb-api-calls).


Munged URL? One more instance in this file.

mdlinville · 2025-12-31T21:56:36Z

models/runs/customize-run-display.mdx

@@ -0,0 +1,96 @@
+---
+title: View all runs a project


Suggested change

title: View all runs a project

title: View all runs a project

sidebarTitle: View all runs

I think it will improve the left nav to shorten some of these page nav titles.

mdlinville · 2025-12-31T21:57:27Z

models/runs/customize-run-display.mdx

@@ -0,0 +1,96 @@
+---
+title: View all runs a project
+description: This section shows how to customize how runs are displayed in your project's runs table


Suggested change

description: This section shows how to customize how runs are displayed in your project's runs table

description: Details about customizing how runs are displayed in your project's runs table

mdlinville · 2025-12-31T21:58:03Z

models/runs/customize-run-display.mdx

+A workspace is limited to displaying a maximum of 1000 runs, regardless of its configuration.
+</Note> */}
+
+View all runs logged to your W&B project in the **Runs** tab of your project sidebar. The *Runs table* shows details about all of your runs in a project. Use the Runs table to compare runs, sort runs by specific columns, and organize runs into groups.


To connect the dots, is it worth mentioning that the Runs Table is in the Runs Tab, and that the Runs Table and Workspace runs list share a config?

mdlinville · 2025-12-31T21:59:41Z

models/runs/customize-run-display.mdx

+    <img src="/images/runs/run_table_all.png" alt="Runs table"  />
+</Frame>
+
+## Add columns


These sections could be consolidated as H3s in a "Manage columns" section, all the way through Hide Columns. This would help the right-hand TOC.

mdlinville · 2025-12-31T22:28:41Z

models/runs/grouping.mdx


-To sort the list of runs by any visible column:
+<Note>
+W&B stores job types as a run [`wandb.Run.job_type`](/models/ref/python/experiments/run#property-run-job-type) property.


Suggested change

W&B stores job types as a run [`wandb.Run.job_type`](/models/ref/python/experiments/run#property-run-job-type) property.

Specify the job type in the run's [`wandb.Run.job_type`](/models/ref/python/experiments/run#property-run-job-type) property.

mdlinville · 2025-12-31T22:29:23Z

models/runs/grouping.mdx

+Organize runs by their *job type*. A job type indicates the function of a run, such as `preprocessing`, `training`, or `evaluation`. 

-To sort the list of runs by any visible column:
+<Note>


Not sure this needs to be a note or if the sentence is necessary at all. It seems to be covered in line 102.

mdlinville · 2025-12-31T22:30:25Z

models/runs/grouping.mdx

+```

-Suppose you set grouping in `wandb.init()`, we will group runs by default in the UI. You can toggle this on and off by clicking the **Group** button at the top of the table. Here's an [example project](https://wandb.ai/carey/group-demo?workspace=user-carey) generated from [sample code](https://wandb.me/grouping) where we set grouping. You can click on each "Group" row in the sidebar to get to a dedicated group page for that experiment.
+The following image shows runs organized by the job type:


Suggested change

The following image shows runs organized by the job type:

The following image shows runs organized by job type:

mdlinville · 2025-12-31T22:30:59Z

models/runs/grouping.mdx

+
+1. In your project sidebar, select the **Runs** tab.
+2. Above the list of runs, click the **Group** button.
+3. From the dropdown, select either **Job Type**.


Suggested change

3. From the dropdown, select either **Job Type**.

3. From the dropdown, select **Job Type**.

mdlinville · 2025-12-31T22:32:14Z

models/runs/grouping.mdx

Stopped review after this file, for now.

mdlinville · 2026-01-05T21:14:19Z

models/runs/manage-runs.mdx

-
-If you group runs into experiments, refer to [Set a group in the UI](/models/runs/grouping/#set-a-group-in-the-ui).
-
 ## Move runs between your projects


How about section titles like "Move a run to a different project" and "Move a run to a different team"? I now you can move multiple runs at once, but I think you can't move multiple runs to different projects / teams at once, and the "between" is not the most important part because you probably moving only in one direction at a time. WDYT? Though as noted in my comment around line 22, I'm not sure this really needs to be presented as two different headings at all.

mdlinville · 2026-01-05T21:14:50Z

models/runs/manage-runs.mdx

 2. Select the **Runs** tab from the project sidebar.
 3. Select the checkbox next to the runs you want to move.
-4. Choose the **Move** button above the table.
+4. Choose the **Move to project** button above the table.


Suggested change

4. Choose the **Move to project** button above the table.

4. Click the **Move to project** button above the table.

Not sure about choosing a button.

mdlinville · 2026-01-05T21:16:20Z

models/runs/manage-runs.mdx

-</Frame>
-
-## Move runs to a team
+## Move runs between your teams


Unless I'm missing something, this is still moving a run to a new project, right? It just happens to be a project owned by a different team. This heading structure may give a reader the idea that you could move a run to a different team without moving it to a project owned by that team.

mdlinville · 2026-01-05T21:18:48Z

models/runs/rewind.mdx

 * **Artifact association**: W&B associates artifacts with the source run that produces them.
 </Warning>

 <Note>


To avoid note stacking, consider reworking this as a Requirements or Prerequisites section?

mdlinville · 2026-01-05T21:20:09Z

models/runs/rewind.mdx

 * You must use monotonically increasing steps. This does not work with non-monotonic steps defined with [`define_metric()`](/models/ref/python/experiments/run#define_metric) because it disrupts the required chronological order of run history and system metrics.
 </Note>

 Rewind a run to correct or modify the history of a run without losing the original data. In addition, when you 


I'd move this paragraph up to the very top, above the warning. Then the reader can see what the page is about before dealing with the private preview warning and the requirements.

mdlinville · 2026-01-05T21:48:12Z

models/runs/view-logged-runs.mdx

+description: Learn how to view a specific logged run and its properties using the W&B App or the LEET terminal UI.
+---
+
+View information about a specific run such as the state of the run, artifacts logged to the run, metrics logged to a run, system metrics, and more.


Suggested change

View information about a specific run such as the state of the run, artifacts logged to the run, metrics logged to a run, system metrics, and more.

View information about a specific run, such as its current state, artifacts, metrics, and more.

mdlinville · 2026-01-05T21:48:56Z

models/runs/view-logged-runs.mdx

+https://wandb.ai/<team-name>/<project-name>/runs/<run-id>
+```
+
+Where values enclosed in angle brackets (`< >`) are placeholders for the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).


Suggested change

Where values enclosed in angle brackets (`< >`) are placeholders for the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).

Replace values enclosed in angle brackets (`< >`) with the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).

mdlinville · 2026-01-05T21:49:13Z

models/runs/view-logged-runs.mdx

+
+Where values enclosed in angle brackets (`< >`) are placeholders for the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).
+
+After you select a run, explore its properties by navigating through the tabs: [Overview](/models/runs/view-logged-runs#overview), [Logs](/models/runs/view-logged-runs#logs), [Files](/models/runs/view-logged-runs#files), [Code](/models/runs/view-logged-runs#code), and [Artifacts](/models/runs/view-logged-runs#artifacts).


Suggested change

After you select a run, explore its properties by navigating through the tabs: [Overview](/models/runs/view-logged-runs#overview), [Logs](/models/runs/view-logged-runs#logs), [Files](/models/runs/view-logged-runs#files), [Code](/models/runs/view-logged-runs#code), and [Artifacts](/models/runs/view-logged-runs#artifacts).

Explore the run's properties by navigating through the tabs: [Overview](/models/runs/view-logged-runs#overview), [Logs](/models/runs/view-logged-runs#logs), [Files](/models/runs/view-logged-runs#files), [Code](/models/runs/view-logged-runs#code), and [Artifacts](/models/runs/view-logged-runs#artifacts).

mdlinville · 2026-01-05T21:50:38Z

models/runs/view-logged-runs.mdx

+</Tabs>
+
+
+### Overview


I'm not sure but I think that all of these H3s relate only to the W&B App tab above, not the LEET tab. Can you confirm?

mdlinville · 2026-01-05T21:51:27Z

models/runs.mdx

Now reviewed up to here.

mdlinville

Here's the rest of the first pass review. :)

mdlinville · 2026-01-05T21:53:18Z

models/runs.mdx

 A *run* is a single unit of computation logged by W&B. You can think of a W&B Run as an atomic element of your whole project. In other words, each run is a record of a specific computation, such as training a model and logging the results, hyperparameter sweeps, and so forth.

-Common patterns for initiating a run include, but are not limited to: 
+Common reasons for initiating a run include, but are not limited to: 


Suggested change

Common reasons for initiating a run include, but are not limited to:

Some common reasons for initiating a run include:

But this seems like kind of a weird way to talk about this.

mdlinville · 2026-01-05T21:54:55Z

models/runs/initialize-run.mdx

I think you need a redirect for this

ngrayluna and others added 8 commits December 19, 2025 15:30

Up to stop run section

91df724

refactoring runs overview page

7328a98

Refactored run identifiers page

8731c86

rearranged topics. First draft of forked runs

6825ccc

Fork a run draft

6e8955a

Updated fork a run description

6d9a073

WIP

1ba0783

Optimised images with calibre/image-actions

c68e2ea

mintlify bot deployed to staging December 23, 2025 00:36 View deployment

mintlify bot deployed to staging December 23, 2025 00:37 View deployment

ngrayluna and others added 3 commits December 23, 2025 15:07

wip

6181ed3

Rename markdown file name

3ef20d0

Optimised images with calibre/image-actions

22e5789

mintlify bot deployed to staging December 23, 2025 23:09 View deployment

mintlify bot deployed to staging December 23, 2025 23:10 View deployment

Rename file, hashtags

913d793

mintlify bot deployed to staging December 23, 2025 23:36 View deployment

small edits

0df3e1a

mintlify bot deployed to staging December 23, 2025 23:43 View deployment

fix links

a41a431

mintlify bot deployed to staging December 23, 2025 23:46 View deployment

removed old gifs.

b3be29d

mintlify bot deployed to staging December 24, 2025 19:37 View deployment

ngrayluna and others added 2 commits December 29, 2025 15:19

Fixed grouping page

5dcee78

Optimised images with calibre/image-actions

37a72ce

mintlify bot deployed to staging December 29, 2025 23:22 View deployment

Optimised images with calibre/image-actions

864c5b0

mintlify bot deployed to staging December 30, 2025 00:59 View deployment

change titles

0019283

mintlify bot deployed to staging December 30, 2025 01:00 View deployment

Optimised images with calibre/image-actions

f83dc29

mintlify bot deployed to staging December 30, 2025 01:03 View deployment

ngrayluna added 3 commits December 29, 2025 21:37

removed old gif

14c9445

removed unused images

c02ab84

removed outdated images

d90f19a

mintlify bot deployed to staging December 30, 2025 05:38 View deployment

Merge branch 'main' into update_run_overview_page

ebf2a82

mintlify bot deployed to staging December 30, 2025 05:42 View deployment

removed more old images from ko and ja

5faf40b

mintlify bot deployed to staging December 30, 2025 15:48 View deployment

word smithing, removed old gifs

4ab407c

mintlify bot deployed to staging December 30, 2025 18:05 View deployment

ngrayluna added 2 commits December 30, 2025 14:22

more updates on run identifiers

ac4728f

minor edits

480aa5e

ngrayluna marked this pull request as ready for review December 30, 2025 22:54

ngrayluna requested a review from a team as a code owner December 30, 2025 22:54

ngrayluna changed the title ~~Runs: Update run overview page~~ Runs: Rewrite Runs section Dec 30, 2025

mintlify bot deployed to staging December 30, 2025 22:56 View deployment

fix broken link

d3164d4

mintlify bot deployed to staging December 30, 2025 23:05 View deployment

mdlinville reviewed Dec 31, 2025

View reviewed changes

mdlinville reviewed Jan 5, 2026

View reviewed changes

	title: View all runs a project
	title: View all runs a project
	sidebarTitle: View all runs

	description: This section shows how to customize how runs are displayed in your project's runs table
	description: Details about customizing how runs are displayed in your project's runs table

	W&B stores job types as a run [`wandb.Run.job_type`](/models/ref/python/experiments/run#property-run-job-type) property.
	Specify the job type in the run's [`wandb.Run.job_type`](/models/ref/python/experiments/run#property-run-job-type) property.

	The following image shows runs organized by the job type:
	The following image shows runs organized by job type:

	3. From the dropdown, select either Job Type.
	3. From the dropdown, select Job Type.


		If you group runs into experiments, refer to [Set a group in the UI](/models/runs/grouping/#set-a-group-in-the-ui).

		## Move runs between your projects

	4. Choose the Move to project button above the table.
	4. Click the Move to project button above the table.

	View information about a specific run such as the state of the run, artifacts logged to the run, metrics logged to a run, system metrics, and more.
	View information about a specific run, such as its current state, artifacts, metrics, and more.

	Where values enclosed in angle brackets (`< >`) are placeholders for the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).
	Replace values enclosed in angle brackets (`< >`) with the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).


		Where values enclosed in angle brackets (`< >`) are placeholders for the actual values of the team name, project name, and [run ID](/models/runs/run-identifiers#run-id).

		After you select a run, explore its properties by navigating through the tabs: [Overview](/models/runs/view-logged-runs#overview), [Logs](/models/runs/view-logged-runs#logs), [Files](/models/runs/view-logged-runs#files), [Code](/models/runs/view-logged-runs#code), and [Artifacts](/models/runs/view-logged-runs#artifacts).

	After you select a run, explore its properties by navigating through the tabs: [Overview](/models/runs/view-logged-runs#overview), [Logs](/models/runs/view-logged-runs#logs), [Files](/models/runs/view-logged-runs#files), [Code](/models/runs/view-logged-runs#code), and [Artifacts](/models/runs/view-logged-runs#artifacts).
	Explore the run's properties by navigating through the tabs: [Overview](/models/runs/view-logged-runs#overview), [Logs](/models/runs/view-logged-runs#logs), [Files](/models/runs/view-logged-runs#files), [Code](/models/runs/view-logged-runs#code), and [Artifacts](/models/runs/view-logged-runs#artifacts).

	Common reasons for initiating a run include, but are not limited to:
	Some common reasons for initiating a run include:

Runs: Rewrite Runs section #2011

Are you sure you want to change the base?

Runs: Rewrite Runs section #2011

Conversation

ngrayluna commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions bot commented Dec 23, 2025

Uh oh!

github-actions bot commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Mintlify Preview Links

🔄 Renamed/Moved (1 total)

📄 Pages (1)

✨ Added (13 total)

📄 Pages (7)

📝 Changed (26 total)

📄 Pages (23)

🖼️ Images (2)

🗑️ Deleted (18 total)

Uh oh!

github-actions bot commented Dec 23, 2025

Uh oh!

github-actions bot commented Dec 29, 2025

Uh oh!

github-actions bot commented Dec 30, 2025

Uh oh!

github-actions bot commented Dec 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdlinville left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

ngrayluna commented Dec 23, 2025 •

edited

Loading

github-actions bot commented Dec 23, 2025 •

edited

Loading