MilesCranmer commited on
Commit
8438b3b
1 Parent(s): e195ade

Fix links in options

Browse files
Files changed (1) hide show
  1. docs/options.md +19 -18
docs/options.md CHANGED
@@ -2,21 +2,22 @@
2
 
3
  Some configurable features and options in `PySR` which you
4
  may find useful include:
5
- - `model_selection`
6
- - `binary_operators`, `unary_operators`
7
- - `niterations`
8
- - `ncyclesperiteration`
9
- - `procs`
10
- - `populations`
11
- - `weights`
12
- - `maxsize`, `maxdepth`
13
- - `batching`, `batch_size`
14
- - `variable_names` (or pandas input)
15
- - Constraining operator complexity
16
- - LaTeX, SymPy
17
- - Callable exports: numpy, pytorch, jax
18
- - `loss`
19
- - Model loading
 
20
 
21
  These are described below
22
 
@@ -139,7 +140,7 @@ You can pass a list of strings naming each column of `X` with
139
  and the columns will be used as variable names. Make sure only
140
  alphabetical characters and `_` are used in these names.
141
 
142
- ## Constraining operator complexity
143
 
144
  One can limit the complexity of specific operators with the `constraints` parameter.
145
  There is a "maxsize" parameter to PySR, but there is also an operator-level
@@ -155,7 +156,7 @@ The other terms say that each multiplication can only have sub-expressions
155
  of up to complexity 3 (e.g., 5.0 + x2) in each side, and cosine can only operate on
156
  expressions of complexity 5 (e.g., 5.0 + x2 exp(x3)).
157
 
158
- ## LaTeX, SymPy
159
 
160
  After running `model.fit(...)`, you can look at
161
  `model.equations` which is a pandas dataframe.
@@ -171,7 +172,7 @@ There are also some helper functions for doing this quickly.
171
  - `model.pytorch()` will return a PyTorch model (see below).
172
 
173
 
174
- ## Callable exports: numpy, pytorch, jax
175
 
176
  By default, the dataframe of equations will contain columns
177
  with the identifier `lambda_format`.
 
2
 
3
  Some configurable features and options in `PySR` which you
4
  may find useful include:
5
+
6
+ - [`model_selection`](#model-selection)
7
+ - [`binary_operators`, `unary_operators`](#operators)
8
+ - [`niterations`](#iterations)
9
+ - [`ncyclesperiteration`](#cycles-per-iteration)
10
+ - [`procs`](#processors)
11
+ - [`populations`](#populations)
12
+ - [`weights`](#weighted-data)
13
+ - [`maxsize`, `maxdepth`](#max-size)
14
+ - [`batching`, `batch_size`](#batching)
15
+ - [`variable_names`](#variable-names)
16
+ - [Constraining use of operators](#constraining-use-of-operators)
17
+ - [LaTeX and SymPy](#latex-and-sympy)
18
+ - [Exporting to numpy, pytorch, and jax](#exporting-to-numpy-pytorch-and-jax)
19
+ - [`loss`](#loss)
20
+ - [Model loading](#model-loading)
21
 
22
  These are described below
23
 
 
140
  and the columns will be used as variable names. Make sure only
141
  alphabetical characters and `_` are used in these names.
142
 
143
+ ## Constraining use of operators
144
 
145
  One can limit the complexity of specific operators with the `constraints` parameter.
146
  There is a "maxsize" parameter to PySR, but there is also an operator-level
 
156
  of up to complexity 3 (e.g., 5.0 + x2) in each side, and cosine can only operate on
157
  expressions of complexity 5 (e.g., 5.0 + x2 exp(x3)).
158
 
159
+ ## LaTeX and SymPy
160
 
161
  After running `model.fit(...)`, you can look at
162
  `model.equations` which is a pandas dataframe.
 
172
  - `model.pytorch()` will return a PyTorch model (see below).
173
 
174
 
175
+ ## Exporting to numpy, pytorch, and jax
176
 
177
  By default, the dataframe of equations will contain columns
178
  with the identifier `lambda_format`.