Import ribs[visualize] in tutorials that need it #379
Merged
Conversation
This file contains 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
btjanaka
added a commit
that referenced
this pull request
Sep 22, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> Since the visualize extra is installed in the CI for the tutorials, we did not detect bugs where the tutorials needed ribs[visualize] but only installed ribs. This PR adds ribs[visualize] to the tutorials that need it and also makes a note in the "Adding a Tutorial" section of CONTRIBUTING.md. ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> ## Questions <!-- Any concerns or points of confusion? --> ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
7 tasks
btjanaka
added a commit
that referenced
this pull request
Sep 22, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> Previously, we always installed `ribs[visualize]` before testing tutorials. This led to uncaught bugs where some tutorials needed `ribs[visualize]` to be installed but did not install it -- namely, since we always installed `ribs[visualize]`, the tutorial could get by without installing `ribs[visualize]`. This led to bugs such as those in #379. To remedy this issue, this PR removes the default installation of `ribs[visualize]` in the tutorial CI. Instead, the notebook now installs the local copy of pyribs on its own -- we do this by replacing, e.g., `pip install ribs[visualize]` with `pip install .[visualize]`. Note that it is not possible to leave this dependency as is (i.e., `pip install ribs[visualize]`) because the tutorial would pull from PyPI instead of the local copy. ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> - [x] Fix bug in fooling mnist tutorial caused by matplotlib not being installed ## Questions ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
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.
Description
Since the visualize extra is installed in the CI for the tutorials, we did not detect bugs where the tutorials needed ribs[visualize] but only installed ribs. This PR adds ribs[visualize] to the tutorials that need it and also makes a note in the "Adding a Tutorial" section of CONTRIBUTING.md.
TODO
Questions
Status
CONTRIBUTING.md
yapfpytestpylintHISTORY.md