Skip to content

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

Merged
BloodAxe merged 3 commits into
masterfrom
featuer/SG-000-improve-notebook-checks
Nov 6, 2023
Merged

Enforced check of that all notebooks has matching SG version installed#1607
BloodAxe merged 3 commits into
masterfrom
featuer/SG-000-improve-notebook-checks

Conversation

@BloodAxe

@BloodAxe BloodAxe commented Nov 3, 2023

Copy link
Copy Markdown
Contributor

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.

@ofrimasad ofrimasad left a comment

Copy link
Copy Markdown
Collaborator

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

BloodAxe commented Nov 5, 2023

Copy link
Copy Markdown
Contributor Author

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

@shaydeci shaydeci left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@shaydeci shaydeci left a comment

Copy link
Copy Markdown
Contributor

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
@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.

3 participants