Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions models/runs/forking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ description: Explore different parameters or models from a specific point in an
title: Fork a run
---

<Warning>
The ability to fork a run is in active development and in private preview. Contact W&B Support at support@wandb.com to request access to this feature.
</Warning>
<Note>
The ability to fork a run is in active development. It is in preview for Multi-tenant Cloud and Dedicated Cloud, and not yet available in Self-Managed.
</Note>

You can explore different hyperparameters or models from a specific point in an experiment without impacting the original run. To do this, fork from an existing W&B run.

Expand Down
34 changes: 16 additions & 18 deletions models/runs/rewind.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,25 @@ title: Rewind a run

Rewind a run to modify the history of a run. When you rewind a run, W&B resets the state of the run to the specified step while maintaining the same run ID.

<Warning>
The option to rewind a run is in private preview and in active development. Due to known performance limitations with Rewind, W&B typically recommends [Forking](./forking) as an alternative.
<Note>
The ability to rewind a run is in active development. It is in preview for Multi-tenant Cloud and Dedicated Cloud, and not yet available in Self-Managed.

Due to known performance limitations with rewind, W&B typically recommends [Forking](./forking) as an alternative.
</Note>

### Prerequisites
Before you rewind a run, ensure you meet the following prerequisites:

W&B currently does not support:
* To rewind a run, you must have [W&B Python SDK](https://pypi.org/project/wandb/) version >= `0.17.1`.
* You must use monotonically increasing steps. This does not work with non-monotonic steps defined with [`define_metric()`](/models/ref/python/experiments/run#define_metric) because it disrupts the required chronological order of run history and system metrics.

### Limitations
Rewind does not support the following:
* **Log rewind**: Logs are reset in the new run segment.
* **System metrics rewind**: W&B logs only new system metrics after the rewind point.
* **Artifact association**: W&B associates artifacts with the source run that produces them.

Contact W&B Support at support@wandb.com to request access to this feature.
</Warning>

W&B recomputes the summary metrics for the run you rewind based on the newly logged history. This means the following behavior:
W&B recomputes the summary metrics for the run you rewind based on the newly logged history, with the following results:
- **History truncation**: W&B truncates the history to the rewind point, allowing new data logging.
- **Summary metrics**: Recomputed based on the newly logged history.
- **Configuration preservation**: W&B preserves the original configurations and you can merge new configurations.
Expand All @@ -26,22 +33,13 @@ W&B recomputes the summary metrics for the run you rewind based on the newly log
- **Run archiving**: W&B archives the original runs. Runs are accessible from the [Run Overview](./#overview-tab) tab.
- **Artifact association**: Associates artifacts with the run that produce them. */}

<Note>
**Rewind and forking compatibility**
### Rewind and forking compatibility

Forking complements a rewind.

When you fork from a run, W&B creates a new branch off a run at a specific point to try different parameters or models.

When you rewind a run, W&B lets you correct or modify the run history itself.
</Note>

## Prerequisites

Before you rewind a run, ensure you meet the following prerequisites:

* To rewind a run, you must have [W&B Python SDK](https://pypi.org/project/wandb/) version >= `0.17.1`.
* You must use monotonically increasing steps. This does not work with non-monotonic steps defined with [`define_metric()`](/models/ref/python/experiments/run#define_metric) because it disrupts the required chronological order of run history and system metrics.

## Rewind a run

Expand Down Expand Up @@ -120,4 +118,4 @@ forked_run = wandb.init(
for i in range(500, 1000):
forked_run.log({"metric": i*3})
forked_run.finish()
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ keywords: ["Logs", "Metrics"]

To overwrite logs from previous steps, use [forking](/models/runs/forking) and [rewind](/models/runs/rewind).

<Note>
The ability to fork or rewind a run is in active development. It is in preview for Multi-tenant Cloud and Dedicated Cloud, and not yet available in Self-Managed.
</Note>

---

{/* AUTO-GENERATED: tab badges */}
<Badge stroke shape="pill" color="orange" size="md">[Logs](/support/models/tags/logs)</Badge><Badge stroke shape="pill" color="orange" size="md">[Metrics](/support/models/tags/metrics)</Badge>
{/* END AUTO-GENERATED: tab badges */}
{/* END AUTO-GENERATED: tab badges */}
2 changes: 1 addition & 1 deletion support/models/tags/logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2"
"Is the logging function lazy? I don't want to depend on the network to send results to your servers while executing loc ...
</Card>
<Card title="How can I overwrite the logs from previous steps?" href="/support/models/articles/how-can-i-overwrite-the-logs-from-previo" arrow="true" horizontal>
To overwrite logs from previous steps, use forking and rewind.
To overwrite logs from previous steps, use forking and rewind. The ability to fork or rewind a run is in active developm ...
</Card>
<Card title="How do I log a list of values?" href="/support/models/articles/how-do-i-log-a-list-of-values" arrow="true" horizontal>
These examples show logging losses a couple of different ways using wandb.Run.log(). For more, see the documentation on ...
Expand Down
2 changes: 1 addition & 1 deletion support/models/tags/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2"
There are several ways to manage experiments. For complex workflows, use multiple runs and set the group parameters in w ...
</Card>
<Card title="How can I overwrite the logs from previous steps?" href="/support/models/articles/how-can-i-overwrite-the-logs-from-previo" arrow="true" horizontal>
To overwrite logs from previous steps, use forking and rewind.
To overwrite logs from previous steps, use forking and rewind. The ability to fork or rewind a run is in active developm ...
</Card>
<Card title="How do I fix `Rate limit exceeded` errors when logging metrics?" href="/support/models/articles/rate-limit-exceeded-on-metric-logging" arrow="true" horizontal>
If you receive an HTTP 429 Rate limit exceeded error when calling wandb.log(), you are exceeding the rate limit quota fo ...
Expand Down
Loading