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

Code quality refactor (based on scikit-hep/cookie) #24

Merged
merged 9 commits into from
May 29, 2023

Conversation

phinate
Copy link
Collaborator

@phinate phinate commented May 26, 2023

I've gone and added all of the features from the scikit-hep cookiecutter into signax! It uses the test runner nox, which is documented in CONTRIBUTING.md, and also adds a bunch of extra pre-commit hooks, including mypy and ruff.

There's also stuff in place to do ReadTheDocs if we ever want to do any documentation :)

@phinate
Copy link
Collaborator Author

phinate commented May 26, 2023

One thing that has been removed here was all the uses of def __call__(self, input, *, key): when the key wasn't used in the function. Is that something that you'd like changed back based on the way you're using the Modules?

@anh-tong
Copy link
Owner

@phinate Thank you very much for this PR. In the case of Signature, I was working with equinox.nn.Sequential requiring key. It would not be necessary. I think we can remove key.

Additionally, there seems to be an error in the workflow installation for signatory, where the installation of PyTorch is missing. Once this is fixed, the PR will be absolutely awesome. Thank you again!

@phinate
Copy link
Collaborator Author

phinate commented May 29, 2023

CI passed! merging now :)

@phinate phinate merged commit 9694e0b into anh-tong:main May 29, 2023
@phinate phinate deleted the code-quality-refactor branch May 29, 2023 17:07
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.

2 participants