Create a workflow to test PennyLane with NumPy 1.26 #6275
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
|
Hello. You may have forgotten to update the changelog!
|
PietropaoloFrisoni
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6275 +/- ##
=======================================
Coverage 99.70% 99.70%
=======================================
Files 444 444
Lines 42133 42133
=======================================
Hits 42008 42008
Misses 125 125 ☔ View full report in Codecov by Sentry. |
PietropaoloFrisoni
changed the title
|
@rashidnhm Please ignore the failures related to JAX 0.4.28 and NumPy 1.26.4 (we'll decide what to do with them at a later stage). I asked for your review mostly for the workflow structure. Thanks! |
…o workflow_numpy_1
rashidnhm
approved these changes
Sep 19, 2024
There was a problem hiding this comment.
As discussed offline, this pull request does introduce a lot of code duplication in the workflows. However, due to the urgency of it and it's expected lifetime I believe it is okay to move forward with it as it is and we can explore alternate options with less duplications later on
…o workflow_numpy_1
mudit2812
pushed a commit
that referenced
this pull request
Sep 23, 2024
**Context:** In #6061, we started using by default NumPy 2 (instead of NumPy 1) on the CI to test every PR targeting the master branch. Some jobs (for example, those requiring `tensorflow`) still automatically downgrade to NumPy 1.26 since not all interfaces are supported at the current stage. This PR aims to create another workflow to test some jobs with NumPy 1.26 (those that don't automatically downgrade to NumPy 1 during the day). Such a workflow should run at night to ensure PennyLane is still compatible with NumPy 1.26. **We'll keep this workflow only temporarily** (probably a quarter, but this still has to be established). After that, we'll get rid of it. Finally, It has been verified (see [here](https://github.com/PennyLaneAI/pennylane/actions/runs/10927439038)) that the tests introduced with this PR are green. This has been verified a second time (see [here](https://github.com/PennyLaneAI/pennylane/actions/runs/10946347640) before merging this PR into master). **Description of the Change:** As above. **Benefits:** We ensure that PennyLane is still compatible with NumPy 1.26. **Possible Drawbacks:** - This issue was discovered accidentally (and potentially fixed) during this PR. The `TestSinglePrecision` class in the `test_jax_jit_qnode.py` file contains tests that change the JAX precision with `jax.config.update("jax_enable_x64", False)`. When running the jax tests using multiple workers, we can face race conditions if some workers change jax configuration, because other workers in other test classes downgrade to a single precision causing numerous failures. To avoid this, we add [--dist=loadscope](https://pytest-xdist.readthedocs.io/en/latest/distribution.html) as additional pytest arg for jax tests, grouping tests by module for test functions and by class for test methods. - The new workflow is it is to a large extent a (very simplified) copy of `interface-unit-tests.yml`. This is against the principle of avoiding code duplication whenever possible. Still, this is just a temporary workflow that lasts for a few months at most (and runs only at night), and it may be convenient to disentangle it as much as possible from the usual test interface. **Related GitHub Issues:** None. **Related Shortcut Stories:** [sc-73744]
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.
Context: In #6061, we started using by default NumPy 2 (instead of NumPy 1) on the CI to test every PR targeting the master branch. Some jobs (for example, those requiring
tensorflow) still automatically downgrade to NumPy 1.26 since not all interfaces are supported at the current stage.This PR aims to create another workflow to test some jobs with NumPy 1.26 (those that don't automatically downgrade to NumPy 1 during the day). Such a workflow should run at night to ensure PennyLane is still compatible with NumPy 1.26.
We'll keep this workflow only temporarily (probably a quarter, but this still has to be established). After that, we'll get rid of it.
Finally, It has been verified (see here) that the tests introduced with this PR are green. This has been verified a second time (see here before merging this PR into master).
Description of the Change: As above.
Benefits: We ensure that PennyLane is still compatible with NumPy 1.26.
Possible Drawbacks:
This issue was discovered accidentally (and potentially fixed) during this PR. The
TestSinglePrecisionclass in thetest_jax_jit_qnode.pyfile contains tests that change the JAX precision withjax.config.update("jax_enable_x64", False). When running the jax tests using multiple workers, we can face race conditions if some workers change jax configuration, because other workers in other test classes downgrade to a single precision causing numerous failures. To avoid this, we add --dist=loadscope as additional pytest arg for jax tests, grouping tests by module for test functions and by class for test methods.The new workflow is it is to a large extent a (very simplified) copy of
interface-unit-tests.yml. This is against the principle of avoiding code duplication whenever possible. Still, this is just a temporary workflow that lasts for a few months at most (and runs only at night), and it may be convenient to disentangle it as much as possible from the usual test interface.Related GitHub Issues: None.
Related Shortcut Stories: [sc-73744]