DOC add recommendation for batch_size

MatthewSZhang · MatthewSZhang · commit 0b2c3a86c6f3 · 2024-11-27T10:04:18.000+08:00
diff --git a/fastcan/_minibatch.py b/fastcan/_minibatch.py
@@ -50,6 +50,7 @@ def minibatch(X, y, n_features_to_select=1, batch_size=1):
 
     batch_size : int, default=1
         The number of features in a mini-batch.
+        It is recommended that batch_size be less than n_samples.
 
     Returns
     -------
