Spaces:
Sleeping
Sleeping
MilesCranmer
commited on
Commit
•
68df0bb
1
Parent(s):
b3b3344
Describe best() more in-depth in docs
Browse files- docs/options.md +14 -14
docs/options.md
CHANGED
@@ -1,9 +1,10 @@
|
|
1 |
-
#
|
2 |
|
3 |
You likely don't need to tune the hyperparameters yourself,
|
4 |
but if you would like, you can use `hyperparamopt.py` as an example.
|
5 |
|
6 |
-
|
|
|
7 |
- `binary_operators`, `unary_operators`
|
8 |
- `niterations`
|
9 |
- `procs`
|
@@ -12,7 +13,7 @@ Common options to `PySR` include:
|
|
12 |
- `maxsize`, `maxdepth`
|
13 |
- `batching`, `batchSize`
|
14 |
- `variable_names` (or pandas input)
|
15 |
-
- SymPy output
|
16 |
|
17 |
These are described below
|
18 |
|
@@ -105,19 +106,18 @@ You can pass a list of strings naming each column of `X` with
|
|
105 |
and the columns will be used as variable names. Make sure only
|
106 |
alphabetical characters and `_` are used in these names.
|
107 |
|
108 |
-
## SymPy
|
109 |
|
110 |
The `pysr` command will return a pandas dataframe. The `sympy_format`
|
111 |
-
column gives sympy equations
|
112 |
-
|
113 |
|
114 |
-
|
115 |
-
|
116 |
-
|
117 |
-
```
|
118 |
-
|
119 |
-
If you have set variable names with `variable_names` or a Pandas
|
120 |
-
dataframe as input for `X`, this will use the same names for each
|
121 |
-
input column instead of `x0`.
|
122 |
|
|
|
|
|
|
|
|
|
123 |
|
|
|
1 |
+
# Features and Options
|
2 |
|
3 |
You likely don't need to tune the hyperparameters yourself,
|
4 |
but if you would like, you can use `hyperparamopt.py` as an example.
|
5 |
|
6 |
+
Some configurable features and options in `PySR` which you
|
7 |
+
may find useful include:
|
8 |
- `binary_operators`, `unary_operators`
|
9 |
- `niterations`
|
10 |
- `procs`
|
|
|
13 |
- `maxsize`, `maxdepth`
|
14 |
- `batching`, `batchSize`
|
15 |
- `variable_names` (or pandas input)
|
16 |
+
- LaTeX, SymPy, and callable equation output
|
17 |
|
18 |
These are described below
|
19 |
|
|
|
106 |
and the columns will be used as variable names. Make sure only
|
107 |
alphabetical characters and `_` are used in these names.
|
108 |
|
109 |
+
## LaTeX, SymPy, callables
|
110 |
|
111 |
The `pysr` command will return a pandas dataframe. The `sympy_format`
|
112 |
+
column gives sympy equations, and the `lambda_format` gives callable
|
113 |
+
functions. These use the variable names you have provided.
|
114 |
|
115 |
+
There are also some helper functions for doing this quickly.
|
116 |
+
You can call `get_hof()` (or pass an equation file explicitly to this)
|
117 |
+
to get this pandas dataframe.
|
|
|
|
|
|
|
|
|
|
|
118 |
|
119 |
+
You can call the functions `best()` to get the sympy format
|
120 |
+
for the best equation, using the `score` column to sort equations.
|
121 |
+
`best_latex()` returns the LaTeX form of this, and `best_callable()`
|
122 |
+
returns a callable function.
|
123 |
|