wandb sync - Weights & Biases Documentation (original) (raw)
Usage
Description
Upload existing local W&B run data to the cloud. Sync offline or incomplete runs from the local wandb directory to the W&B server. If PATH is provided, sync runs at that path. If no path is given, search for a ./wandb directory, then a wandb/ subdirectory. Run without arguments to print a summary of synced and unsynced runs without uploading anything. When syncing a specific path, include TensorBoard event files by default. When using --sync-all, disable TensorBoard by default (use --sync-tensorboard to enable it). PATH is a .wandb file or a run directory that contains a .wandb file. A typical path looks like: ./wandb/run-YYYYMMDD_HHMMSS-RUN_ID/run-RUN_ID.wandb where run-YYYYMMDD_HHMMSS-RUN_ID is the run directory and run-RUN_ID.wandb is the .wandb file. YYYYMMDD_HHMMSS is the timestamp of when the run was created and RUN_ID is the unique ID of the run. For example, to show a summary of local runs and their sync status:
To sync run ID abcd1234 that is locally saved locally in the ./wandb/run-20170617_000000-abcd1234 directory:
wandb sync ./wandb/run-20170617_000000-abcd1234
To sync run abcd1234 by its local .wandb filepath (./wandb/run-20170617_000000-abcd1234/run-abcd1234.wandb):
wandb sync ./wandb/run-20170617_000000-abcd1234/run-abcd1234.wandb
To sync all unsynced runs in the local wandb directory:
To delete local data for runs that have already been synced:
To delete synced runs older than 48 hours without a confirmation prompt:
wandb sync --clean --clean-old-hours 48 --clean-force
Arguments
| Name | Default | Type |
|---|---|---|
| path | PATH | False |
Options
| Flag | Type | Description |
|---|---|---|
| --id | STR | Upload to an existing run ID. Default: None |
| --project, -p | STR | Set the project to upload the run to. Default: None |
| --entity, -e | STR | Set the entity to scope the project to. Default: None |
| --job_type | STR | Set the job type to group related runs. Default: None |
| --sync-tensorboard | BOOL Flag | Sync TensorBoard tfevent files. On by default for specific paths, off for —sync-all. Default: None |
| --include-globs | STR | Include only runs matching these glob patterns (comma-separated). Default: None |
| --exclude-globs | STR | Exclude runs matching these glob patterns (comma-separated). Default: None |
| --include-online | BOOL Flag | Include runs created in online mode. Default: None |
| --include-offline | BOOL Flag | Include runs created in offline mode. Default: None |
| --include-synced | BOOL Flag | Include runs that are already synced. Default: None |
| --mark-synced | BOOL Flag | Mark runs as synced after upload. Default: True |
| --sync-all | BOOL Flag | Sync all unsynced runs in the local wandb directory. Default: False |
| --clean | BOOL Flag | Delete local data for runs that are already synced. Default: False |
| --clean-old-hours | INT | Delete only synced runs older than this many hours (use with —clean). Default: 24 |
| --clean-force | BOOL Flag | Skip the confirmation prompt if —clean is specified. Default: False |
| --show | INT | Set the number of runs to show in the summary. Default: 5 |
| --append | BOOL Flag | Append data to an existing run instead of creating a new run. Default: False |
| --skip-console | BOOL Flag | Skip uploading console logs. Default: False |
| --replace-tags | STR | Rename tags during sync. Use ‘old=new’ pairs separated by commas. Default: None |