PySR
_{Symbolic Regression in Python and Julia
Docs  ×  Examples  ×  API  ×  Forum  ×  Agents}

. After the model has been fit, you can run `model.predict(X)` to see the predictions on a given dataset using the automatically-selected expression, or, for example, `model.predict(X, 3)` to see the predictions of the 3rd equation. You may run: ```python print(model) ``` to print the learned equations: ```python PySRRegressor.equations_ = [ pick score equation loss complexity 0 0.000000 4.4324794 42.354317 1 1 1.255691 (x0 * x0) 3.437307 3 2 0.011629 ((x0 * x0) + -0.28087974) 3.358285 5 3 0.897855 ((x0 * x0) + cos(x3)) 1.368308 6 4 0.857018 ((x0 * x0) + (cos(x3) * 2.4566472)) 0.246483 8 5 >>>> inf (((cos(x3) + -0.19699033) * 2.5382123) + (x0 *... 0.000000 10 ] ``` This arrow in the `pick` column indicates which equation is currently selected by your `model_selection` strategy for prediction. (You may change `model_selection` after `.fit(X, y)` as well.) `model.equations_` is a pandas DataFrame containing all equations, including callable format (`lambda_format`), SymPy format (`sympy_format` - which you can also get with `model.sympy()`), and even JAX and PyTorch format (both of which are differentiable - which you can get with `model.jax()` and `model.pytorch()`). Note that `PySRRegressor` stores the state of the last search, and will restart from where you left off the next time you call `.fit()`, assuming you have set `warm_start=True`. This will cause problems if significant changes are made to the search parameters (like changing the operators). You can run `model.reset()` to reset the state. You will notice that PySR will save two files: `hall_of_fame...csv` and `hall_of_fame...pkl`. The csv file is a list of equations and their losses, and the pkl file is a saved state of the model. You may load the model from the `pkl` file with: ```python model = PySRRegressor.from_file("hall_of_fame.2022-08-10_100832.281.pkl") ``` There are several other useful features such as denoising (e.g., `denoise=True`), feature selection (e.g., `select_k_features=3`). For examples of these and other features, see the [examples page](https://pysr.ai/examples). For a detailed look at more options, see the [options page](https://pysr.ai/options). You can also see the full API at [this page](https://pysr.ai/api). There are also tips for tuning PySR on [this page](https://pysr.ai/tuning). ### Detailed Example The following code makes use of as many PySR features as possible. Note that is just a demonstration of features and you should not use this example as-is. For details on what each parameter does, check out the [API page](https://pysr.ai/api). ```python model = PySRRegressor( populations=8, # ^ Assuming we have 4 cores, this means 2 populations per core, so one is always running. population_size=50, # ^ Slightly larger populations, for greater diversity. ncycles_per_iteration=500, # ^ Generations between migrations. niterations=10000000, # Run forever early_stop_condition=( "stop_if(loss, complexity) = loss < 1e-6 && complexity < 10" # Stop early if we find a good and simple equation ), timeout_in_seconds=60 * 60 * 24, # ^ Alternatively, stop after 24 hours have passed. maxsize=50, # ^ Allow greater complexity. maxdepth=10, # ^ But, avoid deep nesting. binary_operators=["*", "+", "-", "/"], unary_operators=["square", "cube", "exp", "cos2(x)=cos(x)^2"], constraints={ "/": (-1, 9), "square": 9, "cube": 9, "exp": 9, }, # ^ Limit the complexity within each argument. # "inv": (-1, 9) states that the numerator has no constraint, # but the denominator has a max complexity of 9. # "exp": 9 simply states that `exp` can only have # an expression of complexity 9 as input. nested_constraints={ "square": {"square": 1, "cube": 1, "exp": 0}, "cube": {"square": 1, "cube": 1, "exp": 0}, "exp": {"square": 1, "cube": 1, "exp": 0}, }, # ^ Nesting constraints on operators. For example, # "square(exp(x))" is not allowed, since "square": {"exp": 0}. complexity_of_operators={"/": 2, "exp": 3}, # ^ Custom complexity of particular operators. complexity_of_constants=2, # ^ Punish constants more than variables select_k_features=4, # ^ Train on only the 4 most important features progress=True, # ^ Can set to false if printing to a file. weight_randomize=0.1, # ^ Randomize the tree much more frequently cluster_manager=None, # ^ Can be set to, e.g., "slurm", to run a slurm # cluster. Just launch one script from the head node. precision=64, # ^ Higher precision calculations. warm_start=True, # ^ Start from where left off. turbo=True, # ^ Faster evaluation (experimental) extra_sympy_mappings={"cos2": lambda x: sympy.cos(x)**2}, # extra_torch_mappings={sympy.cos: torch.cos}, # ^ Not needed as cos already defined, but this # is how you define custom torch operators. # extra_jax_mappings={sympy.cos: "jnp.cos"}, # ^ For JAX, one passes a string. ) ``` ### Docker You can also test out PySR in Docker, without installing it locally, by running the following command in the root directory of this repo: ```bash docker build -t pysr . ``` This builds an image called `pysr` for your system's architecture, which also contains IPython. You can select a specific version of Python and Julia with: ```bash docker build -t pysr --build-arg JLVERSION=1.10.0 --build-arg PYVERSION=3.11.6 . ``` You can then run with this dockerfile using: ```bash docker run -it --rm -v "$PWD:/data" pysr ipython ``` which will link the current directory to the container's `/data` directory and then launch ipython. If you have issues building for your system's architecture, you can emulate another architecture by including `--platform linux/amd64`, before the `build` and `run` commands.

### Contributors ✨

We are eager to welcome new contributors! Check out our contributors [guide](https://github.com/astroautomata/PySR/blob/master/CONTRIBUTORS.md) for tips 🚀. If you have an idea for a new feature, don't hesitate to share it on the [issues](https://github.com/astroautomata/PySR/issues) or [discussions](https://github.com/astroautomata/PySR/discussions) page.

Adil	Christopher Rowley	Mark Kittisopikul	T Coxon	Dhananjay Ashok	Johan Blåbäck	JuliusMartensen	ngam
Kaze Wong	Christopher Rackauckas	Patrick Kidger	Okon Samuel	William Booth-Clibborn	Aya Ghaleb	gca30	Niklas Heim
Atharva Sehgal	wkharold	William Moses	Ardeleanu Cristian	gm89uk	Pablo Lemos	Jerry Ling	Charles Fox
Johann Brehmer	Marius Millea	Coba	foxtran	Shah Mahdi Hasan	Dilum Aluthge	Sebastian Micluța-Câmpeanu	Tim Holy
BrotherHa	William Thompson	Tom Jelen	Miguel Crispim Romao	Andy Dienes	Harsh Singh	Pietro Monticone	Mateusz Kubica
William Booth-Clibborn	Raúl Peralta Lozada	Roy Hvaara	Vishal Jain	spaette	Yi-Xin Liu	spinnau	Xianda Sun
Jay Wadekar	Anthony Blaom, PhD	Jgmedina95	Michael Abbott	Oscar Smith	Eric Hanson	Henrique Becker	qwertyjl
Rik Huijzer	Hongyu Wang	Zehao Jin	Tanner Mengel	Arthur Grundner	sjwetzel	Saurav Maheshkar	chris-soelistyo
Ilya Orson	Ho Fung Tsoi	LionessOfCintra	Manuel Morales	Paulo Montero Camacho	Writu Dasgupta	Anubhav Kamal	anthony-sun
Hao Guo	Trailblazer	Christos Pliakos	Sousa Neto	Leonardo Voltolini	Daniel Eduardo Conde Villatoro	Sam Beckers