Merge pull request #105 from tqchen/master

Update model to add save/load and period checkpoint

python/mxnet/__init__.py

@@ -22,6 +22,7 @@
 from . import model
 from . import initializer
 from . import visualization
-import atexit
+# use viz as short for mx.ndarray
+from . import visualization as viz
 
 __version__ = "0.1.0"

python/mxnet/base.py

@@ -179,3 +179,44 @@ def ctypes2numpy_shared(cptr, shape):
     dbuffer = (mx_float * size).from_address(ctypes.addressof(cptr.contents))
     return np.frombuffer(dbuffer, dtype=np.float32).reshape(shape)
 
+
+def ctypes2docstring(num_args, arg_names, arg_types, arg_descs, remove_dup=True):
+    """Convert ctypes returned doc string information into parameters docstring.
+
+    num_args : mx_uint
+        Number of arguments.
+
+    arg_names : ctypes.POINTER(ctypes.c_char_p)
+        Argument names.
+
+    arg_types : ctypes.POINTER(ctypes.c_char_p)
+        Argument type information.
+
+    arg_descs : ctypes.POINTER(ctypes.c_char_p)
+        Argument description information.
+
+    remove_dup : boolean, optional
+        Whether remove duplication or not.
+
+    Returns
+    -------
+    docstr : str
+        Python docstring of parameter sections.
+    """
+    param_keys = set()
+    param_str = []
+    for i in range(num_args.value):
+        key = py_str(arg_names[i])
+        if key in param_keys and remove_dup:
+            continue
+        param_keys.add(key)
+        type_info = py_str(arg_types[i])
+        ret = '%s : %s' % (key, type_info)
+        if len(arg_descs[i]) != 0:
+            ret += '\n    ' + py_str(arg_descs[i])
+        param_str.append(ret)
+    doc_str = ('Parameters\n' +
+               '----------\n' +
+               '%s\n')
+    doc_str = doc_str % ('\n'.join(param_str))
+    return doc_str

python/mxnet/io.py

@@ -8,7 +8,7 @@
 from .base import _LIB
 from .base import c_array, c_str, mx_uint, py_str
 from .base import DataIterHandle, NDArrayHandle
-from .base import check_call
+from .base import check_call, ctypes2docstring
 from .ndarray import NDArray
 
 class DataIter(object):
@@ -99,24 +99,17 @@ def _make_io_iterator(handle):
             ctypes.byref(arg_types), \
             ctypes.byref(arg_descs)))
     iter_name = py_str(name.value)
-    param_str = []
-    for i in range(num_args.value):
-        ret = '%s : %s' % (arg_names[i], arg_types[i])
-        if len(arg_descs[i]) != 0:
-            ret += '\n    ' + py_str(arg_descs[i])
-        param_str.append(ret)
+    param_str = ctypes2docstring(num_args, arg_names, arg_types, arg_descs)
 
     doc_str = ('%s\n\n' +
-               'Parameters\n' +
-               '----------\n' +
                '%s\n' +
                'name : string, required.\n' +
                '    Name of the resulting data iterator.\n\n' +
                'Returns\n' +
                '-------\n' +
-               'iterator: Iterator\n'+
+               'iterator: DataIter\n'+
                '    The result iterator.')
-    doc_str = doc_str % (desc.value, '\n'.join(param_str))
+    doc_str = doc_str % (desc.value, param_str)
 
     def creator(*args, **kwargs):
         """Create an iterator.

python/mxnet/metric.py

@@ -47,8 +47,8 @@ def __init__(self):
     def update(self, pred, label):
         pred = pred.asnumpy()
         label = label.asnumpy().astype('int32')
-        y = np.argmax(pred, axis=1)
-        self.sum_metric += np.sum(y == label)
+        py = np.argmax(pred, axis=1)
+        self.sum_metric += np.sum(py == label)
         self.num_inst += label.size