Spaces:
Sleeping
Sleeping
MilesCranmer
commited on
Commit
•
18c1f9c
1
Parent(s):
022f0e5
Center formatting for README
Browse files
README.md
CHANGED
@@ -1,15 +1,24 @@
|
|
1 |
[//]: # (Logo:)
|
2 |
|
3 |
-
<
|
4 |
|
|
|
|
|
5 |
# PySR: High-Performance Symbolic Regression in Python
|
6 |
|
|
|
|
|
|
|
7 |
PySR is built on an extremely optimized pure-Julia backend, and uses regularized evolution, simulated annealing, and gradient-free optimization to search for equations that fit your data.
|
8 |
|
|
|
|
|
9 |
| **Docs** | **colab** | **pip** | **conda** | **Stats** |
|
10 |
|---|---|---|---|---|
|
11 |
|[![Documentation](https://github.com/MilesCranmer/PySR/actions/workflows/docs.yml/badge.svg)](https://astroautomata.com/PySR/)|[![Colab](https://img.shields.io/badge/colab-notebook-yellow)](https://colab.research.google.com/github/MilesCranmer/PySR/blob/master/examples/pysr_demo.ipynb)|[![PyPI version](https://badge.fury.io/py/pysr.svg)](https://badge.fury.io/py/pysr)|[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pysr.svg)](https://anaconda.org/conda-forge/pysr)|[![Downloads](https://pepy.tech/badge/pysr)](https://badge.fury.io/py/pysr)|
|
12 |
|
|
|
|
|
13 |
|
14 |
(pronounced like *py* as in python, and then *sur* as in surface)
|
15 |
|
@@ -17,7 +26,10 @@ If you find PySR useful, please cite it using the citation information given in
|
|
17 |
If you've finished a project with PySR, please submit a PR to showcase your work on the [Research Showcase page](https://astroautomata.com/PySR/#/papers)!
|
18 |
|
19 |
|
20 |
-
|
|
|
|
|
|
|
21 |
| **Linux** | **Windows** | **macOS (intel)** |
|
22 |
|---|---|---|
|
23 |
|[![Linux](https://github.com/MilesCranmer/PySR/actions/workflows/CI.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI.yml)|[![Windows](https://github.com/MilesCranmer/PySR/actions/workflows/CI_Windows.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_Windows.yml)|[![macOS](https://github.com/MilesCranmer/PySR/actions/workflows/CI_mac.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_mac.yml)|
|
@@ -25,6 +37,8 @@ If you've finished a project with PySR, please submit a PR to showcase your work
|
|
25 |
|[![Docker](https://github.com/MilesCranmer/PySR/actions/workflows/CI_docker.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_docker.yml)|[![conda-forge](https://github.com/MilesCranmer/PySR/actions/workflows/CI_conda_forge.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_conda_forge.yml)|[![Coverage Status](https://coveralls.io/repos/github/MilesCranmer/PySR/badge.svg?branch=master&service=github)](https://coveralls.io/github/MilesCranmer/PySR)|
|
26 |
|
27 |
|
|
|
|
|
28 |
Check out [SymbolicRegression.jl](https://github.com/MilesCranmer/SymbolicRegression.jl) for
|
29 |
the pure-Julia backend of this package.
|
30 |
|
@@ -58,10 +72,14 @@ python interface.
|
|
58 |
|
59 |
# Installation
|
60 |
|
|
|
|
|
61 |
| pip (macOS, Linux, Windows) | conda (macOS - only Intel, Linux) |
|
62 |
|---|---|
|
63 |
| 1. Install Julia manually (see [downloads](https://julialang.org/downloads/))<br>2. `pip install pysr`<br>3. `python -c 'import pysr; pysr.install()'` | 1. `conda install -c conda-forge pysr`<br>2. `python -c 'import pysr; pysr.install()'`|
|
64 |
|
|
|
|
|
65 |
This last step will install and update the required Julia packages, including
|
66 |
`PyCall.jl`.
|
67 |
|
|
|
1 |
[//]: # (Logo:)
|
2 |
|
3 |
+
<div align="center">
|
4 |
|
5 |
+
<img src="https://raw.githubusercontent.com/MilesCranmer/PySR/master/docs/images/pysr_logo.svg" width="200" />
|
6 |
+
|
7 |
# PySR: High-Performance Symbolic Regression in Python
|
8 |
|
9 |
+
</div>
|
10 |
+
|
11 |
+
|
12 |
PySR is built on an extremely optimized pure-Julia backend, and uses regularized evolution, simulated annealing, and gradient-free optimization to search for equations that fit your data.
|
13 |
|
14 |
+
<div align="center">
|
15 |
+
|
16 |
| **Docs** | **colab** | **pip** | **conda** | **Stats** |
|
17 |
|---|---|---|---|---|
|
18 |
|[![Documentation](https://github.com/MilesCranmer/PySR/actions/workflows/docs.yml/badge.svg)](https://astroautomata.com/PySR/)|[![Colab](https://img.shields.io/badge/colab-notebook-yellow)](https://colab.research.google.com/github/MilesCranmer/PySR/blob/master/examples/pysr_demo.ipynb)|[![PyPI version](https://badge.fury.io/py/pysr.svg)](https://badge.fury.io/py/pysr)|[![Conda Version](https://img.shields.io/conda/vn/conda-forge/pysr.svg)](https://anaconda.org/conda-forge/pysr)|[![Downloads](https://pepy.tech/badge/pysr)](https://badge.fury.io/py/pysr)|
|
19 |
|
20 |
+
</div>
|
21 |
+
|
22 |
|
23 |
(pronounced like *py* as in python, and then *sur* as in surface)
|
24 |
|
|
|
26 |
If you've finished a project with PySR, please submit a PR to showcase your work on the [Research Showcase page](https://astroautomata.com/PySR/#/papers)!
|
27 |
|
28 |
|
29 |
+
<div align="center">
|
30 |
+
|
31 |
+
### Test status
|
32 |
+
|
33 |
| **Linux** | **Windows** | **macOS (intel)** |
|
34 |
|---|---|---|
|
35 |
|[![Linux](https://github.com/MilesCranmer/PySR/actions/workflows/CI.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI.yml)|[![Windows](https://github.com/MilesCranmer/PySR/actions/workflows/CI_Windows.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_Windows.yml)|[![macOS](https://github.com/MilesCranmer/PySR/actions/workflows/CI_mac.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_mac.yml)|
|
|
|
37 |
|[![Docker](https://github.com/MilesCranmer/PySR/actions/workflows/CI_docker.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_docker.yml)|[![conda-forge](https://github.com/MilesCranmer/PySR/actions/workflows/CI_conda_forge.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_conda_forge.yml)|[![Coverage Status](https://coveralls.io/repos/github/MilesCranmer/PySR/badge.svg?branch=master&service=github)](https://coveralls.io/github/MilesCranmer/PySR)|
|
38 |
|
39 |
|
40 |
+
</div>
|
41 |
+
|
42 |
Check out [SymbolicRegression.jl](https://github.com/MilesCranmer/SymbolicRegression.jl) for
|
43 |
the pure-Julia backend of this package.
|
44 |
|
|
|
72 |
|
73 |
# Installation
|
74 |
|
75 |
+
<div align="center">
|
76 |
+
|
77 |
| pip (macOS, Linux, Windows) | conda (macOS - only Intel, Linux) |
|
78 |
|---|---|
|
79 |
| 1. Install Julia manually (see [downloads](https://julialang.org/downloads/))<br>2. `pip install pysr`<br>3. `python -c 'import pysr; pysr.install()'` | 1. `conda install -c conda-forge pysr`<br>2. `python -c 'import pysr; pysr.install()'`|
|
80 |
|
81 |
+
</div>
|
82 |
+
|
83 |
This last step will install and update the required Julia packages, including
|
84 |
`PyCall.jl`.
|
85 |
|