Release version 2.0

This MR aims at finalizing the package to proceed with its public release, as a clean 2.0 version.

Release To-Do List

Must have

Polish up the code:

• add ClassVar type annotations to class attributes
• add NoReturn type annotations to exception-raising functions (if any)
• clean up __init_subclass__ implementations see docs
• verify module docstrings;
• verify __all__ statements
• garbage-collect unused statements in abstract methods
• garbage-collect deprecated Model.compute_loss method
• implement pending hotfixes (notably to Readme and Vector classes)

Add required metadata:

• add LICENSE file
• add license-related header in all code files
• add AUTHORS file
• update package version (use a VERSION file?)

Test the package extensively:

• run tox with python [3.8, 3.9, 3.10, 3.11]
• drop support for python 3.7*

*Support for python 3.7 was dropped due to functions such as typing.get_args and typing.get_origin having been introduced with Python 3.8.

Could have

Improve dependency specifications:

• update dependencies' versions (possibly running tests, e.g. for TF)
• update black version (~=23.0)
• revise version requirements for pylint and mypy (current are OK and CI/CD uses the latest anyway)

Add more unit tests:

• units tests for Vector (see MR !22 (merged))

Add coverage stats:

• compute (and report in some sort) tests' coverage

Unplanned additions

• Modularize tests execution to be resilient to tensorflow and/or torch not being available.

requested review from @paandrey

assigned to @nbigaud

added 1 commit

• b38fe5a2 - Adding ClassVar typing

Compare with previous version

changed milestone to %Release declearn 2.0

added 1 commit

• 6f99c643 - Adding NoReturn typing

Compare with previous version

added 2 commits

• 39d3b5e2 - Adding `super().__init_subclass__()`
• 7b7bcf00 - Review all 58 `__all__`, found no error, renamed some methods as private since...

Compare with previous version

added 1 commit

• 9123f727 - Remove the superflous `return NotImplemented` and `return None` in abstract...

Compare with previous version

added 8 commits

• 9123f727...ddc04028 - 2 commits from branch main
• 21f9b0d9 - Add ClassVar type-hints.
• aee79fc1 - Add NoReturn type-hints
• 87cc9d7a - Add `super().__init_subclass__()` calls.
• 2db25bbe - Rename some unexposed functions to make them private.
• 7bd717fd - Remove superflous `return NotImplemented` and `return None` in abstract methods.
• 464e1c41 - Fix some docstring and code typos.

Compare with previous version

I force-pushed to apply the following changes:

• rebase onto the current main branch
• correct some typos or formatting of commit descriptions
• edit the ClassVar commit to add a pylint-silencing comment
• edit the __init_subclass__ commit to complement the effort

I also added a few small fixes.

added 1 commit

• 06f0092b - Remove deprecated `Model.compute_loss` method.

Compare with previous version

added 2 commits

• a8fa357c - Collect some unused statements.
• b752723c - Fix some errors in `NumpyVector.sum` and `TorchVector.maximum`.

Compare with previous version

marked this merge request as draft

changed title from Draft : last Todos to Draft: Release version 2.0

changed the description

added refactoring label

added 1 commit

• b3b75a7a - Update black to version 23.

Compare with previous version

marked the checklist item update black version (~=23.0) as completed

changed the description

added 2 commits

• 5c8c6499 - Add some missing 'type: ignore' comments.
• d846802c - Drop support for Python 3.7.

Compare with previous version

marked the checklist item drop support for python 3.7* as completed