MilesCranmer commited on
Commit
fad9923
1 Parent(s): c7922af

Add new features to README

Browse files
Files changed (1) hide show
  1. README.md +5 -1
README.md CHANGED
@@ -196,7 +196,7 @@ which is `hall_of_fame.csv` by default. It also prints the
196
  equations to stdout.
197
 
198
  ```python
199
- pysr(X=None, y=None, weights=None, procs=4, populations=None, niterations=100, ncyclesperiteration=300, binary_operators=["plus", "mult"], unary_operators=["cos", "exp", "sin"], alpha=0.1, annealing=True, fractionReplaced=0.10, fractionReplacedHof=0.10, npop=1000, parsimony=1e-4, migration=True, hofMigration=True, shouldOptimizeConstants=True, topn=10, weightAddNode=1, weightInsertNode=3, weightDeleteNode=3, weightDoNothing=1, weightMutateConstant=10, weightMutateOperator=1, weightRandomize=1, weightSimplify=0.01, perturbationFactor=1.0, nrestarts=3, timeout=None, extra_sympy_mappings={}, equation_file='hall_of_fame.csv', test='simple1', verbosity=1e9, maxsize=20, fast_cycle=False, maxdepth=None, variable_names=[], select_k_features=None, threads=None, julia_optimization=3)
200
  ```
201
 
202
  Run symbolic regression to fit f(X[i, :]) ~ y[i] for all i.
@@ -262,6 +262,10 @@ is a slightly different algorithm than regularized evolution, but does cycles
262
  15% faster. May be algorithmically less efficient.
263
  - `variable_names`: list, a list of names for the variables, other
264
  than "x0", "x1", etc.
 
 
 
 
265
  - `select_k_features`: (None, int), whether to run feature selection in
266
  Python using random forests, before passing to the symbolic regression
267
  code. None means no feature selection; an int means select that many
 
196
  equations to stdout.
197
 
198
  ```python
199
+ pysr(X=None, y=None, weights=None, procs=4, populations=None, niterations=100, ncyclesperiteration=300, binary_operators=["plus", "mult"], unary_operators=["cos", "exp", "sin"], alpha=0.1, annealing=True, fractionReplaced=0.10, fractionReplacedHof=0.10, npop=1000, parsimony=1e-4, migration=True, hofMigration=True, shouldOptimizeConstants=True, topn=10, weightAddNode=1, weightInsertNode=3, weightDeleteNode=3, weightDoNothing=1, weightMutateConstant=10, weightMutateOperator=1, weightRandomize=1, weightSimplify=0.01, perturbationFactor=1.0, nrestarts=3, timeout=None, extra_sympy_mappings={}, equation_file='hall_of_fame.csv', test='simple1', verbosity=1e9, maxsize=20, fast_cycle=False, maxdepth=None, variable_names=[], batching=False, batchSize=50, select_k_features=None, threads=None, julia_optimization=3)
200
  ```
201
 
202
  Run symbolic regression to fit f(X[i, :]) ~ y[i] for all i.
 
262
  15% faster. May be algorithmically less efficient.
263
  - `variable_names`: list, a list of names for the variables, other
264
  than "x0", "x1", etc.
265
+ - `batching`: bool, whether to compare population members on small batches
266
+ during evolution. Still uses full dataset for comparing against
267
+ hall of fame.
268
+ - `batchSize`: int, the amount of data to use if doing batching.
269
  - `select_k_features`: (None, int), whether to run feature selection in
270
  Python using random forests, before passing to the symbolic regression
271
  code. None means no feature selection; an int means select that many