Skip to main content
GitHub source Restore the code, config, and Docker state from a previous run. Recreate the environment of a previous W&B run so you can reproduce it. Run this command from the same git repository as the original run, unless you pass the --no-git flag. Restore in three steps:
  1. Git — Check out the original commit on a new branch (wandb/run_id), fetch and apply any saved diff patch, and fall back to an upstream commit if the original commit cannot be found.
  2. Config — Write the run config to wandb/config.yaml.
  3. Docker — If the run used Docker, start the same image with the original command.
Accept run in any of these formats:
  • run_id
  • project:run_id
  • entity/project:run_id
  • entity/project/run_id
Examples: Restore a run by ID 
wandb restore abcd1234
Restore a run from a specific project and entity 
wandb restore entity/project:abcd1234
Restore only config and Docker state, skip git checkout 
wandb restore --no-git abcd1234
Restore in detached HEAD mode instead of creating a branch 
wandb restore --no-branch abcd1234

​
Usage

wandb restore [OPTIONS] RUN

​
Options

​
no_git

Skip git restoration. Only restore config and Docker state.
FlagDefaultType
--no-gitFalseBOOL

​
branch

Create a wandb/run_id branch or check out the commit in detached HEAD mode.
FlagDefaultType
--branchTrueBOOL

​
project

Specify the project to look up the run in.
FlagDefaultType
-p, --projectNoneSTRING

​
entity

Specify the entity to scope the run lookup to.
FlagDefaultType
-e, --entityNoneSTRING

​
help

Show this message and exit.
FlagDefaultType
--helpFalseBOOL

​
CLI Help

Usage: restore [OPTIONS] RUN

  Restore the code, config, and Docker state from a previous run.

  Recreate the environment of a previous W&B run so you can reproduce it. Run
  this command from the same git repository as the original run, unless you
  pass the `--no-git` flag.

  Restore in three steps:

  1. Git — Check out the original commit on a new branch (`wandb/run_id`),
  fetch and apply any saved diff patch, and fall back to an upstream    commit
  if the original commit cannot be found. 2. Config — Write the run config to
  `wandb/config.yaml`. 3. Docker — If the run used Docker, start the same
  image with the    original command.

  Accept run in any of these formats:

  - `run_id` - `project:run_id` - `entity/project:run_id` -
  `entity/project/run_id`

  Examples:

  Restore a run by ID

  ```bash wandb restore abcd1234 ```

  Restore a run from a specific project and entity

  ```bash wandb restore entity/project:abcd1234 ```

  Restore only config and Docker state, skip git checkout

  ```bash wandb restore --no-git abcd1234 ```

  Restore in detached HEAD mode instead of creating a branch

  ```bash wandb restore --no-branch abcd1234 ```

Options:
  --no-git                Skip git restoration. Only restore config and Docker
                          state.
  --branch / --no-branch  Create a wandb/run_id branch or check out the commit
                          in detached HEAD mode.
  -p, --project TEXT      Specify the project to look up the run in.
  -e, --entity TEXT       Specify the entity to scope the run lookup to.
  --help                  Show this message and exit.