Skip to content

Commit

Permalink
Sphinx documentation for deb3d5a
Browse files Browse the repository at this point in the history
  • Loading branch information
sphinx-upload[bot] committed Jan 15, 2025
1 parent 1995d25 commit f396fcf
Show file tree
Hide file tree
Showing 37 changed files with 445 additions and 440 deletions.
8 changes: 4 additions & 4 deletions latest/_autosummary/baybe.acquisition.partial.PartialAcquisitionFunction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1031,7 +1031,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"><span class="pre">AcquisitionFunction</span></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+gitdcc04e9 ))"><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"><span class="pre">AcquisitionFunction</span></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+git8c2aa0c ))"><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">
Expand All @@ -1040,14 +1040,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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+gitdcc04e9 ))"><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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+git8c2aa0c ))"><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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+gitdcc04e9 ))"><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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+git8c2aa0c ))"><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>
Expand All @@ -1068,7 +1068,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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+gitdcc04e9 ))"><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://pytorch.org/docs/main/tensors.html#torch.Tensor" title="(in PyTorch vmain (2.7.0a0+git8c2aa0c ))"><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>

Expand Down
2 changes: 1 addition & 1 deletion latest/_autosummary/baybe.kernels.base.BasicKernel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1091,7 +1091,7 @@ <h1>BasicKernel<a class="headerlink" href="#basickernel" title="Link to this hea

<dl class="py method">
<dt class="sig sig-object py" id="baybe.kernels.base.BasicKernel.to_gpytorch">
<span class="sig-name descname"><span class="pre">to_gpytorch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ard_num_dims</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 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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_shape</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/size.html#torch.Size" title="(in PyTorch vmain (2.7.0a0+gitdcc04e9 ))"><span class="pre">Size</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_dims</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/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><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 class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#baybe.kernels.base.BasicKernel.to_gpytorch" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">to_gpytorch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ard_num_dims</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 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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_shape</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/size.html#torch.Size" title="(in PyTorch vmain (2.7.0a0+git8c2aa0c ))"><span class="pre">Size</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">active_dims</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/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><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 class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#baybe.kernels.base.BasicKernel.to_gpytorch" title="Link to this definition"></a></dt>
<dd><p>Create the gpytorch representation of the kernel.</p>
<dl class="field-list simple">
</dl>
Expand Down
Loading

0 comments on commit f396fcf

Please sign in to comment.