ee03bce7f0
* fix docs typos * Apply suggestions from code review Co-authored-by: Wansoo Kim <rladhkstn8@gmail.com> * flake8 Co-authored-by: Wansoo Kim <rladhkstn8@gmail.com> (cherry picked from commit a047323cc796dcf5d4709399083bfc4b3b411de9) |
||
---|---|---|
.github | ||
docs | ||
pytorch_lightning/metrics | ||
tests | ||
torchmetrics | ||
.codecov.yml | ||
.gitignore | ||
.mergify.yml | ||
.pep8speaks.yml | ||
.readthedocs.yml | ||
CHANGELOG.md | ||
LICENSE | ||
MANIFEST.in | ||
README.md | ||
requirements.txt | ||
setup.cfg | ||
setup.py |
README.md
TorchMetrics
This is starter project which shall simplify initial steps for each new PL project...
* the Read-The-Docs is failing as this one leads to the public domain which requires the repo to be public too
To be Done
You still need to enable some external integrations such as:
- in GH setting lock the master breach - no direct push without PR
- init Read-The-Docs (add this new project)
- specify license in
LICENSE
file and package init
Tests / Docs notes
- We are using Napoleon style and we shall use static types...
- It is nice to se doctest as they are also generated as examples in documentation
- For wider and edge cases testing use pytest parametrization :]