Move main functionality to top-level of module + add example notebooks to CI #30
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
phinate
changed the title
|
oh, and a suggestion: since this changes the API, I would make this release |
anh-tong
reviewed
Jun 1, 2023
Comment on lines
+73
to
+81
| - name: Run examples | ||
| run: | | ||
| cd examples | ||
| python -m pip install -r requirements.txt | ||
| python -m pip install jupyter nbclient | ||
| jupyter execute estimate_hurst.ipynb | ||
| jupyter execute generative_model.ipynb | ||
| jupyter execute inversion.ipynb | ||
|
|
There was a problem hiding this comment.
I don't know much about running notebooks in CI. I wonder if this is a common practice. Anyway, I think it's okay for these notebooks since they may not take much time.
anh-tong
approved these changes
Jun 1, 2023
Absolutely, I agree. Please go ahead. Thanks for contributing. |
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.
Main effect: instead of
you can now do
The module called
signatureis now renamed tosignaturesto avoid double-naming.This PR also deprecates
signature_flattened, and instead opts to use the more explicit route of manually callingflattenin the few places it's needed.One additional bonus: the notebooks in
exampleshave been added to CI to make sure we don't break them (the wholekeything withequinox.Sequentialcomes into play there!)