Example: Forking long training runs

[LeoRoccoBreedt]

Description

Include a summary of the changes and the related issue.

Related to: <ClickUp/JIRA task name>

Any expected test failures?

---

Add a [X] to relevant checklist items

❔ This change

• adds a new feature
• fixes breaking code
• is cosmetic (refactoring/reformatting)

---

✔️ Pre-merge checklist

• Refactored code (sourcery)
• Tested code locally
• Precommit installed and run before pushing changes
• Added code to GitHub tests (notebooks, scripts)
• Updated GitHub README
• Updated the projects overview page on Notion

---

🧪 Test Configuration

• OS: Windows
• Python version: 3.12
• Neptune version: 0.12
• Affected libraries with version:

Summary by Sourcery

Add a new how-to guide notebook demonstrating how to fork and resume long training runs with Neptune and include it in the CI test-notebooks workflow.

New Features:

• Introduce a tutorial notebook on forking and resuming long training runs with Neptune.

Documentation:

• Add user-facing how-to guide for long-run forking in the documentation.

Tests:

• Update the test-notebooks CI workflow to include the new forking-long-runs notebook.

[sourcery-ai]

Reviewer's Guide

This PR adds a new “Fork Long Training Runs” tutorial notebook—including simulation, checkpointing, forking, and analysis steps—and updates the CI test-notebooks workflow to include it.

File-Level Changes

Change	Details	Files
Include tutorial notebook in CI workflow	Added new notebook path to the test-notebooks workflow file	.github/workflows/test-notebooks.yml
Introduce Fork Long Training Runs tutorial notebook	Created training simulation and checkpoint utilities Implemented base run logging with periodic checkpoints Added instructions to fork runs and log forked metrics Provided analysis of forked experiments and next steps	how-to-guides/forking-long-runs/fork_long_training_runs.ipynb

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.