numpydoc for theano/tensor/io.py

theano/tensor/io.py

@@ -11,13 +11,18 @@ import theano
 
 class LoadFromDisk(Op):
     """
-    An operation to load an array from disk
+    An operation to load an array from disk.
 
     See Also
-        load
+    --------
+    load
+
+    Notes
+    -----
+    Non-differentiable.
 
-    @note: Non-differentiable.
     """
+
     __props__ = ("dtype", "broadcastable", "mmap_mode")
 
     def __init__(self, dtype, broadcastable, mmap_mode=None):
@@ -53,18 +58,26 @@ def load(path, dtype, broadcastable, mmap_mode=None):
     """
     Load an array from an .npy file.
 
-    :param path: A Generic symbolic variable, that will contain a string
-    :param dtype: The data type of the array to be read.
-    :param broadcastable: The broadcastable pattern of the loaded array,
-      for instance, (False,) for a vector, (False, True) for a column,
-      (False, False) for a matrix.
-    :param mmap_mode: How the file will be loaded. None means that the
-      data will be copied into an array in memory, 'c' means that the file
-      will be mapped into virtual memory, so only the parts that are
-      needed will be actually read from disk and put into memory.
-      Other modes supported by numpy.load ('r', 'r+', 'w+') cannot
-      be supported by Theano.
-
+    Parameters
+    ----------
+    path
+        A Generic symbolic variable, that will contain a string
+    dtype : data-type
+        The data type of the array to be read.
+    broadcastable
+        The broadcastable pattern of the loaded array, for instance,
+        (False,) for a vector, (False, True) for a column,
+        (False, False) for a matrix.
+    mmap_mode
+        How the file will be loaded. None means that the
+        data will be copied into an array in memory, 'c' means that the file
+        will be mapped into virtual memory, so only the parts that are
+        needed will be actually read from disk and put into memory.
+        Other modes supported by numpy.load ('r', 'r+', 'w+') cannot
+        be supported by Theano.
+
+    Examples
+    --------
     >>> from theano import *
     >>> path = Variable(Generic())
     >>> x = tensor.load(path, 'int64', (False,))
@@ -72,6 +85,7 @@ def load(path, dtype, broadcastable, mmap_mode=None):
     >>> fn = function([path], y)
     >>> fn("stored-array.npy")
     array([0, 2, 4, 6, 8], dtype=int64)
+
     """
 
     return LoadFromDisk(dtype, broadcastable, mmap_mode)(path)
@@ -91,14 +105,19 @@ else:
 
 class MPIRecv(Op):
     """
-    An operation to asynchronously receive an array to a remote host using MPI
+    An operation to asynchronously receive an array to a remote host using MPI.
 
     See Also
-       MPIRecv
-       MPIWait
+    --------
+    MPIRecv
+    MPIWait
+
+    Notes
+    -----
+    Non-differentiable.
 
-    @note: Non-differentiable.
     """
+
     __props__ = ("source", "tag", "shape", "dtype")
 
     def __init__(self, source, tag, shape, dtype):
@@ -134,13 +153,18 @@ class MPIRecv(Op):
 
 class MPIRecvWait(Op):
     """
-    An operation to wait on a previously received array using MPI
+    An operation to wait on a previously received array using MPI.
 
     See Also
-       MPIRecv
+    --------
+    MPIRecv
+
+    Notes
+    -----
+    Non-differentiable.
 
-    @note: Non-differentiable.
     """
+
     __props__ = ("tag",)
 
     def __init__(self, tag):
@@ -168,14 +192,19 @@ class MPIRecvWait(Op):
 
 class MPISend(Op):
     """
-    An operation to asynchronously Send an array to a remote host using MPI
+    An operation to asynchronously Send an array to a remote host using MPI.
 
     See Also
-       MPIRecv
-       MPISendWait
+    --------
+    MPIRecv
+    MPISendWait
+
+    Notes
+    -----
+    Non-differentiable.
 
-    @note: Non-differentiable.
     """
+
     __props__ = ("dest", "tag")
 
     def __init__(self, dest, tag):
@@ -202,12 +231,16 @@ class MPISend(Op):
 
 class MPISendWait(Op):
     """
-    An operation to wait on a previously sent array using MPI
+    An operation to wait on a previously sent array using MPI.
+
+    See Also
+    --------
+    MPISend
 
-    See Also:
-       MPISend
+    Notes
+    -----
+    Non-differentiable.
 
-    @note: Non-differentiable.
     """
 
     __props__ = ("tag",)
@@ -227,35 +260,35 @@ class MPISendWait(Op):
 
 def isend(var, dest, tag):
     """
-    Non blocking send
+    Non blocking send.
     """
     return MPISend(dest, tag)(var)
 
 
 def send(var, dest, tag):
     """
-    blocking send
+    Blocking send.
     """
     return MPISendWait(tag)(*isend(var, dest, tag))
 
 
 def irecv(shape, dtype, source, tag):
     """
-    non-blocking receive
+    Non-blocking receive.
     """
     return MPIRecv(source, tag, shape, dtype)()
 
 
 def recv(shape, dtype, source, tag):
     """
-    blocking receive
+    Blocking receive.
     """
     return MPIRecvWait(tag)(*irecv(shape, dtype, source, tag))
 
 
 # Ordering keys for scheduling
 def mpi_send_wait_key(a):
-    """ Wait as long as possible on Waits, Start Send/Recvs early """
+    """Wait as long as possible on Waits, Start Send/Recvs early."""
     if isinstance(a.op, (MPIRecvWait, MPISendWait)):
         return 1
     if isinstance(a.op, (MPIRecv, MPISend)):
@@ -264,7 +297,7 @@ def mpi_send_wait_key(a):
 
 
 def mpi_tag_key(a):
-    """ Break MPI ties by using the variable tag - prefer lower tags first """
+    """Break MPI ties by using the variable tag - prefer lower tags first."""
     if isinstance(a.op, (MPISend, MPIRecv, MPIRecvWait, MPISendWait)):
         return a.op.tag
     else: