MilesCranmer commited on
Commit
2925a1d
1 Parent(s): ecc127c

Clean up API reference

Browse files
Files changed (1) hide show
  1. README.md +13 -9
README.md CHANGED
@@ -60,15 +60,19 @@ You can also change the dataset learned on by passing in `X` and `y` as
60
  numpy arrays to `eureqa(...)`.
61
 
62
  ```python
63
- eureqa(X=None, y=None, threads=4, niterations=20, ncyclesperiteration=int(default_ncyclesperiteration),
64
- binary_operators=["plus", "mult"], unary_operators=["cos", "exp", "sin"], alpha=default_alpha,
65
- annealing=True, fractionReplaced=default_fractionReplaced, fractionReplacedHof=default_fractionReplacedHof,
66
- npop=int(default_npop), parsimony=default_parsimony, migration=True, hofMigration=True
67
- shouldOptimizeConstants=True, topn=int(default_topn), weightAddNode=default_weightAddNode,
68
- weightDeleteNode=default_weightDeleteNode, weightDoNothing=default_weightDoNothing,
69
- weightMutateConstant=default_weightMutateConstant, weightMutateOperator=default_weightMutateOperator,
70
- weightRandomize=default_weightRandomize, weightSimplify=default_weightSimplify, timeout=None,
71
- equation_file='hall_of_fame.csv', test='simple1', maxsize=20)
 
 
 
 
72
  ```
73
 
74
  Run symbolic regression to fit f(X[i, :]) ~ y[i] for all i.
 
60
  numpy arrays to `eureqa(...)`.
61
 
62
  ```python
63
+ eureqa(X=None, y=None, threads=4, niterations=20,
64
+ ncyclesperiteration=int(default_ncyclesperiteration),
65
+ binary_operators=["plus", "mult"], unary_operators=["cos", "exp", "sin"],
66
+ alpha=default_alpha, annealing=True, fractionReplaced=default_fractionReplaced,
67
+ fractionReplacedHof=default_fractionReplacedHof, npop=int(default_npop),
68
+ parsimony=default_parsimony, migration=True, hofMigration=True
69
+ shouldOptimizeConstants=True, topn=int(default_topn),
70
+ weightAddNode=default_weightAddNode, weightDeleteNode=default_weightDeleteNode,
71
+ weightDoNothing=default_weightDoNothing,
72
+ weightMutateConstant=default_weightMutateConstant,
73
+ weightMutateOperator=default_weightMutateOperator,
74
+ weightRandomize=default_weightRandomize, weightSimplify=default_weightSimplify,
75
+ timeout=None, equation_file='hall_of_fame.csv', test='simple1', maxsize=20)
76
  ```
77
 
78
  Run symbolic regression to fit f(X[i, :]) ~ y[i] for all i.