MilesCranmer commited on
Commit
aa4fcd9
1 Parent(s): 30e2a49

Use prose in organizing options list

Browse files
Files changed (1) hide show
  1. docs/options.md +12 -12
docs/options.md CHANGED
@@ -3,21 +3,21 @@
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
  - [Custom complexities](#custom-complexity)
18
  - [LaTeX and SymPy](#latex-and-sympy)
19
  - [Exporting to numpy, pytorch, and jax](#exporting-to-numpy-pytorch-and-jax)
20
- - [`loss`](#loss)
21
  - [Model loading](#model-loading)
22
 
23
  These are described below
@@ -34,7 +34,7 @@ It also prints the equations to stdout.
34
  ## Model selection
35
 
36
  By default, `PySRRegressor` uses `model_selection='best'`
37
- which selects an equation from `PySRRegressor.equations` using
38
  a combination of accuracy and complexity.
39
  You can also select `model_selection='accuracy'`.
40
 
 
3
  Some configurable features and options in `PySR` which you
4
  may find useful include:
5
 
6
+ - [Selecting from the accuracy-complexity curve](#model-selection)
7
+ - [Operators](#operators)
8
+ - [Number of outer search iterations](#iterations)
9
+ - [Number of inner search iterations](#cycles-per-iteration)
10
+ - [Multi-processing](#processors)
11
+ - [Populations](#populations)
12
+ - [Data weighting](#weighted-data)
13
+ - [Max complexity and depth](#max-size)
14
+ - [Mini-batching](#batching)
15
+ - [Variable names](#variable-names)
16
  - [Constraining use of operators](#constraining-use-of-operators)
17
  - [Custom complexities](#custom-complexity)
18
  - [LaTeX and SymPy](#latex-and-sympy)
19
  - [Exporting to numpy, pytorch, and jax](#exporting-to-numpy-pytorch-and-jax)
20
+ - [Loss functions](#loss)
21
  - [Model loading](#model-loading)
22
 
23
  These are described below
 
34
  ## Model selection
35
 
36
  By default, `PySRRegressor` uses `model_selection='best'`
37
+ which selects an equation from `PySRRegressor.equations_` using
38
  a combination of accuracy and complexity.
39
  You can also select `model_selection='accuracy'`.
40