Documentation and minor usability fixes #204
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This concludes the development. Currently it supports python 3.9, due to CMake limitations. Post release I can try and fix it with other releases as well (CMake 3.18 is the only version guaranteed to detect CUDA properly, but has hardcoded support for python <= 3.9). Stress tested it on Debian and RHEL like platforms (docker) and Mac M2, to ensure that all possible errors are catalogued.
The documentation can be seen here: https://kliff-v1.readthedocs.io/en/latest/index.html
TODO
Advanced documentation about more customized training
Tutorial to implement custom trainer
Make sure your code is properly formatted. isort and black are used for this purpose. The simplest way is to use pre-commit. See instructions here.
Doc strings have been added in the Google docstring format on your code.
Type annotations are highly encouraged. Run mypy to type check your code.
Tests have been added for any new functionality or bug fixes.
All linting and tests pass.
Note that the CI system will run all the above checks. But it will be much more efficient if you already fix most errors prior to submitting the PR.