Fixed example notebook links in README.md#177
Merged
Conversation
Updated notebook links and paths for examples in README.
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates README example notebook references so that inline paths and Google Colab links match the new example notebook locations and filenames. File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
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 [](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 [](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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Owner
|
LGTM thanks for the contribution! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
pytestcommand?pre-commit run -acommand? N/A: No code changes were made. Only README.md was changedDid you have fun?
Yes.
Make sure you had fun coding 🙃
Summary by Sourcery
Documentation: