We use an issue tracker hosted in the NNabla GitHub repository. If you encounter any bugs, or come up with any feature requests, please first search if there is an already existing issue. If you can not find any, please feel free to post a new issue.
Note: This issue tracker is only used for development issues such as a bug report and a new feature request or proposal. Please do NOT post usage, installation and neural network modeling questions to the issue tracker. Such questions are welcome at the NNabla user group.
We appreciate contributors in the community, that are willing to improve NNabla. We basically follow the development style used in many GitHub repositories.
-
Search existing issues and/or pull request in the GitHub repository.
-
If it doesn't exist, post an issue for the feature proposal.
-
Fork the repository, and develop your feature in the forked repo.
-
Format your code using auto format. (Refer: Auto format guidelines section below)
-
Create a pull request of your development branch to NNabla's
masterbranch. Our maintainers will then review your changes. -
Once your change is finalized, the maintainer will merge your change.
Auto formatting is an inbuilt command to automatically format Python code to confirm to the PEP 8 style guide and C/C++/Objective-C code to adhere clang-format style. It is highly recommended to format your changed code before opening pull requests, which will save your and the reviewers' time.
To apply auto formatting, move to your branch, choose one of the below options of applying auto formatting.
Run following command to apply auto formatting for code.
For nnabla repository:
cd {nnabla repository root}
make bwd-nnabla-auto-formatFor nnabla-ext-cuda repository:
cd {nnabla-ext-cuda repository root}
make bwd-nnabla-ext-cuda-auto-formatPlease install following packages.
- Python3 and packages refer here
- clang-format-12
- autopep8 package
For Ubuntu 20.04 platform:
To install clang-format use following command,
sudo apt-get update
sudo apt-get install clang-formatTo install autopep8 use following command,
pip install --upgrade autopep8Run following command to apply auto formatting for code.
For nnabla repository:
cd {nnabla repository root}
make nnabla-auto-formatFor nnabla-ext-cuda repository:
cd {nnabla-ext-cuda repository root}
make nnabla-ext-cuda-auto-format- Architecture overview (available soon).
- Adding a new function (layer implementation).
- Adding a new solver (gradient descent algorithm implementation).
- Contributing to NNabla CUDA extension.
- Adding a new extension (available soon).