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

Adding typing annotations to FINN #1146

Open
bwintermann opened this issue Aug 1, 2024 · 0 comments
Open

Adding typing annotations to FINN #1146

bwintermann opened this issue Aug 1, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@bwintermann
Copy link

Prerequisites

None

Details / New behavior

I would propose adding type annotations / type hints to as many classes and functions in FINN as possible. For external code such as QONNX, stubs could be used.

Motivation

Personally I found that when developing in FINN, it was immensely helpful to have type hints added. This makes the projects structure very clear and helps especially newcomers to understand how components play together much quicker. Additionally, when having long iteration cycles due to for example synthesis times, having a static type checker such as mypy can prevent some of the errors before the run has even started, potentially saving quite some time.

Parts of FINN affected

Transformations, CustomOps and util functions, but ideally everything in the FINN codebase.

@bwintermann bwintermann added the enhancement New feature or request label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant