gchq / coreax

A library for coreset algorithms, written in Jax for fast execution and GPU support.
Apache License 2.0
18 stars 2 forks source link

Include PyRight in CI #427

Open tp832944 opened 6 months ago

tp832944 commented 6 months ago

Describe the feature that you would like.*

PyRight is a static type checker. Consider adding it to the dev tools for this repo.

https://github.com/microsoft/pyright

Alternatives: pylint, mypy

Why is this feature valuable to you?*

Check that type annotations are correct. Also that I can call functions correctly.

Describe alternatives you've considered

MyPy - See here for a detailed comparison.

Pylint - already on repo

Additional context

Initial investigations indicate that a significant amount of work will be required to ensure the codebase is compatible with pyright. A method of iterative compliance may be beneficial. I.E. when a developer edits a file they address pyright issues locally, but we do not check with pyright in the CI.

Code of Conduct*

tp832944 commented 6 months ago

Ought to do JAX typing first.

tp832944 commented 5 months ago

Blocked by #428.