Merge pull request #1360 from yingzha/dev

added docstring to get_weights_format
lisa-lab · Jan 20, 2015 · 9870dec · 9870dec
2 parents 9132584 + 1b66a79
commit 9870dec
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/pylearn2/models/mlp.py b/pylearn2/models/mlp.py
@@ -296,9 +296,16 @@ def set_biases(self, biases):
 
     def get_weights_format(self):
         """
-        .. todo::
+        Returns a description of how to interpret the weights of the layer.
+
+        Returns
+        -------
+        format: tuple
+            Either ('v', 'h') or  ('h', 'v').
+            ('v', 'h') means a weight matrix of shape
+            (num visible units, num hidden units),
+            while ('h', 'v') means the transpose of it.
 
-            WRITEME
         """
         raise NotImplementedError