Spaces:

MilesCranmer
/

PySR

Running

App Files Files Community

MilesCranmer commited on Feb 1, 2022

Commit

42ef7d9

1 Parent(s): 0449544

Switching to docsify

Browse files

Files changed (7) hide show

.readthedocs-custom-steps.yml +0 -2
.readthedocs-requirements.txt +0 -2
.readthedocs.yml +0 -8
docs/{start.md → README.md} +55 -0
docs/_sidebar.md +6 -0
docs/index.html +23 -0
pydoc-markdown.yml +0 -73

.readthedocs-custom-steps.yml DELETED Viewed

	@@ -1,2 +0,0 @@
1	- steps:
2	- - pydoc-markdown --build --site-dir $SITE_DIR -vv

.readthedocs-requirements.txt DELETED Viewed

	@@ -1,2 +0,0 @@
1	- pydoc-markdown
2	- readthedocs-custom-steps

.readthedocs.yml DELETED Viewed

@@ -1,8 +0,0 @@
-version: 2
-mkdocs: {}  # tell readthedocs to use mkdocs
-python:
-  version: 3.7
-  install:
-  - method: pip
-    path: .
-  - requirements: .readthedocs-requirements.txt

docs/{start.md → README.md} RENAMED Viewed

@@ -1,3 +1,58 @@
 # Installation
 PySR uses both Julia and Python, so you need to have both installed.

+[//]: # (Logo:)
+<img src="https://raw.githubusercontent.com/MilesCranmer/PySR/master/pysr_logo.svg" width="400" />
+**PySR: parallel symbolic regression built on Julia, and interfaced by Python.**
+Uses regularized evolution, simulated annealing, and gradient-free optimization.
+| **Docs** | **pip** |
+|---|---|
+|[![Documentation Status](https://readthedocs.org/projects/pysr/badge/?version=latest)](https://pysr.readthedocs.io/en/latest/?badge=latest)|[![PyPI version](https://badge.fury.io/py/pysr.svg)](https://badge.fury.io/py/pysr)|
+(pronounced like *py* as in python, and then *sur* as in surface)
+If you find PySR useful, please cite it using the citation information given in [CITATION.md](https://github.com/MilesCranmer/PySR/blob/master/CITATION.md).
+If you've finished a project with PySR, please let me know and I may showcase your work here!
+### Test status:
+| **Linux** | **Windows** | **macOS (intel)** | **Docker** | **Coverage** |
+|---|---|---|---|---|
+|[![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)|[![Docker](https://github.com/MilesCranmer/PySR/actions/workflows/CI_docker.yml/badge.svg)](https://github.com/MilesCranmer/PySR/actions/workflows/CI_docker.yml)|[![Coverage Status](https://coveralls.io/repos/github/MilesCranmer/PySR/badge.svg?branch=master&service=github)](https://coveralls.io/github/MilesCranmer/PySR)|
+Check out [SymbolicRegression.jl](https://github.com/MilesCranmer/SymbolicRegression.jl) for
+the pure-Julia backend of this package.
+Symbolic regression is a very interpretable machine learning algorithm
+for low-dimensional problems: these tools search equation space
+to find algebraic relations that approximate a dataset.
+One can also
+extend these approaches to higher-dimensional
+spaces by using a neural network as proxy, as explained in
+[2006.11287](https://arxiv.org/abs/2006.11287), where we apply
+it to N-body problems. Here, one essentially uses
+symbolic regression to convert a neural net
+to an analytic equation. Thus, these tools simultaneously present
+an explicit and powerful way to interpret deep models.
+*Backstory:*
+Previously, we have used
+[eureqa](https://www.creativemachineslab.com/eureqa.html),
+which is a very efficient and user-friendly tool. However,
+eureqa is GUI-only, doesn't allow for user-defined
+operators, has no distributed capabilities,
+and has become proprietary (and recently been merged into an online
+service). Thus, the goal
+of this package is to have an open-source symbolic regression tool
+as efficient as eureqa, while also exposing a configurable
+python interface.
 # Installation
 PySR uses both Julia and Python, so you need to have both installed.

docs/_sidebar.md ADDED Viewed

	@@ -0,0 +1,6 @@

+- Using PySR
+  - [Getting Started](/)
+  - [Options](options.md)
+  - [Operators](operators.md)
+  - [Examples](examples.md)

docs/index.html ADDED Viewed

	@@ -0,0 +1,23 @@

+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: '',
+      loadSidebar: true
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>

pydoc-markdown.yml DELETED Viewed

@@ -1,73 +0,0 @@
-#@ def base_url():
-#@    if env.READTHEDOCS:
-#@      return "https://pysr.readthedocs.io/en/" + env.READTHEDOCS_VERSION + "/"
-#@    else:
-#@      return None
-#@ end
-loaders:
-  - type: python
-processors:
-  - type: filter
-  - type: smart
-  - type: crossref
-renderer:
-  type: hugo
-  markdown:
-    source_linker:
-      type: github
-      repo: MilesCranmer/PySR
-  config:
-    baseURL: #@ base_url()
-    title: PySR
-    theme: {clone_url: "https://github.com/alex-shpak/hugo-book.git"}
-  # The "book" theme only renders pages in "content/docs" into the nav.
-  build_directory: docs/build
-  content_directory: content/docs
-  default_preamble: {menu: main}
-  pages:
-    - title: Home
-      name: index
-      source: README.md
-      directory: '..'
-    - title: Getting started
-      name: getting-started
-      source: docs/start.md
-      preamble: {weight: 1}
-    - title: Features and Options
-      name: options
-      source: docs/options.md
-      preamble: {weight: 2}
-    - title: Operators
-      name: operators
-      source: docs/operators.md
-      preamble: {weight: 3}
-    - title: Examples
-      name: examples
-      source: docs/examples.md
-      preamble: {weight: 4}
-    - title: API Documentation
-      contents:
-        - pysr.*
-        # - pysr.sr.PySRRegressor
-        # - pysr.sr.PySRRegressor.__init__
-        # - pysr.sr.PySRRegressor.fit
-        # - pysr.sr.PySRRegressor.predict
-        # - pysr.sr.PySRRegressor.__repr__
-        # - pysr.sr.PySRRegressor.set_params
-        # - pysr.sr.PySRRegressor.get_params
-        # - pysr.sr.PySRRegressor.get_best
-        # - pysr.sr.PySRRegressor.sympy
-        # - pysr.sr.PySRRegressor.latex
-        # - pysr.sr.PySRRegressor.jax
-        # - pysr.sr.PySRRegressor.pytorch
-        # - pysr.sr.PySRRegressor.refresh
-        # - pysr.sr.install
-        # - pysr.sr.silence_julia_warning
-      preamble: {weight: 5}