Deploying to gh-pages from @ 5fdd603 🚀

blackjax-devs · Oct 19, 2023 · d960be0 · d960be0
1 parent aa385fd
commit d960be0
Show file tree

Hide file tree

Showing 87 changed files with 330 additions and 178 deletions.
diff --git a/.doctrees/autoapi/blackjax/_version/index.doctree b/.doctrees/autoapi/blackjax/_version/index.doctree
diff --git a/.doctrees/autoapi/blackjax/index.doctree b/.doctrees/autoapi/blackjax/index.doctree
diff --git a/.doctrees/autoapi/blackjax/mcmc/proposal/index.doctree b/.doctrees/autoapi/blackjax/mcmc/proposal/index.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/examples/howto_custom_gradients.doctree b/.doctrees/examples/howto_custom_gradients.doctree
diff --git a/.doctrees/examples/howto_metropolis_within_gibbs.doctree b/.doctrees/examples/howto_metropolis_within_gibbs.doctree
diff --git a/.doctrees/examples/howto_other_frameworks.doctree b/.doctrees/examples/howto_other_frameworks.doctree
diff --git a/.doctrees/examples/howto_sample_multiple_chains.doctree b/.doctrees/examples/howto_sample_multiple_chains.doctree
diff --git a/.doctrees/examples/howto_use_aesara.doctree b/.doctrees/examples/howto_use_aesara.doctree
diff --git a/.doctrees/examples/howto_use_numpyro.doctree b/.doctrees/examples/howto_use_numpyro.doctree
diff --git a/.doctrees/examples/howto_use_oryx.doctree b/.doctrees/examples/howto_use_oryx.doctree
diff --git a/.doctrees/examples/howto_use_pymc.doctree b/.doctrees/examples/howto_use_pymc.doctree
diff --git a/.doctrees/examples/howto_use_tfp.doctree b/.doctrees/examples/howto_use_tfp.doctree
diff --git a/.doctrees/examples/quickstart.doctree b/.doctrees/examples/quickstart.doctree
diff --git a/_images/02eb4e5e05eda43b0b761bc62ad7fcc7e317f2fb58982d578bc03a5a891f5825.png b/_images/02eb4e5e05eda43b0b761bc62ad7fcc7e317f2fb58982d578bc03a5a891f5825.png
diff --git a/_images/190cd6977cfacb35184a293ee7836d1daccff6288e4233ba8bc46e8a3e9b9271.png b/_images/190cd6977cfacb35184a293ee7836d1daccff6288e4233ba8bc46e8a3e9b9271.png
diff --git a/_images/23905eca9fca4aee7128201280c8b2cd8cc79713f700cac0bd1b30f9c0150a79.png b/_images/23905eca9fca4aee7128201280c8b2cd8cc79713f700cac0bd1b30f9c0150a79.png
diff --git a/_images/31112f6fcd2e68b30b7c51f0d56385a5e21cc3035be3e27d65fb7744ba06798c.png b/_images/31112f6fcd2e68b30b7c51f0d56385a5e21cc3035be3e27d65fb7744ba06798c.png
diff --git a/_images/3202ec3e98ce887d193ca3e6ddc0d08ce92d15a1f65413d4b3a9479dd338a3fd.png b/_images/3202ec3e98ce887d193ca3e6ddc0d08ce92d15a1f65413d4b3a9479dd338a3fd.png
diff --git a/_images/3602aa19ac4e6e2a162351d12f2911f5c88bafdd9f4729e4232457f29636e1cc.png b/_images/3602aa19ac4e6e2a162351d12f2911f5c88bafdd9f4729e4232457f29636e1cc.png
diff --git a/_images/4051c373b290729b1bf357c0ed4bd403da4bb8e879de8ebc48d167aac7a9e72e.png b/_images/4051c373b290729b1bf357c0ed4bd403da4bb8e879de8ebc48d167aac7a9e72e.png
diff --git a/_images/45b5a6da0456bb4b4194e6f932e1391d97070bc140b23d6bdee819f86a13f011.png b/_images/45b5a6da0456bb4b4194e6f932e1391d97070bc140b23d6bdee819f86a13f011.png
diff --git a/_images/5efbcf3f56fbc08b69e119c63299b607705dc22f45e89b8193de817663761a40.png b/_images/5efbcf3f56fbc08b69e119c63299b607705dc22f45e89b8193de817663761a40.png
diff --git a/_images/61f49fd1cea6b80d6c7d08a7e95ecae3977b154e02e1db4735e2555cb83c177e.png b/_images/61f49fd1cea6b80d6c7d08a7e95ecae3977b154e02e1db4735e2555cb83c177e.png
diff --git a/_images/7d4e61ecb18cb7f5d80435b12f407b41f9723ff94263dfe7c4a0ffe697de2492.png b/_images/7d4e61ecb18cb7f5d80435b12f407b41f9723ff94263dfe7c4a0ffe697de2492.png
diff --git a/_images/959a0e20efe03c12e7fd4705b77f32fbb4737ac37f54b7ca9284bbce7a91a1cb.png b/_images/959a0e20efe03c12e7fd4705b77f32fbb4737ac37f54b7ca9284bbce7a91a1cb.png
diff --git a/_images/a0e525b7955bf317a5fc845c93913a809fb3d3ea936934beafba5e25561bf821.png b/_images/a0e525b7955bf317a5fc845c93913a809fb3d3ea936934beafba5e25561bf821.png
diff --git a/_images/b65fd7c942f93888b7614568b7d9445751f0f2b73c0dbd3d7940175ecd9c942f.png b/_images/b65fd7c942f93888b7614568b7d9445751f0f2b73c0dbd3d7940175ecd9c942f.png
diff --git a/_images/c97f857c50be6166274547ea63007fe4f94e005c329fbef7def5702bc27a7ea7.png b/_images/c97f857c50be6166274547ea63007fe4f94e005c329fbef7def5702bc27a7ea7.png
diff --git a/_images/e4ceb89c469ffcb82a498e2a49d086747fd2ab6bd444b262e7dc948cf6cef77a.png b/_images/e4ceb89c469ffcb82a498e2a49d086747fd2ab6bd444b262e7dc948cf6cef77a.png
diff --git a/_images/e8266c3b8e38e5584894a954e7d88fe0d1001ab8fd2ef6917059b35c0eb569a7.png b/_images/e8266c3b8e38e5584894a954e7d88fe0d1001ab8fd2ef6917059b35c0eb569a7.png
diff --git a/_modules/blackjax/_version.html b/_modules/blackjax/_version.html
@@ -341,10 +341,18 @@ <h1>Source code for blackjax._version</h1><div class="highlight"><pre>
 <span class="c1"># don&#39;t change, don&#39;t track in version control</span>
 <div class="viewcode-block" id="TYPE_CHECKING"><a class="viewcode-back" href="../../autoapi/blackjax/_version/index.html#blackjax._version.TYPE_CHECKING">[docs]</a><span class="n">TYPE_CHECKING</span> <span class="o">=</span> <span class="kc">False</span></div>
 <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
-    <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
-
-<span class="n">__version__</span> <span class="o">=</span> <span class="n">version</span> <span class="o">=</span> <span class="s1">&#39;0.1.dev1+g51cf08a&#39;</span>  <span class="c1"># type: str</span>
-<span class="n">__version_tuple__</span> <span class="o">=</span> <span class="n">version_tuple</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;dev1&#39;</span><span class="p">,</span> <span class="s1">&#39;g51cf08a&#39;</span><span class="p">)</span>  <span class="c1"># type: Tuple[int | str, ...]</span>
+    <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>
+<div class="viewcode-block" id="VERSION_TUPLE"><a class="viewcode-back" href="../../autoapi/blackjax/_version/index.html#blackjax._version.VERSION_TUPLE">[docs]</a>    <span class="n">VERSION_TUPLE</span> <span class="o">=</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span></div>
+<span class="k">else</span><span class="p">:</span>
+    <span class="n">VERSION_TUPLE</span> <span class="o">=</span> <span class="nb">object</span>
+
+<div class="viewcode-block" id="version"><a class="viewcode-back" href="../../autoapi/blackjax/_version/index.html#blackjax._version.version">[docs]</a><span class="n">version</span><span class="p">:</span> <span class="nb">str</span></div>
+<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span>
+<span class="n">__version_tuple__</span><span class="p">:</span> <span class="n">VERSION_TUPLE</span>
+<div class="viewcode-block" id="version_tuple"><a class="viewcode-back" href="../../autoapi/blackjax/_version/index.html#blackjax._version.version_tuple">[docs]</a><span class="n">version_tuple</span><span class="p">:</span> <span class="n">VERSION_TUPLE</span></div>
+
+<span class="n">__version__</span> <span class="o">=</span> <span class="n">version</span> <span class="o">=</span> <span class="s1">&#39;0.1.dev1+g5fdd603&#39;</span>
+<span class="n">__version_tuple__</span> <span class="o">=</span> <span class="n">version_tuple</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;dev1&#39;</span><span class="p">,</span> <span class="s1">&#39;g5fdd603&#39;</span><span class="p">)</span>
 </pre></div>
 
                 </article>

