Sphinx documentation for ae64ca1

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

@@ -1053,7 +1053,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.13.1.dev7+gf413275)"><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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+git9ea1823 ))"><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.13.1.dev8+g8770fa4)"><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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+git9ea1823 ))"><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">
@@ -1077,7 +1077,7 @@ <h1>PartialAcquisitionFunction<a class="headerlink" href="#partialacquisitionfun
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="baybe.acquisition.partial.PartialAcquisitionFunction.botorch_acqf">
-<span class="sig-name descname"><span class="pre">botorch_acqf</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://botorch.readthedocs.io/en/latest/acquisition.html#botorch.acquisition.acquisition.AcquisitionFunction" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcquisitionFunction</span></code></a></em><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.botorch_acqf" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">botorch_acqf</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://botorch.readthedocs.io/en/latest/acquisition.html#botorch.acquisition.acquisition.AcquisitionFunction" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">AcquisitionFunction</span></code></a></em><a class="headerlink" href="#baybe.acquisition.partial.PartialAcquisitionFunction.botorch_acqf" title="Link to this definition">¶</a></dt>
 <dd><p>The acquisition function for the hybrid space.</p>
 </dd></dl>
 

latest/_autosummary/baybe.constraints.continuous.ContinuousLinearConstraint.html

@@ -1147,7 +1147,7 @@ <h1>ContinuousLinearConstraint<a class="headerlink" href="#continuouslinearconst
 <span class="sig-name descname"><span class="pre">to_botorch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="baybe.parameters.numerical.NumericalContinuousParameter.html#baybe.parameters.numerical.NumericalContinuousParameter" title="baybe.parameters.numerical.NumericalContinuousParameter"><span class="pre">NumericalContinuousParameter</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx_offset</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#int" title="(in Python v3.13)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/constraints/continuous.html#ContinuousLinearConstraint.to_botorch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.constraints.continuous.ContinuousLinearConstraint.to_botorch" title="Link to this definition">¶</a></dt>
 <dd><p>Cast the constraint in a format required by botorch.</p>
 <p>Used in calling <code class="docutils literal notranslate"><span class="pre">optimize_acqf_*</span></code> functions, for details see
-<a class="reference external" href="https://botorch.readthedocs.io/en/latest/optim.html#botorch.optim.optimize.optimize_acqf" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-func docutils literal notranslate"><span class="pre">botorch.optim.optimize.optimize_acqf()</span></code></a></p>
+<a class="reference external" href="https://botorch.readthedocs.io/en/latest/optim.html#botorch.optim.optimize.optimize_acqf" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-func docutils literal notranslate"><span class="pre">botorch.optim.optimize.optimize_acqf()</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">

latest/_autosummary/baybe.surrogates.bandit.BetaBernoulliMultiArmedBanditSurrogate.html

@@ -1153,7 +1153,7 @@ <h1>BetaBernoulliMultiArmedBanditSurrogate<a class="headerlink" href="#betaberno
 <dd class="field-even"><p><a class="reference internal" href="baybe.exceptions.ModelNotTrainedError.html#baybe.exceptions.ModelNotTrainedError" title="baybe.exceptions.ModelNotTrainedError"><strong>ModelNotTrainedError</strong></a> – When called before the model has been trained.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/posteriors.html#botorch.posteriors.posterior.Posterior" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Posterior</span></code></a></span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/posteriors.html#botorch.posteriors.posterior.Posterior" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Posterior</span></code></a></span></p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>A <code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.posteriors.Posterior</span></code> object representing the posterior
@@ -1200,7 +1200,7 @@ <h1>BetaBernoulliMultiArmedBanditSurrogate<a class="headerlink" href="#betaberno
 <dt class="sig sig-object py" id="baybe.surrogates.bandit.BetaBernoulliMultiArmedBanditSurrogate.to_botorch">
 <span class="sig-name descname"><span class="pre">to_botorch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/surrogates/bandit.html#BetaBernoulliMultiArmedBanditSurrogate.to_botorch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.surrogates.bandit.BetaBernoulliMultiArmedBanditSurrogate.to_botorch" title="Link to this definition">¶</a></dt>
 <dd><p>Create the botorch-ready representation of the fitted model.</p>
