PyTorch Lightning Sample project.
Project description
Lightning Sample project/package
This is starter project template 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
Included
Listing the implemented sections:
- sample package named
pl_sandbox
- setting CI for package and tests folder
- setup/install package
- setting docs with Sphinx
- automatic PyPI release on GH release
- Docs deployd as GH pages
- Makefile for building docs with
make docs
and run all testsmake test
To be Done aka cross-check
You still need to enable some external integrations such as:
- rename
pl_<sandbox>
to anu other name, simple find-replace shall work well - update path used in the badges to the repository
- lock the main breach in GH setting - no direct push without PR
- set
gh-pages
as website and docs as source folder in GH setting - init Read-The-Docs (add this new project)
- add credentials for releasing package to PyPI
- 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 :]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.