Update documentation for MXNetDataIter in io.py (apache#6000)

danithaca · May 4, 2017 · ff1deac · ff1deac
1 parent ecc3dfa
commit ff1deac
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/python/mxnet/io.py b/python/mxnet/io.py
@@ -577,8 +577,16 @@ class MXDataIter(DataIter):
 
     Parameters
     ----------
-    handle : DataIterHandle
+    handle : DataIterHandle, required
         The handle to the underlying C++ Data Iterator.
+    data_name : str, optional
+        Data name. Default to "data".
+    label_name : str, optional
+        Label name. Default to "softmax_label".
+
+    See Also
+    --------
+    c_api.cc : The underlying C++ data iterator implementation.
     """
     def __init__(self, handle, data_name='data', label_name='softmax_label', **_):
         super(MXDataIter, self).__init__()
@@ -597,7 +605,6 @@ def __init__(self, handle, data_name='data', label_name='softmax_label', **_):
         self.provide_label = [DataDesc(label_name, label.shape, label.dtype)]
         self.batch_size = data.shape[0]
 
-
     def __del__(self):
         check_call(_LIB.MXDataIterFree(self.handle))