Add docstring for each Python module

Open
#705 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation, machine-learning

Research direction

Start by reviewing the Python modules mentioned in the issue, including layer.py and autograd.py, and check how their docstrings feed the API documentation at https://apache.singa.readthedocs.io/en/latest/. Done means each Python module documents its classes and functions, includes example usage, and explains how to add relevant subclasses such as Layer and Operator.

Written by the indexing model from the issue text.

Description

  1. The module's docstring should explain the classes and functions in this module.
  2. Example usages should be given.
  3. 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/

Dominant language
C++
Stars
3.6k
Forks
1.3k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/singa

All issues in apache/singa

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.