-<p>The <a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.models.model.Model</span></code></a> created by this method needs to be
+<p>The <a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.models.model.Model</span></code></a> created by this method needs to be
 configured such that it can be called with candidate points in <strong>computational
 representation</strong>, that is, input of the form as obtained via
 <a class="reference internal" href="baybe.searchspace.core.SearchSpace.html#baybe.searchspace.core.SearchSpace.transform" title="baybe.searchspace.core.SearchSpace.transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">baybe.searchspace.core.SearchSpace.transform()</span></code></a>.</p>

latest/_autosummary/baybe.surrogates.base.IndependentGaussianSurrogate.html

@@ -1144,7 +1144,7 @@ <h1>IndependentGaussianSurrogate<a class="headerlink" href="#independentgaussian
 <dd class="field-even"><p><a class="reference internal" href="baybe.exceptions.ModelNotTrainedError.html#baybe.exceptions.ModelNotTrainedError" title="baybe.exceptions.ModelNotTrainedError"><strong>ModelNotTrainedError</strong></a> – When called before the model has been trained.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/posteriors.html#botorch.posteriors.posterior.Posterior" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Posterior</span></code></a></span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/posteriors.html#botorch.posteriors.posterior.Posterior" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Posterior</span></code></a></span></p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>A <code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.posteriors.Posterior</span></code> object representing the posterior
@@ -1160,13 +1160,13 @@ <h1>IndependentGaussianSurrogate<a class="headerlink" href="#independentgaussian
 <dt class="sig sig-object py" id="baybe.surrogates.base.IndependentGaussianSurrogate.to_botorch">
 <span class="sig-name descname"><span class="pre">to_botorch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#baybe.surrogates.base.IndependentGaussianSurrogate.to_botorch" title="Link to this definition">¶</a></dt>
 <dd><p>Create the botorch-ready representation of the fitted model.</p>
-<p>The <a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.models.model.Model</span></code></a> created by this method needs to be
+<p>The <a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.models.model.Model</span></code></a> created by this method needs to be
 configured such that it can be called with candidate points in <strong>computational
 representation</strong>, that is, input of the form as obtained via
 <a class="reference internal" href="baybe.searchspace.core.SearchSpace.html#baybe.searchspace.core.SearchSpace.transform" title="baybe.searchspace.core.SearchSpace.transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">baybe.searchspace.core.SearchSpace.transform()</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></span></p>
 </dd>
 </dl>
 </dd></dl>

latest/_autosummary/baybe.surrogates.base.Surrogate.html

@@ -1144,7 +1144,7 @@ <h1>Surrogate<a class="headerlink" href="#surrogate" title="Link to this heading
 <dd class="field-even"><p><a class="reference internal" href="baybe.exceptions.ModelNotTrainedError.html#baybe.exceptions.ModelNotTrainedError" title="baybe.exceptions.ModelNotTrainedError"><strong>ModelNotTrainedError</strong></a> – When called before the model has been trained.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/posteriors.html#botorch.posteriors.posterior.Posterior" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Posterior</span></code></a></span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/posteriors.html#botorch.posteriors.posterior.Posterior" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Posterior</span></code></a></span></p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>A <code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.posteriors.Posterior</span></code> object representing the posterior
@@ -1160,13 +1160,13 @@ <h1>Surrogate<a class="headerlink" href="#surrogate" title="Link to this heading
 <dt class="sig sig-object py" id="baybe.surrogates.base.Surrogate.to_botorch">
 <span class="sig-name descname"><span class="pre">to_botorch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/baybe/surrogates/base.html#Surrogate.to_botorch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#baybe.surrogates.base.Surrogate.to_botorch" title="Link to this definition">¶</a></dt>
 <dd><p>Create the botorch-ready representation of the fitted model.</p>
-<p>The <a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.models.model.Model</span></code></a> created by this method needs to be
+<p>The <a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">botorch.models.model.Model</span></code></a> created by this method needs to be
 configured such that it can be called with candidate points in <strong>computational
 representation</strong>, that is, input of the form as obtained via
 <a class="reference internal" href="baybe.searchspace.core.SearchSpace.html#baybe.searchspace.core.SearchSpace.transform" title="baybe.searchspace.core.SearchSpace.transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">baybe.searchspace.core.SearchSpace.transform()</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev7+gf413275)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></span></p>
+<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://botorch.readthedocs.io/en/latest/models.html#botorch.models.model.Model" title="(in BoTorch v0.13.1.dev8+g8770fa4)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></span></p>
 </dd>
 </dl>
 </dd></dl>