diff --git a/_modules/blackjax/mcmc/proposal.html b/_modules/blackjax/mcmc/proposal.html
@@ -447,7 +447,7 @@ <h1>Source code for blackjax.mcmc.proposal</h1><div class="highlight"><pre>
 <span class="sd">    new_energy</span>
 <span class="sd">        the energy at the proposed state</span>
 <span class="sd">    divergence_threshold</span>
-<span class="sd">        max value allowed for the difference in energies not to be considered a divergence</span>
+<span class="sd">        max value allowed for an increase in energies not to be considered a divergence</span>
 <span class="sd">    state</span>
 <span class="sd">        the proposed state</span>
 
@@ -457,7 +457,7 @@ <h1>Source code for blackjax.mcmc.proposal</h1><div class="highlight"><pre>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">delta_energy</span> <span class="o">=</span> <span class="n">initial_energy</span> <span class="o">-</span> <span class="n">new_energy</span>
     <span class="n">delta_energy</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">jnp</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">delta_energy</span><span class="p">),</span> <span class="o">-</span><span class="n">jnp</span><span class="o">.</span><span class="n">inf</span><span class="p">,</span> <span class="n">delta_energy</span><span class="p">)</span>
-    <span class="n">is_transition_divergent</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">abs</span><span class="p">(</span><span class="n">delta_energy</span><span class="p">)</span> <span class="o">&gt;</span> <span class="n">divergence_threshold</span>
+    <span class="n">is_transition_divergent</span> <span class="o">=</span> <span class="o">-</span><span class="n">delta_energy</span> <span class="o">&gt;</span> <span class="n">divergence_threshold</span>
 
     <span class="c1"># The weight of the new proposal is equal to H0 - H(z_new)</span>
     <span class="n">weight</span> <span class="o">=</span> <span class="n">delta_energy</span>

diff --git a/_sources/autoapi/blackjax/_version/index.rst b/_sources/autoapi/blackjax/_version/index.rst
@@ -14,3 +14,17 @@ Module Contents
 
 
 
+.. py:data:: VERSION_TUPLE
+
+   
+
+.. py:data:: version
+   :type: str
+
+
+
+.. py:data:: version_tuple
+   :type: VERSION_TUPLE
+
+
+
diff --git a/_sources/autoapi/blackjax/index.rst b/_sources/autoapi/blackjax/index.rst
@@ -69,6 +69,15 @@ Functions
 
 
 
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   blackjax.__version__
+
+
+
 
 
 

