changeset 750:b4aa46f856c1

added doc
author James Bergstra <bergstrj@iro.umontreal.ca>
date Tue, 02 Jun 2009 20:19:30 -0400
parents 4617ee277698
children 88839ba37b97
files pylearn/algorithms/exponential_mean.py
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pylearn/algorithms/exponential_mean.py	Fri May 29 10:48:20 2009 -0400
+++ b/pylearn/algorithms/exponential_mean.py	Tue Jun 02 20:19:30 2009 -0400
@@ -14,6 +14,12 @@
 
     :math:`self.curval = (1.0 - (1.0/max_denom)) * self.old_curval + (1.0/max_denom) * x`
 
+
+    The symbolic buffer containing the running mean is called `old_curval`.  (This has a value
+    in the ModuleInstance).
+
+    The symbolic variable for the updated running mean is called `curval`.
+
     """
 
     max_denom = None