updated mini_batch_size description for LogisticRegressionParams in documentation
authorRahul Kavi <leorahul16@gmail.com>
Thu, 7 Nov 2013 10:15:56 +0000 (05:15 -0500)
committerMaksim Shabunin <maksim.shabunin@itseez.com>
Mon, 18 Aug 2014 15:06:57 +0000 (19:06 +0400)
modules/ml/doc/logistic_regression.rst

index c3236c7..33dc5d8 100644 (file)
@@ -110,8 +110,7 @@ The constructors.
 
     :param: reg: To enable or disable regularization. Set to positive integer (greater than zero) to enable and to 0 to disable.
 
-    :param: mini_batch_size: Specifies the number of training samples taken in each step of Mini-Batch Gradient Descent. Will only be used if using ``LogisticRegression::MINI_BATCH`` training algorithm.
-
+    :param: mini_batch_size: Specifies the number of training samples taken in each step of Mini-Batch Gradient Descent. Will only be used if using ``LogisticRegression::MINI_BATCH`` training algorithm. It has to take values less than the total number of training samples.
 
 The full constructor initializes corresponding members. The default constructor creates an object with dummy parameters.