Document chainerx.to_numpy

chainerx/_docs/__init__.py

@@ -7,6 +7,7 @@
 from chainerx._docs import context
 from chainerx._docs import device
 from chainerx._docs import routines
+from chainerx._docs import utils
 
 
 def set_doc(obj, docstring):
@@ -20,5 +21,5 @@ def set_doc(obj, docstring):
 
 
 def set_docs():
-    for m in (array, backend, backprop, context, device, routines):
+    for m in (array, backend, backprop, context, device, routines, utils):
         m.set_docs()

chainerx/_docs/utils.py

@@ -0,0 +1,18 @@
+import chainerx
+from chainerx import _docs
+
+
+def set_docs():
+    _docs.set_doc(
+        chainerx.to_numpy,
+        """to_numpy(array, copy=True)
+Converts a ChainerX array to NumPy
+
+Args:
+    array (~chainerx.ndarray): ChainerX array.
+    copy (bool): If ``True``, a copy is always made. Otherwise, the resulting
+        array may be aliased with the input array.
+
+Returns:
+    numpy.ndarray: NumPy array.
+""")

docs/source/chainerx/reference/ndarray.rst

@@ -8,3 +8,13 @@ Multi-Dimensional Array (ndarray)
    :nosignatures:
 
    chainerx.ndarray
+
+
+Utility functions
+-----------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   chainerx.to_numpy