Skip to content

Fixed example notebook links in README.md#177

Merged
atong01 merged 2 commits into
atong01:mainfrom
drscotthawley:main
Apr 20, 2026
Merged

Fixed example notebook links in README.md#177
atong01 merged 2 commits into
atong01:mainfrom
drscotthawley:main

Conversation

@drscotthawley
Copy link
Copy Markdown
Contributor

@drscotthawley drscotthawley commented Apr 18, 2026

Updated notebook links and paths for examples in README.

What does this PR do?

When example notebook files got moved, Colab links no longer resolved properly. This PR fixes that.

Fixes #160 and other broken links.

Before submitting

  • [ x] Did you make sure title is self-explanatory and the description concisely explains the PR?
  • [ x] Did you make sure your PR does only one thing, instead of bundling different changes together?
  • [ x] Did you list all the breaking changes introduced by this pull request?
  • [ x] Did you test your PR locally with pytest command?
  • [o ] Did you run pre-commit hooks with pre-commit run -a command? N/A: No code changes were made. Only README.md was changed

Did you have fun?

Yes.

Make sure you had fun coding 🙃

Summary by Sourcery

Documentation:

  • Fix README links and paths for the model comparison, MNIST example, and minimal training notebooks so their Colab badges open the correct files.

Updated notebook links and paths for examples in README.
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 18, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README example notebook references so that inline paths and Google Colab links match the new example notebook locations and filenames.

File-Level Changes

Change Details Files
Update model comparison GIF notebook path and Colab link to the current 2D tutorials location.
  • Replace reference to models in examples/models with explanation that the GIF is produced by the 2D_tutorials/model-comparison-plotting.ipynb notebook
  • Update the corresponding Google Colab URL to point to examples/2D_tutorials/model-comparison-plotting.ipynb in the repository
README.md
Update MNIST example notebook path and Colab link to the current images examples location.
  • Change inline notebook path from examples/notebooks/mnist_example.ipynb to examples/images/mnist_example.ipynb
  • Update the corresponding Google Colab URL to point to examples/images/mnist_example.ipynb in the repository
README.md
Update the minimal training tutorial Colab link to the renamed 2D tutorial notebook.
  • Change the Colab link target from examples/notebooks/training-8gaussians-to-moons.ipynb to examples/2D_tutorials/tutorial_training_8_gaussians_to_moons.ipynb while keeping the surrounding text unchanged
README.md

Assessment against linked issues

Issue Objective Addressed Explanation
#160 Update the broken Colab link to model-comparison-plotting.ipynb in the README so that it points to the correct, existing notebook path.

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

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="README.md" line_range="122" />
<code_context>
-Run a simple minimal example here [![Run in Google Colab](https://img.shields.io/static/v1?label=Run%20in&message=Google%20Colab&color=orange&logo=Google%20Cloud)](https://colab.research.google.com/github/atong01/conditional-flow-matching/blob/master/examples/notebooks/training-8gaussians-to-moons.ipynb). Or install the more efficient code locally with these steps.
+Run a simple minimal example here [![Run in Google Colab](https://img.shields.io/static/v1?label=Run%20in&message=Google%20Colab&color=orange&logo=Google%20Cloud)](https://colab.research.google.com/github/atong01/conditional-flow-matching/blob/master/examples/2D_tutorials/tutorial_training_8_gaussians_to_moons.ipynb). Or install the more efficient code locally with these steps.

 TorchCFM is now on [pypi](https://pypi.org/project/torchcfm/)! You can install it with:

</code_context>
<issue_to_address>
**nitpick (typo):** Consider capitalizing "PyPI" to match the official project name.

The Python Package Index is conventionally written as “PyPI”; please update the link text to use this capitalization: `TorchCFM is now on [PyPI](https://pypi.org/project/torchcfm/)!`

```suggestion
TorchCFM is now on [PyPI](https://pypi.org/project/torchcfm/)! You can install it with:
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@atong01
Copy link
Copy Markdown
Owner

atong01 commented Apr 20, 2026

LGTM thanks for the contribution!

@atong01 atong01 merged commit 6e0b198 into atong01:main Apr 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

For colab link

2 participants