Improve readme

README.md

@@ -47,7 +47,9 @@ X = 2*np.random.randn(100, 5)
 y = 2*np.cos(X[:, 3]) + X[:, 0]**2 - 2
 
 # Learn equations
-equations = pysr(X, y, niterations=5)
+equations = pysr(X, y, niterations=5,
+            binary_operators=["plus", "mult"],
+            unary_operators=["cos", "exp", "sin"])
 
 ...
 
@@ -63,14 +65,57 @@ which gives:
 2          11  0.000000  plus(plus(mult(x0, x0), cos(x3)), plus(-2.0, cos(x3)))
 ```
 
-### API
+### Operators
+
+All Base julia operators that take 1 or 2 float32 as input,
+and output a float32 as output, are available. A selection
+of these and other valid operators are stated below. You can also
+define your own in `operators.jl`, and pass the function
+name as a string.
+
+**Binary**
+
+`plus`, `mult`, `pow`, `div`, `greater`, `mod`, `beta`, `logical_or`,
+`logical_and`
+
+**Unary**
+
+`neg`,
+`exp`,
+`abs`,
+`logm` (=log(abs(x) + 1e-8)),
+`logm10` (=log10(abs(x) + 1e-8)),
+`logm2` (=log2(abs(x) + 1e-8)),
+`log1p`,
+`sin`,
+`cos`,
+`tan`,
+`sinh`,
+`cosh`,
+`tanh`,
+`asin`,
+`acos`,
+`atan`,
+`asinh`,
+`acosh`,
+`atanh`,
+`erf`,
+`erfc`,
+`gamma`,
+`relu`,
+`round`,
+`floor`,
+`ceil`,
+`round`.
+
+### Full API
 
 What follows is the API reference for running the numpy interface.
 You likely don't need to tune the hyperparameters yourself,
 but if you would like, you can use `hyperopt.py` as an example.
 However, you should adjust `threads`, `niterations`,
 `binary_operators`, `unary_operators`, and `maxsize`
-to your requirements. You can see a list of available operators below.
+to your requirements.
 
 The program will output a pandas DataFrame containing the equations,
 mean square error, and complexity. It will also dump to a csv
@@ -78,12 +123,6 @@ at the end of every iteration,
 which is `hall_of_fame.csv` by default. It also prints the
 equations to stdout.
 
-You can add more operators in `operators.jl`, or use default
-Julia ones. Make sure all operators are defined for scalar `Float32`.
-Then just specify the operator names in your call, as above.
-You can also change the dataset learned on by passing in `X` and `y` as
-numpy arrays to `pysr(...)`.
-
 ```python
 pysr(X=None, y=None, threads=4, niterations=20,
    ncyclesperiteration=int(default_ncyclesperiteration),
@@ -152,46 +191,6 @@ pd.DataFrame, Results dataframe, giving complexity, MSE, and equations
 (as strings).
 
 
-# Operators
-
-All Base julia operators that take 1 or 2 float32 as input,
-and output a float32 as output, are available. A selection
-of these and other valid operators are given below:
-
-## Binary
-
-`plus`, `mult`, `pow`, `div`, `greater`, `mod`, `beta`, `logical_or`,
-`logical_and`
-
-## Unary:
-
-`neg`,
-`exp`,
-`abs`,
-`logm` (=log(abs(x) + 1e-8)),
-`logm10` (=log10(abs(x) + 1e-8)),
-`logm2` (=log2(abs(x) + 1e-8)),
-`log1p`,
-`sin`,
-`cos`,
-`tan`,
-`sinh`,
-`cosh`,
-`tanh`,
-`asin`,
-`acos`,
-`atan`,
-`asinh`,
-`acosh`,
-`atanh`,
-`erf`,
-`erfc`,
-`gamma`,
-`relu`,
-`round`,
-`floor`,
-`ceil`,
-`round`.
 
 
 # TODO