Skip to content

Draft improvements from assistant conversations: run moves and nested config#2830

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/8476678c
Open

Draft improvements from assistant conversations: run moves and nested config#2830
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/8476678c

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Closes two recurring documentation gaps surfaced by recent assistant conversation buckets: users repeatedly ask whether runs can be moved programmatically, and how to put a nested dictionary into wandb.config.

Changes

  • models/runs/manage-runs.mdx: state explicitly that moving runs is UI-only with no SDK or Public API equivalent, that copying runs is not supported, and point to Run.delete() as the one run-management call available from the Public API.
  • models/track/config.mdx: add a "Nested dictionaries in config" subsection explaining that config-defaults.yaml (desc/value) does not support nested dicts inline, showing the Python wandb.init(config=...) pattern, and noting that W&B flattens nested keys with dots in the UI and Public API filters.

Context

Recent assistant traffic shows repeated questions like "are there API endpoints to move runs", "are there programmatic ways to move runs", and YAML/config questions where users tried to encode nested dicts in config-defaults.yaml. The existing pages described the supported paths but did not call out the unsupported ones, so the assistant had to infer the negative answer each time.

@mintlify
mintlify Bot requested a review from a team as a code owner June 29, 2026 13:10
@mintlify

mintlify Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Jun 29, 2026, 1:15 PM

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (2 total)

📄 Pages (2)

File Preview
models/runs/manage-runs.mdx Manage Runs
models/track/config.mdx Config

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: c6c117d at 2026-07-16 17:05:03 UTC

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-mintlify-8476678c.mintlify.site

@johndmulhausen

Copy link
Copy Markdown
Contributor

📋 Validation of technical assertions

Every claim below was checked against the truth on the ground using Glean
(Slack and Jira) and Sourcegraph (the implementing code), then put through an
adversarial verification pass.
10 assertions · ✅ 5 confirmed · 🟡 0 partial · ⚠️ 3 qualified/reframed · ⛔ 0 could not validate · ❌ 2 refuted.
Two claims were refuted and require correction before merge; three more need narrower wording.

# Assertion in the docs Verdict Evidence (truth on the ground) Source
1 The W&B App UI supports moving runs between projects or teams. · models/runs/manage-runs.mdx:10 ✅ Confirmed The app invokes the moveRuns mutation with destination entity and project parameters, and the backend resolves that mutation. core:runs.ts#L301; core:mutation.go#L2220
2 Neither the Python SDK nor the Public API provides a method to move runs between projects or teams. · models/runs/manage-runs.mdx:10 ✅ Confirmed (qualified) No public move method exists in the Python Public API; the app uses an internal GraphQL moveRuns mutation. Qualifier: “UI only” describes the supported public workflow, not an underlying technical impossibility. wandb:runs.py#L937; core:runs.ts#L301
3 W&B does not support copying runs. · models/runs/manage-runs.mdx:10 ✅ Confirmed (qualified) Recent support guidance explicitly distinguishes supported UI moves from unsupported copying. Qualifier: run forking and internal project cloning are different, narrower capabilities. support Slack; wandb:wandb_settings.py#L281; core:tasks.go#L2419
4 Run.delete() deletes a run through the Python Public API. · models/runs/manage-runs.mdx:26 ✅ Confirmed Run.delete() is a public method that deletes the run through the client. wandb:runs.py#L981
5 Deletion is the only run-management operation available through the Public API. · models/runs/manage-runs.mdx:26 ❌ Refuted The public Run class also exposes update(), save(), and update_state()resolve before merge. wandb:runs.py#L937
6 The desc/value schema in config-defaults.yaml does not support inline nested dictionaries. · models/track/config.mdx:260 ❌ Refuted The loader extracts each top-level value without constraining its type, and the backend explicitly flattens map values — resolve before merge. wandb:config_util.py#L66; core:utils.go#L389
7 A nested dictionary can be passed directly to wandb.init(config=...). · models/track/config.mdx:260-271 ✅ Confirmed The SDK sanitizes nested mappings and has a unit test that initializes a run with nested config. wandb:wandb_config.py#L252; wandb:test_wandb_config.py#L126
8 W&B displays nested dictionaries as dotted keys in the UI. · models/track/config.mdx:275 ⚠️ Reframed (was “displays … in the UI”) Some field and table surfaces flatten nested config to dotted keys, but Run Overview can preserve nested structure. The claim should name the applicable UI surfaces instead of describing all UI display. core:utils.go#L270; core:runs.ts#L633
9 Public API filters address nested config with dotted keys. · models/track/config.mdx:275 ✅ Confirmed Public API examples and the query generator both use config.<nested.path> filter keys. wandb:api.py#L1179; wandb:query_generator.py#L59
10 In Python, normal dictionary indexing accesses nested config values. · models/track/config.mdx:275 ✅ Confirmed Nested indexing reads values as shown. Directly mutating a nested value may not synchronize, but that does not affect the documented access pattern. wandb:test_wandb_config.py#L126; engineering Slack

Open items — recommended next steps

  • Added photos to GitHub repo #5 — Public API operations: Replace the exclusivity claim. Run.delete() is the deletion method, but it is not the Public API's only run-management operation.
  • Revert "Added photos to GitHub repo" #6 — nested config-defaults.yaml values: Correct the schema description to say that nested mappings are supported when the mapping is the top-level key's value.

Deviation from the source

The proposed additions contain two universal claims that the implementation contradicts: deletion is not the Public API's only run-management operation, and config-defaults.yaml values are not restricted to non-mapping types. The inline suggestions reconcile both claims with the pinned source.


🤖 Generated by the CoreWeave Docs Team's Validator (beta-validator v1.0.0). Sources are linked inline; this is an accuracy aid, not a substitute for SME review.

Comment thread models/runs/manage-runs.mdx Outdated
Comment thread models/track/config.mdx Outdated
@johndmulhausen

Copy link
Copy Markdown
Contributor

Validator and style guide corrections applied.

@johndmulhausen
johndmulhausen enabled auto-merge (squash) July 16, 2026 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant