From de21e4dd035324e42c788d38c806bb260df901e7 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Thu, 23 Sep 2021 18:38:34 +0200 Subject: [PATCH 1/3] Splits up documentations page into "algo+examples" and rest --- .../{docs.rst => algorithms_and_examples.rst} | 14 ++++---------- docs/source/index.rst | 3 ++- docs/source/misc.rst | 10 ++++++++++ 3 files changed, 16 insertions(+), 11 deletions(-) rename docs/source/{docs.rst => algorithms_and_examples.rst} (95%) create mode 100644 docs/source/misc.rst diff --git a/docs/source/docs.rst b/docs/source/algorithms_and_examples.rst similarity index 95% rename from docs/source/docs.rst rename to docs/source/algorithms_and_examples.rst index e753a1599..432ed5cf4 100644 --- a/docs/source/docs.rst +++ b/docs/source/algorithms_and_examples.rst @@ -22,6 +22,8 @@ The following learners are implemented: estimate the mean value of the function at each point, - `~adaptive.IntegratorLearner`, for when you want to intergrate a 1D function ``f: ℝ → ℝ``. +- ``~adaptive.BalancingLearner``, for when you want to run several learners at once, + selecting the “best” one each time you get more points. Meta-learners (to be used with other learners): @@ -33,6 +35,8 @@ 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 `_, +`mpi4py `_, +`loky `_, `ipyparallel `_ and `distributed `_. @@ -168,13 +172,3 @@ on the *Play* :fa:`play` button or move the sliders. fig see more in the :ref:`Tutorial Adaptive`. - -.. include:: ../../README.rst - :start-after: not-in-documentation-end - :end-before: credits-end - -.. mdinclude:: ../../AUTHORS.md - -.. include:: ../../README.rst - :start-after: credits-end - :end-before: references-start diff --git a/docs/source/index.rst b/docs/source/index.rst index 545e9ff3b..80f7529ed 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,7 +16,8 @@ :maxdepth: 2 :hidden: - docs + algorithms_and_examples + misc tutorial/tutorial usage_examples reference/adaptive diff --git a/docs/source/misc.rst b/docs/source/misc.rst new file mode 100644 index 000000000..13d26178f --- /dev/null +++ b/docs/source/misc.rst @@ -0,0 +1,10 @@ + +.. include:: ../../README.rst + :start-after: not-in-documentation-end + :end-before: credits-end + +.. mdinclude:: ../../AUTHORS.md + +.. include:: ../../README.rst + :start-after: credits-end + :end-before: references-start From 4a819613d20f96820626ccf5fea59a76c033a916 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Thu, 23 Sep 2021 18:47:10 +0200 Subject: [PATCH 2/3] use common text from README --- README.rst | 14 +++++++++----- docs/source/algorithms_and_examples.rst | 19 ++++--------------- 2 files changed, 13 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index ad3f308c7..e4995e880 100644 --- a/README.rst +++ b/README.rst @@ -25,10 +25,6 @@ to see examples of how to use ``adaptive`` or visit the .. summary-end -**WARNING: adaptive is still in a beta development stage** - -.. not-in-documentation-start - Implemented algorithms ---------------------- @@ -44,6 +40,8 @@ but the details of the adaptive sampling are completely customizable. The following learners are implemented: +.. not-in-documentation-start + - ``Learner1D``, for 1D functions ``f: ℝ → ℝ^N``, - ``Learner2D``, for 2D functions ``f: ℝ^2 → ℝ^N``, - ``LearnerND``, for ND functions ``f: ℝ^N → ℝ^M``, @@ -52,10 +50,16 @@ The following learners are implemented: - ``AverageLearner1D``, for stochastic 1D functions where you want to estimate the mean value of the function at each point, - ``IntegratorLearner``, for - when you want to intergrate a 1D function ``f: ℝ → ℝ``, + 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. +Meta-learners (to be used with other learners): + +- ``BalancingLearner``, for when you want to run several learners at once, + selecting the “best” one each time you get more points, +- ``DataSaver``, for when your function doesn't just return a scalar or a vector. + 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 diff --git a/docs/source/algorithms_and_examples.rst b/docs/source/algorithms_and_examples.rst index 432ed5cf4..89a42e866 100644 --- a/docs/source/algorithms_and_examples.rst +++ b/docs/source/algorithms_and_examples.rst @@ -1,17 +1,6 @@ -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: +.. include:: ../../README.rst + :start-after: summary-end + :end-before: not-in-documentation-start - `~adaptive.Learner1D`, for 1D functions ``f: ℝ → ℝ^N``, - `~adaptive.Learner2D`, for 2D functions ``f: ℝ^2 → ℝ^N``, @@ -22,7 +11,7 @@ The following learners are implemented: estimate the mean value of the function at each point, - `~adaptive.IntegratorLearner`, for when you want to intergrate a 1D function ``f: ℝ → ℝ``. -- ``~adaptive.BalancingLearner``, for when you want to run several learners at once, +- `~adaptive.BalancingLearner`, for when you want to run several learners at once, selecting the “best” one each time you get more points. Meta-learners (to be used with other learners): From 0515f105138e6fdfa6c1360d0a137fca100f2876 Mon Sep 17 00:00:00 2001 From: Bas Nijholt Date: Thu, 23 Sep 2021 18:50:24 +0200 Subject: [PATCH 3/3] rename misc to docs --- docs/source/{misc.rst => docs.rst} | 0 docs/source/index.rst | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/source/{misc.rst => docs.rst} (100%) diff --git a/docs/source/misc.rst b/docs/source/docs.rst similarity index 100% rename from docs/source/misc.rst rename to docs/source/docs.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 80f7529ed..9e46b4ac4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,7 +17,7 @@ :hidden: algorithms_and_examples - misc + docs tutorial/tutorial usage_examples reference/adaptive