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.

Sign up for GitHub

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

Jump to bottom

Add types / wrong type exceptions #7

Closed
f-aguzzi opened this issue May 9, 2024 · 3 comments
Closed

Add types / wrong type exceptions #7

f-aguzzi opened this issue May 9, 2024 · 3 comments
Labels
enhancement New feature or request released on @dev released on @stable
Milestone
Overhaul

Comments

@f-aguzzi
Copy link
Owner

f-aguzzi commented May 9, 2024

No description provided.

@f-aguzzi f-aguzzi added the enhancement New feature or request label May 9, 2024
@f-aguzzi f-aguzzi added this to the Overhaul milestone May 9, 2024
@f-aguzzi
Copy link
Owner Author

f-aguzzi commented May 17, 2024 •
edited
Loading

Decided to use beartype to do this, instead of manually implementing type checking on every input of every class (did this in KNN and PLSDA but it was painful).

It will likely be a breaking change and will mess with the tests, so it will have to be fixed on a different branch before pulling into the main. This means that the Overhaul milestone will have to be halted for a while.

The macro steps are:

  • open a beartype branch
  • add the library to the dependencies
  • add the setup code into the top level __init__.py file
  • remove manual type checking in KNN and PLSDA
  • add type hints in all classes
  • fix the tests
  • rewrite the documentation adding types

f-aguzzi added a commit that referenced this issue May 18, 2024
@f-aguzzi
feat(typing): set up beartype
35897e6 
closes #7
@f-aguzzi f-aguzzi mentioned this issue May 18, 2024
Merged
github-actions bot pushed a commit that referenced this issue May 18, 2024
@semantic-release-bot
ci(release): 1.1.0-beta.1 [skip ci]
2deffcc 
## [1.1.0-beta.1](v1.0.0...v1.1.0-beta.1) (2024-05-18)

### Features

* beartype integration ([2f823ce](2f823ce)), closes [#7](#7)
@github-actions GitHub Actions
Copy link

🎉 This issue has been resolved in version 1.1.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot pushed a commit that referenced this issue May 20, 2024
@semantic-release-bot
ci(release): 1.1.0 [skip ci]
97d5deb 
## [1.1.0](v1.0.0...v1.1.0) (2024-05-20)

### Features

* beartype integration ([2f823ce](2f823ce)), closes [#7](#7)

### Bug Fixes

* add missing checks to LLDFSettings ([3d57752](3d57752)), closes [#20](#20)

### chore

* **thesis:** set up build system (merge from [#22](#22)) ([0b13ed3](0b13ed3))

### Refactor

* extract split tests and graphs (merge [#23](#23)) ([6865c88](6865c88))

### CI

* **release:** 1.1.0-beta.1 [skip ci] ([2deffcc](2deffcc)), closes [#7](#7)
* **release:** 1.1.0-beta.2 [skip ci] ([25704dc](25704dc)), closes [#20](#20) [#22](#22) [#23](#23)
@github-actions GitHub Actions
Copy link

🎉 This issue has been resolved in version 1.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request released on @dev released on @stable
Projects
None yet
Milestone
Overhaul
Development

When branches are created from issues, their pull requests are automatically linked.

beartype f-aguzzi/ChemFuseKit
1 participant
@f-aguzzi