New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstring for each Python module #705

Open

nudles opened this issue May 19, 2020 · 0 comments

Member

nudles commented May 19, 2020

The module's docstring should explain the classes and functions in this module.
Example usages should be given.
How to add a new sub-class should be explained, e.g., how to add a new Layer subclass in layer.py, how to add a new Operator subclass in autograd.py.

The docstrings will be used to build the API documentation pages at https://apache-singa.readthedocs.io/en/latest/

nudles changed the title ~~Add docstring for each pyhton module~~ Add docstring for each Python module

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment