Change8

Migrating to Weights & Biases v0.20.0

Version v0.20.0 introduces 5 breaking changes. This guide details how to update your code.

Released: 6/3/2025

5
Breaking Changes
9
Migration Steps
20
Affected Symbols

⚠️ Check Your Code

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

wandb.Tablewandb.Table.log_modeArtifact.add_dirwandb.Imagewandb.Image.maskswandb.Image.boxessync_tensorboardwandb.Mediax_skip_transaction_logwandb.sdk.wandb_run.Run.savewandb.sdk.wandb_run.Run.logwandb.sdk.wandb_run.Run.modewandb.sdk.wandb_run.Run.joinstart_methodArtifact.use_asrun.use_artifactwandb.dockerx_disable_serviceWANDB_DISABLE_SERVICEWANDB_X_DISABLE_SERVICE

Breaking Changes

Issue #1

Disabling the service process has been removed; the `x_disable_service`/`_disable_service` setting and `WANDB_DISABLE_SERVICE`/`WANDB_X_DISABLE_SERVICE` environment variables now raise an error. Update code to rely on the service process being always enabled.

Issue #2

The `wandb.docker` submodule is no longer importable via `import wandb`; attempts to use `wandb.docker` will raise an error. Remove or replace usage.

Issue #3

`wandb.sdk.wandb_run.Run.save` now requires the `glob_str` argument; calls without it will fail. Add a glob pattern argument.

Issue #4

Removed deprecated `wandb.sdk.wandb_run.Run.mode` property and `Run.join` method; accessing them will raise an error. Delete or refactor code that uses them.

Issue #5

Removed the no‑op `sync` argument from `wandb.Run.log`; passing it will raise an error. Remove the argument.

Migration Steps

  1. 1
    Remove any usage of `x_disable_service`, `_disable_service`, `WANDB_DISABLE_SERVICE` or `WANDB_X_DISABLE_SERVICE`; the service process can no longer be disabled.
  2. 2
    Delete imports or calls to `wandb.docker`; replace with alternative container management if needed.
  3. 3
    Update all calls to `wandb.sdk.wandb_run.Run.save` to include a `glob_str` argument (e.g., `run.save(\"*.ckpt\")`).
  4. 4
    Remove references to the deprecated `Run.mode` property and `Run.join` method.
  5. 5
    Eliminate the `sync` argument from `wandb.Run.log` calls.
  6. 6
    If code relied on the `start_method` setting, remove it as it is ignored.
  7. 7
    Replace usage of `Artifact.use_as` and the `use_as` parameter in `run.use_artifact()` with supported alternatives or omit them.
  8. 8
    When using `wandb.Image`, provide the new `normalize` flag if normalization is desired.
  9. 9
    If you need to overwrite files when adding a directory to an artifact, use the new `merge=True` argument.

Release Summary

This release adds new Table log modes, expands Image support, introduces several new parameters, and removes deprecated service‑disable and docker features, with corresponding breaking changes and bug fixes.

Need More Details?

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

View Full Changelog