MilesCranmer commited on
Commit
4ca54a5
1 Parent(s): e0c5bae

Describe batched objective in docstring

Browse files
Files changed (1) hide show
  1. pysr/sr.py +3 -0
pysr/sr.py CHANGED
@@ -374,6 +374,9 @@ class PySRRegressor(MultiOutputMixin, RegressorMixin, BaseEstimator):
374
  You may pass a function with the same arguments as this (note
375
  that the name of the function doesn't matter). Here,
376
  both `prediction` and `dataset.y` are 1D arrays of length `dataset.n`.
 
 
 
377
  Default is `None`.
378
  complexity_of_operators : dict[str, float]
379
  If you would like to use a complexity other than 1 for an
 
374
  You may pass a function with the same arguments as this (note
375
  that the name of the function doesn't matter). Here,
376
  both `prediction` and `dataset.y` are 1D arrays of length `dataset.n`.
377
+ If using `batching`, then you should add an
378
+ `idx` argument to the function, which is `nothing`
379
+ for non-batched, and a 1D array of indices for batched.
380
  Default is `None`.
381
  complexity_of_operators : dict[str, float]
382
  If you would like to use a complexity other than 1 for an