changeset 1452:d862047c2fe7

Added doc of a new parameter.
author Frederic Bastien <nouiz@nouiz.org>
date Fri, 01 Apr 2011 10:06:03 -0400
parents 8110ca3cec3f
children d9dd09a2ee90
files pylearn/preprocessing/pca.py
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pylearn/preprocessing/pca.py	Thu Mar 31 18:29:11 2011 -0400
+++ b/pylearn/preprocessing/pca.py	Fri Apr 01 10:06:03 2011 -0400
@@ -88,6 +88,9 @@
     :param x_centered:
         True means to consider X as having mean 0 (even if it actually doesn't!)
 
+    :param inplace:
+        If False, we copy X before using it. Otherwise we modify it.
+
     :returns: ((eigvals, eigvecs), centered_X) of PCA decomposition
 
     """