Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforced check of that all notebooks has matching SG version installed #1607

Merged
merged 3 commits into from
Nov 6, 2023

Conversation

BloodAxe
Copy link
Collaborator

@BloodAxe BloodAxe commented Nov 3, 2023

This PR fixes a small issue with regex in checking version of SG package (Now both pip install super-gradients and pip install super_gradietns commands are parsed correctly)
It also simplify Makefile by splitting NOTEBOOKS variable into NOTEBOOKS_TO_CHECK and NOTEBOOKS_TO_RUN
These variables are no multi-line, which makes it easier to merge PRs where notebooks are added.
And lastly, now check_notebooks_version_match is a part of breaking change test to enforce our notebooks are up-to-date.

Copy link
Collaborator

@ofrimasad ofrimasad left a comment

Choose a reason for hiding this comment

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

@BloodAxe @shaydeci, correct me if I am wrong - this will force us to manually change all the notebooks with every version we release.

@BloodAxe
Copy link
Collaborator Author

BloodAxe commented Nov 5, 2023

You are correct. When we want to release, we have to update version in SG notebook and (ideally) run them against this new version.

So the workflow is the following

  • when we think we are ready to release (all stuff is already merged):
  • update version
  • pip install -e . (If it's not already)
  • make run_and_convert_notebooks

Commit changes to reflect updated docs in documentation

shaydeci
shaydeci previously approved these changes Nov 5, 2023
Copy link
Collaborator

@shaydeci shaydeci left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@shaydeci shaydeci left a comment

Choose a reason for hiding this comment

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

LGTM

@BloodAxe BloodAxe merged commit 369fc6a into master Nov 6, 2023
7 checks passed
@BloodAxe BloodAxe deleted the featuer/SG-000-improve-notebook-checks branch November 6, 2023 08:16
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.

None yet

3 participants