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

Test pyribs installation in tutorials #384

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Test pyribs installation in tutorials #384

merged 2 commits into from
Sep 22, 2023

Conversation

btjanaka
Copy link
Member

@btjanaka btjanaka commented Sep 22, 2023

Description

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

  • Fix bug in fooling mnist tutorial caused by matplotlib not being installed

Questions

Status

  • I have read the guidelines in
    CONTRIBUTING.md
  • I have formatted my code using yapf
  • I have tested my code by running pytest
  • I have linted my code with pylint
  • I have added a one-line description of my change to the changelog in
    HISTORY.md
  • This PR is ready to go

@btjanaka btjanaka merged commit a84bd92 into master Sep 22, 2023
18 checks passed
@btjanaka btjanaka deleted the tutorial-ci branch September 22, 2023 04:11
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.

1 participant