first yadll commit

pchavanne · Jun 20, 2016 · d0ad20b · d0ad20b
1 parent 4a87ad9
commit d0ad20b
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/yadll/model.py b/yadll/model.py
@@ -9,6 +9,22 @@
 
 class Model(object):
     """
+    The :class: `Model` containes the data, the network, the hyperparameters,
+    and the report.
+    It pretrains unsupervised layers, trains the network and save to file.
+
+    Parameters
+    ----------
+    network : :class:`Network`
+        the network to be trained
+    data : :class:`Data`
+        the training, validating and testing set
+    name : `string`
+        the name of the model
+    updates : :function:`Updates`
+        an update function
+    file : `string`
+        name of the file to save the model
 
     """
     def __init__(self, network=None, data=None, hyperparameters=None, name=None,

diff --git a/yadll/network.py b/yadll/network.py
@@ -41,7 +41,7 @@ def add(self, layer):
 
         Parameters
         ----------
-        layer: :class: `Layer`
+        layer : :class: `Layer`
 
         """
         self.layers.append(layer)
@@ -56,7 +56,7 @@ def params(self):
 
         Returns
         -------
-        params:
+        params :
             list of parameters of the network
 
         """
@@ -68,7 +68,7 @@ def reguls(self):
 
         Returns
         -------
-        reguls: symbolic expresssion
+        reguls : symbolic expresssion
             regularization cost for the network
 
         """