-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
38 changed files
with
730 additions
and
270 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
.. summary-start | ||
.. _logo-adaptive: | ||
|
||
|image0| adaptive | ||
================= | ||
|
||
|PyPI| |Conda| |Downloads| |pipeline status| |DOI| |Binder| |Join the | ||
chat at https://gitter.im/python-adaptive/adaptive| | ||
|
||
**Tools for adaptive parallel sampling of mathematical functions.** | ||
|
||
``adaptive`` is an open-source Python library designed to | ||
make adaptive parallel function evaluation simple. With ``adaptive`` you | ||
just supply a function with its bounds, and it will be evaluated at the | ||
“best” points in parameter space. With just a few lines of code you can | ||
evaluate functions on a computing cluster, live-plot the data as it | ||
returns, and fine-tune the adaptive sampling algorithm. | ||
|
||
Check out the ``adaptive`` example notebook | ||
`learner.ipynb <https://github.com/python-adaptive/adaptive/blob/master/learner.ipynb>`_ (or run it `live on | ||
Binder <https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb>`_) | ||
to see examples of how to use ``adaptive``. | ||
|
||
.. summary-end | ||
**WARNING: adaptive is still in a beta development stage** | ||
|
||
.. implemented-algorithms-start | ||
Implemented algorithms | ||
---------------------- | ||
|
||
The core concept in ``adaptive`` is that of a *learner*. A *learner* | ||
samples a function at the best places in its parameter space to get | ||
maximum “information” about the function. As it evaluates the function | ||
at more and more points in the parameter space, it gets a better idea of | ||
where the best places are to sample next. | ||
|
||
Of course, what qualifies as the “best places” will depend on your | ||
application domain! ``adaptive`` makes some reasonable default choices, | ||
but the details of the adaptive sampling are completely customizable. | ||
|
||
The following learners are implemented: | ||
|
||
- ``Learner1D``, for 1D functions ``f: ℝ → ℝ^N``, | ||
- ``Learner2D``, for 2D functions ``f: ℝ^2 → ℝ^N``, | ||
- ``LearnerND``, for ND functions ``f: ℝ^N → ℝ^M``, | ||
- ``AverageLearner``, For stochastic functions where you want to | ||
average the result over many evaluations, | ||
- ``IntegratorLearner``, for | ||
when you want to intergrate a 1D function ``f: ℝ → ℝ``, | ||
- ``BalancingLearner``, for when you want to run several learners at once, | ||
selecting the “best” one each time you get more points. | ||
|
||
In addition to the learners, ``adaptive`` also provides primitives for | ||
running the sampling across several cores and even several machines, | ||
with built-in support for | ||
`concurrent.futures <https://docs.python.org/3/library/concurrent.futures.html>`_, | ||
`ipyparallel <https://ipyparallel.readthedocs.io/en/latest/>`_ and | ||
`distributed <https://distributed.readthedocs.io/en/latest/>`_. | ||
|
||
.. implemented-algorithms-end | ||
Examples | ||
-------- | ||
|
||
.. raw:: html | ||
|
||
<img src="https://user-images.githubusercontent.com/6897215/38739170-6ac7c014-3f34-11e8-9e8f-93b3a3a3d61b.gif" width='20%'> </img> <img src="https://user-images.githubusercontent.com/6897215/35219611-ac8b2122-ff73-11e7-9332-adffab64a8ce.gif" width='40%'> </img> | ||
|
||
|
||
Installation | ||
------------ | ||
|
||
``adaptive`` works with Python 3.6 and higher on Linux, Windows, or Mac, | ||
and provides optional extensions for working with the Jupyter/IPython | ||
Notebook. | ||
|
||
The recommended way to install adaptive is using ``conda``: | ||
|
||
.. code:: bash | ||
conda install -c conda-forge adaptive | ||
``adaptive`` is also available on PyPI: | ||
|
||
.. code:: bash | ||
pip install adaptive[notebook] | ||
The ``[notebook]`` above will also install the optional dependencies for | ||
running ``adaptive`` inside a Jupyter notebook. | ||
|
||
Development | ||
----------- | ||
|
||
Clone the repository and run ``setup.py develop`` to add a link to the | ||
cloned repo into your Python path: | ||
|
||
.. code:: bash | ||
git clone git@github.com:python-adaptive/adaptive.git | ||
cd adaptive | ||
python3 setup.py develop | ||
We highly recommend using a Conda environment or a virtualenv to manage | ||
the versions of your installed packages while working on ``adaptive``. | ||
|
||
In order to not pollute the history with the output of the notebooks, | ||
please setup the git filter by executing | ||
|
||
.. code:: bash | ||
python ipynb_filter.py | ||
in the repository. | ||
|
||
Credits | ||
------- | ||
|
||
We would like to give credits to the following people: | ||
|
||
- Pedro Gonnet for his implementation of `CQUAD <https://www.gnu.org/software/gsl/manual/html_node/CQUAD-doubly_002dadaptive-integration.html>`_, | ||
“Algorithm 4” as described in “Increasing the Reliability of Adaptive | ||
Quadrature Using Explicit Interpolants”, P. Gonnet, ACM Transactions on | ||
Mathematical Software, 37 (3), art. no. 26, 2010. | ||
- Pauli Virtanen for his ``AdaptiveTriSampling`` script (no longer | ||
available online since SciPy Central went down) which served as | ||
inspiration for the ``~adaptive.Learner2D``. | ||
|
||
For general discussion, we have a `Gitter chat | ||
channel <https://gitter.im/python-adaptive/adaptive>`_. If you find any | ||
bugs or have any feature suggestions please file a GitLab | ||
`issue <https://gitlab.kwant-project.org/qt/adaptive/issues/new?issue>`_ | ||
or submit a `merge | ||
request <https://gitlab.kwant-project.org/qt/adaptive/merge_requests>`_. | ||
|
||
.. references-start | ||
.. |image0| image:: https://gitlab.kwant-project.org/qt/adaptive/uploads/d20444093920a4a0499e165b5061d952/logo.png | ||
.. |PyPI| image:: https://img.shields.io/pypi/v/adaptive.svg | ||
:target: https://pypi.python.org/pypi/adaptive | ||
.. |Conda| image:: https://anaconda.org/conda-forge/adaptive/badges/installer/conda.svg | ||
:target: https://anaconda.org/conda-forge/adaptive | ||
.. |Downloads| image:: https://anaconda.org/conda-forge/adaptive/badges/downloads.svg | ||
:target: https://anaconda.org/conda-forge/adaptive | ||
.. |pipeline status| image:: https://gitlab.kwant-project.org/qt/adaptive/badges/master/pipeline.svg | ||
:target: https://gitlab.kwant-project.org/qt/adaptive/pipelines | ||
.. |DOI| image:: https://zenodo.org/badge/113714660.svg | ||
:target: https://zenodo.org/badge/latestdoi/113714660 | ||
.. |Binder| image:: https://mybinder.org/badge.svg | ||
:target: https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb | ||
.. |Join the chat at https://gitter.im/python-adaptive/adaptive| image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg | ||
:target: https://gitter.im/python-adaptive/adaptive | ||
.. references-end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.