Sphinx documentation for 596ae6b

Author: sphinx-upload[bot]

latest/_autosummary/baybe.acquisition.partial.PartialAcquisitionFunction.html

@@ -1136,7 +1136,7 @@ <h1>PartialAcquisitionFunction<a class="headerlink" href="#partialacquisitionfun
 </div>
 <dl class="py method">
 <dt class="sig sig-object py" id="baybe.acquisition.partial.PartialAcquisitionFunction.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">botorch_acqf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/acquisition.html#botorch.acquisition.acquisition.AcquisitionFunction" title="(in BoTorch v0.15.2.dev29+g1518b304f)"><span class="pre">AcquisitionFunction</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pinned_part</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><span class="pre">Tensor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pin_discrete</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.__init__" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">botorch_acqf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/acquisition.html#botorch.acquisition.acquisition.AcquisitionFunction" title="(in BoTorch v0.15.2.dev29+g1518b304f)"><span class="pre">AcquisitionFunction</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pinned_part</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><span class="pre">Tensor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pin_discrete</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.__init__" title="Link to this definition">¶</a></dt>
 <dd><p>Method generated by attrs for class PartialAcquisitionFunction.</p>
 <p>For details on the parameters, see <strong>Public attributes and properties</strong>.</p>
 <dl class="field-list simple">
@@ -1145,14 +1145,14 @@ <h1>PartialAcquisitionFunction<a class="headerlink" href="#partialacquisitionfun
 
 <dl class="py method">
 <dt class="sig sig-object py" id="baybe.acquisition.partial.PartialAcquisitionFunction.set_X_pending">
-<span class="sig-name descname"><span class="pre">set_X_pending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X_pending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><span class="pre">Tensor</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/acquisition/partial.html#PartialAcquisitionFunction.set_X_pending"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.set_X_pending" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">set_X_pending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X_pending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><span class="pre">Tensor</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/acquisition/partial.html#PartialAcquisitionFunction.set_X_pending"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.set_X_pending" title="Link to this definition">¶</a></dt>
 <dd><p>Inform the acquisition function about pending design points.</p>
 <p>Enhances the original <code class="docutils literal notranslate"><span class="pre">set_X_pending</span></code> function from the full acquisition
 function as we need to store the full point, i.e., the point in the hybrid space
 for the <code class="docutils literal notranslate"><span class="pre">PartialAcquisitionFunction</span></code> to work properly.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="target" id="baybe.acquisition.partial.PartialAcquisitionFunction.set_X_pending.params.X_pending"></span><strong>X_pending</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – <code class="docutils literal notranslate"><span class="pre">n</span> <span class="pre">x</span> <span class="pre">d</span></code> Tensor with n d-dim design points that have been
+<dd class="field-odd"><p><span class="target" id="baybe.acquisition.partial.PartialAcquisitionFunction.set_X_pending.params.X_pending"></span><strong>X_pending</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – <code class="docutils literal notranslate"><span class="pre">n</span> <span class="pre">x</span> <span class="pre">d</span></code> Tensor with n d-dim design points that have been
 submitted for evaluation but have not yet been evaluated.</p>
 </dd>
 </dl>
@@ -1173,7 +1173,7 @@ <h1>PartialAcquisitionFunction<a class="headerlink" href="#partialacquisitionfun
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="baybe.acquisition.partial.PartialAcquisitionFunction.pinned_part">
-<span class="sig-name descname"><span class="pre">pinned_part</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a></em><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.pinned_part" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">pinned_part</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a></em><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.pinned_part" title="Link to this definition">¶</a></dt>
 <dd><p>The values that will be attached whenever evaluating the acquisition function.</p>
 </dd></dl>
 

latest/_autosummary/baybe.acquisition.utils.make_partitioning.html

@@ -1098,15 +1098,15 @@
 <h1>baybe.acquisition.utils.make_partitioning<a class="headerlink" href="#baybe-acquisition-utils-make-partitioning" title="Link to this heading">¶</a></h1>
 <dl class="py function">
 <dt class="sig sig-object py" id="baybe.acquisition.utils.make_partitioning">
-<span class="sig-prename descclassname"><span class="pre">baybe.acquisition.utils.</span></span><span class="sig-name descname"><span class="pre">make_partitioning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">predictions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><span class="pre">Tensor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_point</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><span class="pre">Tensor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/acquisition/utils.html#make_partitioning"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.acquisition.utils.make_partitioning" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">baybe.acquisition.utils.</span></span><span class="sig-name descname"><span class="pre">make_partitioning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">predictions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><span class="pre">Tensor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_point</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><span class="pre">Tensor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/acquisition/utils.html#make_partitioning"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.acquisition.utils.make_partitioning" title="Link to this definition">¶</a></dt>
 <dd><p>Create a <a class="reference external" href="https://botorch.readthedocs.io/en/latest/utils.html#botorch.utils.multi_objective.box_decompositions.box_decomposition.BoxDecomposition" title="(in BoTorch v0.15.2.dev29+g1518b304f)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BoxDecomposition</span></code></a> object for the given predictions and reference point.</p>
 <p>For details on the arguments, see
 <a class="reference external" href="https://botorch.readthedocs.io/en/latest/utils.html#botorch.utils.multi_objective.box_decompositions.non_dominated.NondominatedPartitioning" title="(in BoTorch v0.15.2.dev29+g1518b304f)"><code class="xref py py-class docutils literal notranslate"><span class="pre">NondominatedPartitioning</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><span class="target" id="baybe.acquisition.utils.make_partitioning.params.predictions"></span><strong>predictions</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a></span>) – The predictions tensor of shape (n_samples, n_outputs).</p></li>
-<li><p><span class="target" id="baybe.acquisition.utils.make_partitioning.params.ref_point"></span><strong>ref_point</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.9.0a0+git80bf883 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a></span>) – The reference point tensor of shape (n_outputs,).</p></li>
+<li><p><span class="target" id="baybe.acquisition.utils.make_partitioning.params.predictions"></span><strong>predictions</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a></span>) – The predictions tensor of shape (n_samples, n_outputs).</p></li>
+<li><p><span class="target" id="baybe.acquisition.utils.make_partitioning.params.ref_point"></span><strong>ref_point</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.10.0a0+git4a757e1 ))"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></a></span>) – The reference point tensor of shape (n_outputs,).</p></li>
 <li><p><span class="target" id="baybe.acquisition.utils.make_partitioning.params.alpha"></span><strong>alpha</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – Optional threshold parameter controlling the partitioning generation.
 Hypercells with a volume fraction (relative to the total Pareto set
 hypervolume) less than the specified value will be dropped, leading to more