Update latest version of site

pytorch · Dec 17, 2024 · 52e5de7 · 52e5de7
1 parent 1c8cfe3
commit 52e5de7
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 9 deletions.
diff --git a/v/latest/api/_modules/botorch/exceptions/errors.html b/v/latest/api/_modules/botorch/exceptions/errors.html
@@ -136,6 +136,15 @@ <h1>Source code for botorch.exceptions.errors</h1><div class="highlight"><pre>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">current_x</span> <span class="o">=</span> <span class="n">current_x</span></div>
 
+
+
+<div class="viewcode-block" id="InfeasibilityError">
+<a class="viewcode-back" href="../../../exceptions.html#botorch.exceptions.errors.InfeasibilityError">[docs]</a>
+<span class="k">class</span> <span class="nc">InfeasibilityError</span><span class="p">(</span><span class="n">BotorchError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
+<span class="w">    </span><span class="sa">r</span><span class="sd">"""Exception raised when infeasibility occurs."""</span>
+
+    <span class="k">pass</span></div>
+
 </pre></div>
 </div>
 </div>

diff --git a/v/latest/api/_modules/botorch/exceptions/errors/index.html b/v/latest/api/_modules/botorch/exceptions/errors/index.html
@@ -136,6 +136,15 @@ <h1>Source code for botorch.exceptions.errors</h1><div class="highlight"><pre>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">current_x</span> <span class="o">=</span> <span class="n">current_x</span></div>
 
+
+
+<div class="viewcode-block" id="InfeasibilityError">
+<a class="viewcode-back" href="../../../exceptions.html#botorch.exceptions.errors.InfeasibilityError">[docs]</a>
+<span class="k">class</span> <span class="nc">InfeasibilityError</span><span class="p">(</span><span class="n">BotorchError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
+<span class="w">    </span><span class="sa">r</span><span class="sd">"""Exception raised when infeasibility occurs."""</span>
+
+    <span class="k">pass</span></div>
+
 </pre></div>
 </div>
 </div>

diff --git a/v/latest/api/_modules/botorch/utils/sampling.html b/v/latest/api/_modules/botorch/utils/sampling.html
@@ -50,7 +50,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">numpy.typing</span> <span class="k">as</span> <span class="nn">npt</span>
 <span class="kn">import</span> <span class="nn">scipy</span>
 <span class="kn">import</span> <span class="nn">torch</span>
-<span class="kn">from</span> <span class="nn">botorch.exceptions.errors</span> <span class="kn">import</span> <span class="n">BotorchError</span>
+<span class="kn">from</span> <span class="nn">botorch.exceptions.errors</span> <span class="kn">import</span> <span class="n">BotorchError</span><span class="p">,</span> <span class="n">InfeasibilityError</span>
 <span class="kn">from</span> <span class="nn">botorch.exceptions.warnings</span> <span class="kn">import</span> <span class="n">UserInputWarning</span>
 <span class="kn">from</span> <span class="nn">botorch.sampling.qmc</span> <span class="kn">import</span> <span class="n">NormalQMCEngine</span>
 <span class="kn">from</span> <span class="nn">botorch.utils.transforms</span> <span class="kn">import</span> <span class="n">unnormalize</span>
@@ -289,7 +289,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
 <span class="sd">    """</span>
     <span class="c1"># Check that starting point satisfies the constraints.</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="p">((</span><span class="n">slack</span> <span class="o">:=</span> <span class="n">A</span> <span class="o">@</span> <span class="n">x0</span> <span class="o">-</span> <span class="n">b</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">)</span><span class="o">.</span><span class="n">all</span><span class="p">():</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+        <span class="k">raise</span> <span class="n">InfeasibilityError</span><span class="p">(</span>
             <span class="sa">f</span><span class="s2">"Starting point does not satisfy the constraints. Inputs: </span><span class="si">{</span><span class="n">A</span><span class="si">=}</span><span class="s2">,"</span>
             <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">b</span><span class="si">=}</span><span class="s2">, </span><span class="si">{</span><span class="n">x0</span><span class="si">=}</span><span class="s2">, A@x0-b=</span><span class="si">{</span><span class="n">slack</span><span class="si">}</span><span class="s2">."</span>
         <span class="p">)</span>
@@ -488,7 +488,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
         <span class="p">)</span>
 
     <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+        <span class="k">raise</span> <span class="n">InfeasibilityError</span><span class="p">(</span>
             <span class="s2">"No feasible point found. Constraint polytope appears empty. "</span>
             <span class="o">+</span> <span class="s2">"Check your constraints."</span>
         <span class="p">)</span>
@@ -573,7 +573,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">feasible</span><span class="p">(</span><span class="n">interior_point</span><span class="p">):</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">x0</span> <span class="o">=</span> <span class="n">interior_point</span>
             <span class="k">else</span><span class="p">:</span>
-                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"The given input point is not feasible."</span><span class="p">)</span>
+                <span class="k">raise</span> <span class="n">InfeasibilityError</span><span class="p">(</span><span class="s2">"The given input point is not feasible."</span><span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">x0</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_interior_point</span><span class="p">()</span>
 

diff --git a/v/latest/api/_modules/botorch/utils/sampling/index.html b/v/latest/api/_modules/botorch/utils/sampling/index.html
@@ -50,7 +50,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">numpy.typing</span> <span class="k">as</span> <span class="nn">npt</span>
 <span class="kn">import</span> <span class="nn">scipy</span>
 <span class="kn">import</span> <span class="nn">torch</span>
-<span class="kn">from</span> <span class="nn">botorch.exceptions.errors</span> <span class="kn">import</span> <span class="n">BotorchError</span>
+<span class="kn">from</span> <span class="nn">botorch.exceptions.errors</span> <span class="kn">import</span> <span class="n">BotorchError</span><span class="p">,</span> <span class="n">InfeasibilityError</span>
 <span class="kn">from</span> <span class="nn">botorch.exceptions.warnings</span> <span class="kn">import</span> <span class="n">UserInputWarning</span>
 <span class="kn">from</span> <span class="nn">botorch.sampling.qmc</span> <span class="kn">import</span> <span class="n">NormalQMCEngine</span>
 <span class="kn">from</span> <span class="nn">botorch.utils.transforms</span> <span class="kn">import</span> <span class="n">unnormalize</span>
@@ -289,7 +289,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
 <span class="sd">    """</span>
     <span class="c1"># Check that starting point satisfies the constraints.</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="p">((</span><span class="n">slack</span> <span class="o">:=</span> <span class="n">A</span> <span class="o">@</span> <span class="n">x0</span> <span class="o">-</span> <span class="n">b</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">)</span><span class="o">.</span><span class="n">all</span><span class="p">():</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+        <span class="k">raise</span> <span class="n">InfeasibilityError</span><span class="p">(</span>
             <span class="sa">f</span><span class="s2">"Starting point does not satisfy the constraints. Inputs: </span><span class="si">{</span><span class="n">A</span><span class="si">=}</span><span class="s2">,"</span>
             <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">b</span><span class="si">=}</span><span class="s2">, </span><span class="si">{</span><span class="n">x0</span><span class="si">=}</span><span class="s2">, A@x0-b=</span><span class="si">{</span><span class="n">slack</span><span class="si">}</span><span class="s2">."</span>
         <span class="p">)</span>
@@ -488,7 +488,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
         <span class="p">)</span>
 
     <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+        <span class="k">raise</span> <span class="n">InfeasibilityError</span><span class="p">(</span>
             <span class="s2">"No feasible point found. Constraint polytope appears empty. "</span>
             <span class="o">+</span> <span class="s2">"Check your constraints."</span>
         <span class="p">)</span>
@@ -573,7 +573,7 @@ <h1>Source code for botorch.utils.sampling</h1><div class="highlight"><pre>
             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">feasible</span><span class="p">(</span><span class="n">interior_point</span><span class="p">):</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">x0</span> <span class="o">=</span> <span class="n">interior_point</span>
             <span class="k">else</span><span class="p">:</span>
-                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"The given input point is not feasible."</span><span class="p">)</span>
+                <span class="k">raise</span> <span class="n">InfeasibilityError</span><span class="p">(</span><span class="s2">"The given input point is not feasible."</span><span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">x0</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_interior_point</span><span class="p">()</span>
 

diff --git a/v/latest/api/exceptions.html b/v/latest/api/exceptions.html
@@ -105,6 +105,12 @@
 </dd>
 </dl>
 </dd></dl>
+<dl class="py exception">
+<dt class="sig sig-object py" id="botorch.exceptions.errors.InfeasibilityError">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">botorch.exceptions.errors.</span></span><span class="sig-name descname"><span class="pre">InfeasibilityError</span></span><a class="reference internal" href="_modules/botorch/exceptions/errors.html#InfeasibilityError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botorch.exceptions.errors.InfeasibilityError" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#botorch.exceptions.errors.BotorchError" title="botorch.exceptions.errors.BotorchError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotorchError</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
+<p>Exception raised when infeasibility occurs.</p>
+</dd></dl>
 </section>
 <section id="module-botorch.exceptions.warnings">
 <span id="warnings"></span><h2>Warnings<a class="headerlink" href="#module-botorch.exceptions.warnings" title="Link to this heading">¶</a></h2>

diff --git a/v/latest/api/exceptions/index.html b/v/latest/api/exceptions/index.html
@@ -105,6 +105,12 @@
 </dd>
 </dl>
 </dd></dl>
+<dl class="py exception">
+<dt class="sig sig-object py" id="botorch.exceptions.errors.InfeasibilityError">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">botorch.exceptions.errors.</span></span><span class="sig-name descname"><span class="pre">InfeasibilityError</span></span><a class="reference internal" href="_modules/botorch/exceptions/errors.html#InfeasibilityError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botorch.exceptions.errors.InfeasibilityError" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#botorch.exceptions.errors.BotorchError" title="botorch.exceptions.errors.BotorchError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BotorchError</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
+<p>Exception raised when infeasibility occurs.</p>
+</dd></dl>
 </section>
 <section id="module-botorch.exceptions.warnings">
 <span id="warnings"></span><h2>Warnings<a class="headerlink" href="#module-botorch.exceptions.warnings" title="Link to this heading">¶</a></h2>

diff --git a/v/latest/api/genindex.html b/v/latest/api/genindex.html
@@ -3017,6 +3017,8 @@ <h2 id="I">I</h2>
 </li>
 <li><a href="optim.html#botorch.optim.optimize.OptimizeAcqfInputs.inequality_constraints">inequality_constraints (botorch.optim.optimize.OptimizeAcqfInputs attribute)</a>
 </li>
+<li><a href="exceptions.html#botorch.exceptions.errors.InfeasibilityError">InfeasibilityError</a>
+</li>
 <li><a href="utils.html#botorch.utils.multi_objective.hypervolume.infer_reference_point">infer_reference_point() (in module botorch.utils.multi_objective.hypervolume)</a>
 </li>
 <li><a href="models.html#botorch.models.kernels.infinite_width_bnn.InfiniteWidthBNNKernel">InfiniteWidthBNNKernel (class in botorch.models.kernels.infinite_width_bnn)</a>

diff --git a/v/latest/js/searchindex.js b/v/latest/js/searchindex.js