diff --git a/_sources/autoapi/blackjax/mcmc/proposal/index.rst b/_sources/autoapi/blackjax/mcmc/proposal/index.rst
@@ -100,7 +100,7 @@ Attributes
 
    :param initial_energy: the energy from the initial state
    :param new_energy: the energy at the proposed state
-   :param divergence_threshold: max value allowed for the difference in energies not to be considered a divergence
+   :param divergence_threshold: max value allowed for an increase in energies not to be considered a divergence
    :param state: the proposed state
 
    :rtype: A proposal and a flag for divergence

diff --git a/autoapi/blackjax/_version/index.html b/autoapi/blackjax/_version/index.html
@@ -337,6 +337,9 @@ <h2> Contents </h2>
                 <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-contents">Module Contents</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.TYPE_CHECKING"><code class="docutils literal notranslate"><span class="pre">TYPE_CHECKING</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.VERSION_TUPLE"><code class="docutils literal notranslate"><span class="pre">VERSION_TUPLE</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.version"><code class="docutils literal notranslate"><span class="pre">version</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.version_tuple"><code class="docutils literal notranslate"><span class="pre">version_tuple</span></code></a></li>
 </ul>
 </li>
 </ul>
@@ -359,6 +362,21 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <span class="sig-name descname"><span class="pre">TYPE_CHECKING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference internal" href="../../../_modules/blackjax/_version.html#TYPE_CHECKING"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#blackjax._version.TYPE_CHECKING" title="Permalink to this definition">#</a></dt>
 <dd></dd></dl>
 
+<dl class="py data">
+<dt class="sig sig-object py" id="blackjax._version.VERSION_TUPLE">
+<span class="sig-name descname"><span class="pre">VERSION_TUPLE</span></span><a class="reference internal" href="../../../_modules/blackjax/_version.html#VERSION_TUPLE"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#blackjax._version.VERSION_TUPLE" title="Permalink to this definition">#</a></dt>
+<dd></dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="blackjax._version.version">
+<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="reference internal" href="../../../_modules/blackjax/_version.html#version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#blackjax._version.version" title="Permalink to this definition">#</a></dt>
+<dd></dd></dl>
+
+<dl class="py data">
+<dt class="sig sig-object py" id="blackjax._version.version_tuple">
+<span class="sig-name descname"><span class="pre">version_tuple</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">VERSION_TUPLE</span></em><a class="reference internal" href="../../../_modules/blackjax/_version.html#version_tuple"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#blackjax._version.version_tuple" title="Permalink to this definition">#</a></dt>
+<dd></dd></dl>
+
 </section>
 </section>
 
@@ -390,6 +408,9 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-contents">Module Contents</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.TYPE_CHECKING"><code class="docutils literal notranslate"><span class="pre">TYPE_CHECKING</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.VERSION_TUPLE"><code class="docutils literal notranslate"><span class="pre">VERSION_TUPLE</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.version"><code class="docutils literal notranslate"><span class="pre">version</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#blackjax._version.version_tuple"><code class="docutils literal notranslate"><span class="pre">version_tuple</span></code></a></li>
 </ul>
 </li>
 </ul>

diff --git a/autoapi/blackjax/adaptation/base/index.html b/autoapi/blackjax/adaptation/base/index.html
@@ -395,7 +395,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="blackjax.adaptation.base.AdaptationResults.parameters">
-<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.11)"><span class="pre">dict</span></a></em><a class="reference internal" href="../../../../_modules/blackjax/adaptation/base.html#AdaptationResults.parameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#blackjax.adaptation.base.AdaptationResults.parameters" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a></em><a class="reference internal" href="../../../../_modules/blackjax/adaptation/base.html#AdaptationResults.parameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#blackjax.adaptation.base.AdaptationResults.parameters" title="Permalink to this definition">#</a></dt>
 <dd></dd></dl>
 
 </dd></dl>