Describe batched objective in docstring

MilesCranmer · Jul 27, 2023 · 4ca54a5 · 4ca54a5
1 parent e0c5bae
commit 4ca54a5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pysr/sr.py b/pysr/sr.py
@@ -374,6 +374,9 @@ class PySRRegressor(MultiOutputMixin, RegressorMixin, BaseEstimator):
         You may pass a function with the same arguments as this (note
         that the name of the function doesn't matter). Here,
         both `prediction` and `dataset.y` are 1D arrays of length `dataset.n`.
+        If using `batching`, then you should add an
+        `idx` argument to the function, which is `nothing`
+        for non-batched, and a 1D array of indices for batched.
         Default is `None`.
     complexity_of_operators : dict[str, float]
         If you would like to use a complexity other than 1 for an