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. Setentities to the user or team
segment of a project URL (wandb.ai/<entity>/<project>); Mirage does not
discover entities from the key.
Connect
- YAML
- Python
- TypeScript
workspace.yaml
Layout
- Run IDs name the folders; runs that share a display name stay separate.
find /wandb/my-team -maxdepth 3 -name run.jsonlists every run path. run.jsonholds identity, state, tags, creator (not the key’s user) and counts.summary.jsonis the stored summary, which can differ from the best value in history.history.jsonlis the full, unsampled history in order.- Listings follow W&B pagination:
page_sizedefaults to 100 (at most 1000) andmax_pagesto 10000; running out fails rather than return a partial list. Recursivedustops at 1000 entries.
Sample runs
SDK guides
Python
Every config field, the VFS.md and write support.
TypeScript
Every config field, the VFS.md and write support.