> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# wandb restore

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/v0.26.1/wandb/cli/cli.py#L3155" />

## Usage

```bash theme={null}
restore [OPTIONS] RUN
```

## Description

Restore the code, config, or Docker environement from a previous W\&B run.

Recreate the environment of a previous run so you can reproduce it.
Requires authentication with W\&B.

Restore up to three pieces of state, depending on what the original
run recorded:

1. Config (always): Write the run config to wandb/config.yaml.

2. Git (if available): Check out the original commit on a new
   wandb/run\_id branch. Fetch and apply any saved diff patch.
   If the original commit cannot be found,
   fall back to an upstream commit if the original cannot be found.
   Run this command from the same git repository as the original run. Skip
   this step with `--no-git`.

3. Docker (if available): If the run was executed inside a Docker
   container, start the same image with the original command.

If the run has no git history and no Docker image,
restore only the config.

Accept the run identifier in any of the following formats:
run\_id, project:run\_id, entity/project:run\_id, or entity/project/run\_id .

For example, to restore a run with run ID  in the default project
(stored as the WANDB\_PROJECT environment variable) and entity
(set from WANDB\_ENTITY or the authenticated user's default entity):

```bash theme={null}
wandb restore abcd1234
```

To restore a run from the "foobar" project and "team-awesome" entity with
run ID abcd1234:

```bash theme={null}
wandb restore team-awesome/foobar/abcd1234
```

To restore run abcd1234 without restoring git state. Only restore config
and Docker state:

```bash theme={null}
wandb restore --no-git abcd1234
```

To restore run abcd1234 in detached HEAD mode instead of creating a branch:

```bash theme={null}
wandb restore --no-branch abcd1234
```

To restore run abcd1234 from another team's project:

```bash theme={null}
wandb restore other-team/their-project:abcd1234
```

## Arguments

| Name  | Default | Type |
| ----- | ------- | ---- |
| `run` | STR     | True |

## Options

| Flag            | Type      | Description                                                                                    |
| --------------- | --------- | ---------------------------------------------------------------------------------------------- |
| `--no-git`      | BOOL Flag | Skip git restoration. Only restore config and Docker state. **Default**: False                 |
| `--branch`      | BOOL Flag | Create a wandb/run\_id branch or check out the commit in detached HEAD mode. **Default**: True |
| `--project, -p` | STR       | Specify the project to look up the run in. **Default**: None                                   |
| `--entity, -e`  | STR       | Specify the entity to scope the run lookup to. **Default**: None                               |