Skip to content

Commit

Permalink
Add documentation for chainerx.ravel
Browse files Browse the repository at this point in the history
  • Loading branch information
takagi committed Oct 3, 2019
1 parent 34b1d48 commit ebf0bfb
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions chainerx/_docs/routines.py
Expand Up @@ -1105,6 +1105,25 @@ def _docs_manipulation():
output array to the input array ``a``.
.. seealso:: :func:`numpy.reshape`
""")

_docs.set_doc(
chainerx.ravel,
"""ravel(a)
Returns a flattened array.
Args:
a (~chainerx.ndarray): Array to be flattened.
Returns:
:class:`~chainerx.ndarray`: A flattened view of ``a`` if possible,
otherwise a copy.
Note:
During backpropagation, this function propagates the gradient of the
output array to the input array ``a``.
.. seealso:: :func:`numpy.ravel`
""")

_docs.set_doc(
Expand Down

0 comments on commit ebf0bfb

Please sign in to comment.