Change8

Migrating to Weights & Biases v0.21.1

Version v0.21.1 introduces 1 breaking change. This guide details how to update your code.

Released: 8/7/2025

1
Breaking Changes
3
Migration Steps
12
Affected Symbols

⚠️ Check Your Code

If you use any of these symbols, you need to read this guide:

Api().runsApi().sweepsSweep.nameArtifactregistry iterator __bool__wandb.beta.workflowswandb.VideoInternalArtifactApi().run().filesApi().run().upload_fileload (public API run object)wandb.agent

Breaking Changes

Issue #1

Removed the `__bool__` implementation for registry iterator objects. Code that relied on truthiness of these iterators will now raise a TypeError; replace explicit boolean checks with iteration or use `any()`/`len()` as appropriate.

Migration Steps

  1. 1
    Search for any code that evaluates a registry iterator in a boolean context (e.g., `if iterator:`) and replace it with an explicit check such as `if any(iterator):` or iterate over the object.
  2. 2
    Replace usage of the deprecated `wandb.beta.workflows` module with the recommended stable workflow APIs before the module is removed.
  3. 3
    If your code relied on the previous descending order of `Api().runs` or `Api().sweeps`, adjust any ordering assumptions or explicitly sort the results as needed.

Release Summary

This release adds new summary options, paginated sweeps, pattern filtering for file listings, and faster large‑artifact uploads, while deprecating the beta workflows module and removing `__bool__` from registry iterators.

Need More Details?

View the full release notes and all changes for Weights & Biases v0.21.1.

View Full Changelog