docs: adding description of tutorials

kjappelbaum · Oct 25, 2020 · a78fa86 · a78fa86
1 parent 6cabb45
commit a78fa86
Show file tree

Hide file tree

Showing 32 changed files with 112 additions and 34 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/getting_started.doctree b/docs/_build/doctrees/getting_started.doctree
diff --git a/docs/_build/doctrees/tutorials.doctree b/docs/_build/doctrees/tutorials.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: eb1b58b8f9c80a0fdd55070f5fa71994
+config: e18455de809a111ac62f96b851169189
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Overview: module code &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/models/gpr.html b/docs/_build/html/_modules/pypal/models/gpr.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.models.gpr &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.models.gpr &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/core.html b/docs/_build/html/_modules/pypal/pal/core.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.core &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.core &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/pal_base.html b/docs/_build/html/_modules/pypal/pal/pal_base.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.pal_base &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.pal_base &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/pal_coregionalized.html b/docs/_build/html/_modules/pypal/pal/pal_coregionalized.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.pal_coregionalized &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.pal_coregionalized &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/pal_gbdt.html b/docs/_build/html/_modules/pypal/pal/pal_gbdt.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.pal_gbdt &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.pal_gbdt &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/pal_gpy.html b/docs/_build/html/_modules/pypal/pal/pal_gpy.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.pal_gpy &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.pal_gpy &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/pal_sklearn.html b/docs/_build/html/_modules/pypal/pal/pal_sklearn.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.pal_sklearn &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.pal_sklearn &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/schedules.html b/docs/_build/html/_modules/pypal/pal/schedules.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.schedules &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.schedules &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/utils.html b/docs/_build/html/_modules/pypal/pal/utils.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.utils &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.utils &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/pal/validate_inputs.html b/docs/_build/html/_modules/pypal/pal/validate_inputs.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.pal.validate_inputs &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.pal.validate_inputs &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_modules/pypal/plotting.html b/docs/_build/html/_modules/pypal/plotting.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pypal.plotting &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>pypal.plotting &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="../../_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/_sources/getting_started.rst.txt b/docs/_build/html/_sources/getting_started.rst.txt
@@ -193,7 +193,7 @@ By default, the code will run a simple cross-validation only on the first iterat
 
 This behavior can changed with the cross-validation test being performed more frequently by overriding the :code:`should_run_crossvalidation` function.
 
-Another way to detect overfitting is to use :py:func:`pypal.plotting.make_jointplot`function from the plotting subpackage. This function will plot all objectives against each other (with errorbars and different classes indicated with colors) and histograms of the objectives on the diagonal. If the majority of predicted points tend to overlap one another and get discarded by PyPAL, this may suggest that the surrogate model is overfitted.
+Another way to detect overfitting is to use :py:func:`pypal.plotting.make_jointplot` function from the plotting subpackage. This function will plot all objectives against each other (with errorbars and different classes indicated with colors) and histograms of the objectives on the diagonal. If the majority of predicted points tend to overlap one another and get discarded by PyPAL, this may suggest that the surrogate model is overfitted.
 
 .. code-block:: python
 

diff --git a/docs/_build/html/_sources/tutorials.rst.txt b/docs/_build/html/_sources/tutorials.rst.txt
@@ -2,7 +2,8 @@ Tutorials
 ============
 
 To explore different use cases of PyPAL, we recommend checking out the `example notebooks <https://github.com/kjappelbaum/pypal/tree/master/examples>`_.
-All notebooks can be run without installation on MyBinder.
+All notebooks can be run without installation on MyBinder. In the folder, you find the notebooks with the output cells, if you rerun them, the execution
+should not take more than a few minutes.
 
 
 1. One active learning step using GPR models built with :code:`GPy`
@@ -12,6 +13,13 @@ All notebooks can be run without installation on MyBinder.
     :width: 400px
     :align: center
 
+Topic covered
+................
+
+- building a pal_coregionalized GPR model using :py:meth:`pypal.pal.models.gpr.build_coregionalized_model`
+-  using coregionalized models with :py:obj:`pypal.pal.pal_coregionalized.PALCoregionalized`
+- attributes of the :code:`PAL` instance
+- :py:meth:`pypal.pal.utils.exhaust_loop`
 
 
 2. Active learning with "measure" function and :code:`sklearn` models
