Skip to content

Sweeps updates - #2480

Open
ngrayluna wants to merge 12 commits into
mainfrom
sweeps_updates
Open

ngrayluna wants to merge 12 commits into
mainfrom
sweeps_updates

Conversation

@ngrayluna

Copy link
Copy Markdown
Contributor

Description

Realized that Sweeps flattens YAML objects to make accessing values easier, however, it made debugging my script a pain. Updated docs to make this more clear

@ngrayluna
ngrayluna marked this pull request as ready for review April 17, 2026 18:35
@ngrayluna
ngrayluna requested a review from a team as a code owner April 17, 2026 18:35
@github-actions

github-actions Bot commented Apr 17, 2026

Copy link
Copy Markdown
Contributor
Page Change
Add W And B To Your Code Changed · +70 −64
Define Sweep Configuration Changed · +28 −23

Updated 2026-09-04 00:01:37 UTC for deployment · 31dd994.

@github-actions

github-actions Bot commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-sweeps-updates.mintlify.site

Comment thread models/sweeps/add-w-and-b-to-your-code.mdx Outdated
Comment thread models/sweeps/add-w-and-b-to-your-code.mdx Outdated
Comment thread models/sweeps/add-w-and-b-to-your-code.mdx Outdated
3. Read the YAML configuration file with a Python package such as yaml, and pass the configuration to `wandb.init()`.
4. Pass the configuration object to the config parameter of `wandb.init()`.
5. Retrieve the hyperparameter values from `wandb.Run.config` so that your script uses the values defined in the YAML file instead of hard-coded values. W&B flattens configuration values, so you can access nested values with dot notation or bracket notation as though they were top-level keys.
6. Log the metric that you want to optimize with `wandb.Run.log()`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly, wandb.log() is more idiomatic now

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SDK Team generally advises us to use wandb.Run.log() for a worry-free run management (i.e. no active, hanging runs) 🤔

Comment thread models/sweeps/add-w-and-b-to-your-code.mdx Outdated
Comment thread models/sweeps/add-w-and-b-to-your-code.mdx Outdated
Comment thread models/sweeps/add-w-and-b-to-your-code.mdx Outdated
Comment thread models/sweeps/define-sweep-configuration.mdx
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 2 changed pages: -0.2 (easier).

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
models/sweeps/add-w-and-b-to-your-code.mdx 9.3 9.1 -0.2 +2.8 easier
models/sweeps/define-sweep-configuration.mdx 12.2 12.1 -0.1 +0.7 easier

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
models/sweeps/add-w-and-b-to-your-code.mdx 2 3 +1
models/sweeps/define-sweep-configuration.mdx 3 3 +0

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 35146517395

@mintlify

mintlify Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
wandb 🟢 Ready View Preview Sep 16, 2026, 8:30 PM

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.

3 participants