Skip to content

Commit 2b37817

Browse files
committed
hide directive
1 parent 4507195 commit 2b37817

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
*Adaptive*: parallel active learning of mathematical functions.
1010

11-
.. animated-logo::
11+
.. include:: logo.rst
1212

1313
``adaptive`` is an open-source Python library designed to
1414
make adaptive parallel function evaluation simple. With ``adaptive`` you
@@ -27,6 +27,10 @@ to see examples of how to use ``adaptive`` or visit the
2727

2828
.. summary-end
2929
30+
**WARNING: adaptive is still in a beta development stage**
31+
32+
.. not-in-documentation-start
33+
3034
Implemented algorithms
3135
----------------------
3236

@@ -42,8 +46,6 @@ but the details of the adaptive sampling are completely customizable.
4246

4347
The following learners are implemented:
4448

45-
.. not-in-documentation-start
46-
4749
- ``Learner1D``, for 1D functions ``f: ℝ → ℝ^N``,
4850
- ``Learner2D``, for 2D functions ``f: ℝ^2 → ℝ^N``,
4951
- ``LearnerND``, for ND functions ``f: ℝ^N → ℝ^M``,
@@ -52,16 +54,10 @@ The following learners are implemented:
5254
- ``AverageLearner1D``, for stochastic 1D functions where you want to
5355
estimate the mean value of the function at each point,
5456
- ``IntegratorLearner``, for
55-
when you want to intergrate a 1D function ``f: ℝ → ℝ``.
57+
when you want to intergrate a 1D function ``f: ℝ → ℝ``,
5658
- ``BalancingLearner``, for when you want to run several learners at once,
5759
selecting the “best” one each time you get more points.
5860

59-
Meta-learners (to be used with other learners):
60-
61-
- ``BalancingLearner``, for when you want to run several learners at once,
62-
selecting the “best” one each time you get more points,
63-
- ``DataSaver``, for when your function doesn't just return a scalar or a vector.
64-
6561
In addition to the learners, ``adaptive`` also provides primitives for
6662
running the sampling across several cores and even several machines,
6763
with built-in support for
@@ -71,6 +67,7 @@ with built-in support for
7167
`ipyparallel <https://ipyparallel.readthedocs.io/en/latest/>`_ and
7268
`distributed <https://distributed.readthedocs.io/en/latest/>`_.
7369

70+
7471
Examples
7572
--------
7673

docs/source/logo.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. animated-logo::

0 commit comments

Comments
 (0)