Skip to main content
Each configured entity becomes a folder of projects and runs. A run folder holds its metadata, config, summary and full metric history as JSON, plus the files the run uploaded.

Setup

Create a key under API Keys in User Settings with Create new API key, and copy it: W&B shows the full key only once. The key reads what its user can read. Set entities to the user or team segment of a project URL (wandb.ai/<entity>/<project>); Mirage does not discover entities from the key.

Connect

workspace.yaml

Layout

  • Run IDs name the folders; runs that share a display name stay separate. find /wandb/my-team -maxdepth 3 -name run.json lists every run path.
  • run.json holds identity, state, tags, creator (not the key’s user) and counts. summary.json is the stored summary, which can differ from the best value in history. history.jsonl is the full, unsampled history in order.
  • Listings follow W&B pagination: page_size defaults to 100 (at most 1000) and max_pages to 10000; running out fails rather than return a partial list. Recursive du stops at 1000 entries.

Sample runs

The mount is read-only. It registers no write operations and no W&B CLI.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.