@@ -21,6 +29,13 @@ All notebooks can be run without installation on MyBinder.
     :width: 400px
     :align: center
 
+Topic covered
+................
+
+- using :code:`sklearn`  models with :py:obj:`pypal.pal.pal_sklearn.PALSklearn`
+- selecting an initial set with :py:meth:`pypal.pal.utils.get_maxmin_samples`
+- plotting with :py:meth:`pypal.plotting.make_jointplot`
+
 
 
 3. Quantile regression
@@ -29,3 +44,7 @@ All notebooks can be run without installation on MyBinder.
 .. image:: _static/quantile_regression_screenshot.png
     :width: 400px
     :align: center
+
+
+- Using LightGBM models with quantile loss with :py:obj:`pypal.pal.pal_gbdt.PALGBDT`
+- selecting an initial set with :py:meth:`pypal.pal.utils.get_kmeans_samples`
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0+untagged.212.g4af8189.dirty',
+    VERSION: '0+untagged.213.g6cabb45.dirty',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>The PyPAL API reference &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>The PyPAL API reference &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/background.html b/docs/_build/html/background.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Background &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Background &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/developer_notes.html b/docs/_build/html/developer_notes.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Developer notes &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Developer notes &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Index &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/getting_started.html b/docs/_build/html/getting_started.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Getting Started &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Getting Started &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 
@@ -371,7 +371,7 @@ <h2>Caveats and tricks with Gaussian processes<a class="headerlink" href="#cavea
 </pre></div>
 </div>
 <p>This behavior can changed with the cross-validation test being performed more frequently by overriding the <code class="code docutils literal notranslate"><span class="pre">should_run_crossvalidation</span></code> function.</p>
-<p>Another way to detect overfitting is to use :py:func:<a href="#id1"><span class="problematic" id="id2">`</span></a>pypal.plotting.make_jointplot`function from the plotting subpackage. This function will plot all objectives against each other (with errorbars and different classes indicated with colors) and histograms of the objectives on the diagonal. If the majority of predicted points tend to overlap one another and get discarded by PyPAL, this may suggest that the surrogate model is overfitted.</p>
+<p>Another way to detect overfitting is to use <a class="reference internal" href="api.html#pypal.plotting.make_jointplot" title="pypal.plotting.make_jointplot"><code class="xref py py-func docutils literal notranslate"><span class="pre">pypal.plotting.make_jointplot()</span></code></a> function from the plotting subpackage. This function will plot all objectives against each other (with errorbars and different classes indicated with colors) and histograms of the objectives on the diagonal. If the majority of predicted points tend to overlap one another and get discarded by PyPAL, this may suggest that the surrogate model is overfitted.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pypal.plotting</span> <span class="kn">import</span> <span class="n">make_jointplot</span>
 
 <span class="c1"># palinstance is a instance of a PAL class after</span>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>PyPAL: Pareto active learning for Python &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>PyPAL: Pareto active learning for Python &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 
@@ -203,8 +203,14 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="tutorials.html#one-active-learning-step-using-gpr-models-built-with-gpy">1. One active learning step using GPR models built with <code class="code docutils literal notranslate"><span class="pre">GPy</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorials.html#active-learning-with-measure-function-and-sklearn-models">2. Active learning with “measure” function and <code class="code docutils literal notranslate"><span class="pre">sklearn</span></code> models</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials.html#one-active-learning-step-using-gpr-models-built-with-gpy">1. One active learning step using GPR models built with <code class="code docutils literal notranslate"><span class="pre">GPy</span></code></a><ul>
+<li class="toctree-l3"><a class="reference internal" href="tutorials.html#topic-covered">Topic covered</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="tutorials.html#active-learning-with-measure-function-and-sklearn-models">2. Active learning with “measure” function and <code class="code docutils literal notranslate"><span class="pre">sklearn</span></code> models</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="tutorials.html#id1">Topic covered</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="tutorials.html#quantile-regression">3. Quantile regression</a></li>
 </ul>
 </li>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Python Module Index &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; pypal 0+untagged.212.g4af8189.dirty documentation</title>
+    <title>Search &#8212; pypal 0+untagged.213.g6cabb45.dirty documentation</title>
 
   <link rel="stylesheet" href="_static/css/index.d431a4ee1c1efae0e38bdfebc22debff.css">
 

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js