This page summarizes docs for developers of NNSVS. If you want to contribute to NNSVS itself, please check the document below.
For development purposes, it is recommended to install full requirements with editiable mode (
-e with pip) enabled:
pip install -e ".[dev,lint,test,docs]"
This allows your local changes available to your python environment without manually re-installing NNSVS.
Here’s the list of important components of the NNSVS repository:
nnsvs: The core Python library. Neural network implementations for SVS systems can be found here.
recipes: Recipes. The recipes are written mostly in bash and YAML-style configs. Some recipes use small Python scripts.
docs: Documentation. It is written by Sphinx.
notebooks: Jupyter notebooks. Notebooks are helpful for interactive debugging and development.
utils: Utility scripts that are used by the recipes.
Python docstring style
NNSVS follows the Google’s style. If you write a docstrings for your new functinoality, please follow the same style.
Formatting and linting
https://github.com/pfnet/pysen is used for formatting and linting. Please run the following commands when you make a PR.
pysen run format
pysen run lint
To prevent unintentional bugs, it is better to write tests as much as possible. If you propose a new function, please consdier to write tests. You can run the tests by the following command:
pytest -v -s
Please make sure tests are all passing before making a PR.
Building docs locally
Run the following command at the top of nnsvs directory:
sphinx-autobuild docs docs/_build/html/