Skip to content

Commit

Permalink
Docs preview for PR #1420.
Browse files Browse the repository at this point in the history
  • Loading branch information
@cuda-quantum-bot
cuda-quantum-bot committed Apr 1, 2024
1 parent 51b7674 commit c87331a
Show file tree
Hide file tree
Showing 79 changed files with 429 additions and 508 deletions.
Binary file added pr-1420/_images/examples_python_tutorials_hybrid_qnns_10_1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed pr-1420/_images/examples_python_tutorials_hybrid_qnns_11_1.png
View file
Binary file not shown.
2 changes: 2 additions & 0 deletions pr-1420/_sources/api/languages/cpp_api.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@ Platform

.. doxygenclass:: cudaq::BaseRemoteSimulatorQPU

.. doxygenclass:: cudaq::BaseNvcfSimulatorQPU

.. doxygenclass:: cudaq::quantum_platform
:members:

Expand Down
4 changes: 4 additions & 0 deletions pr-1420/_sources/api/languages/python_api.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ Program Construction
.. automethod:: apply_call

.. autoclass:: cudaq::PyKernelDecorator
:members:
:special-members: __str__, __call__

.. autofunction:: kernel

Kernel Execution
=============================
Expand Down
167 changes: 45 additions & 122 deletions pr-1420/_sources/examples/python/tutorials/hybrid_qnns.ipynb.txt
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions pr-1420/api/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.PyKernel"><code class="docutils literal notranslate"><span class="pre">PyKernel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.Kernel"><code class="docutils literal notranslate"><span class="pre">Kernel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.PyKernelDecorator"><code class="docutils literal notranslate"><span class="pre">PyKernelDecorator</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.kernel"><code class="docutils literal notranslate"><span class="pre">kernel()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="languages/python_api.html#kernel-execution">Kernel Execution</a><ul>
Expand Down
1 change: 1 addition & 0 deletions pr-1420/api/default_ops.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.PyKernel"><code class="docutils literal notranslate"><span class="pre">PyKernel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.Kernel"><code class="docutils literal notranslate"><span class="pre">Kernel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.PyKernelDecorator"><code class="docutils literal notranslate"><span class="pre">PyKernelDecorator</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="languages/python_api.html#cudaq.kernel"><code class="docutils literal notranslate"><span class="pre">kernel()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="languages/python_api.html#kernel-execution">Kernel Execution</a><ul>
Expand Down
18 changes: 13 additions & 5 deletions pr-1420/api/languages/cpp_api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@
<li class="toctree-l4"><a class="reference internal" href="python_api.html#cudaq.PyKernel"><code class="docutils literal notranslate"><span class="pre">PyKernel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="python_api.html#cudaq.Kernel"><code class="docutils literal notranslate"><span class="pre">Kernel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="python_api.html#cudaq.PyKernelDecorator"><code class="docutils literal notranslate"><span class="pre">PyKernelDecorator</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="python_api.html#cudaq.kernel"><code class="docutils literal notranslate"><span class="pre">kernel()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="python_api.html#kernel-execution">Kernel Execution</a><ul>
Expand Down Expand Up @@ -999,14 +1000,14 @@ <h2>Common<a class="headerlink" href="#common" title="Permalink to this heading"
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq14observe_result14observe_resultERdRK7spin_op">
<span class="target" id="classcudaq_1_1observe__result_1a10cbcb530bf05e5863a2afb153c9dca8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">observe_result</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">e</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5cudaq7spin_opE" title="cudaq::spin_op"><span class="n"><span class="pre">spin_op</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">H</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5cudaq14observe_result14observe_resultERdRK7spin_op" title="Permalink to this definition">¶</a><br /></dt>
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq14observe_result14observe_resultEdRK7spin_op">
<span class="target" id="classcudaq_1_1observe__result_1aba859a67c28ee73dee0943043de4b419"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">observe_result</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">e</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5cudaq7spin_opE" title="cudaq::spin_op"><span class="n"><span class="pre">spin_op</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">H</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5cudaq14observe_result14observe_resultEdRK7spin_op" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructor, takes the precomputed expectation value for &lt;psi(x) | H | psi(x)&gt; for the given <a class="reference internal" href="#classcudaq_1_1spin__op"><span class="std std-ref">spin_op</span></a>. </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq14observe_result14observe_resultERdRK7spin_op13sample_result">
<span class="target" id="classcudaq_1_1observe__result_1a5c45da1fa8c9d64c68d2cbe5c9598482"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">observe_result</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">e</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5cudaq7spin_opE" title="cudaq::spin_op"><span class="n"><span class="pre">spin_op</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">H</span></span>, <a class="reference internal" href="#_CPPv4N5cudaq13sample_resultE" title="cudaq::sample_result"><span class="n"><span class="pre">sample_result</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">counts</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5cudaq14observe_result14observe_resultERdRK7spin_op13sample_result" title="Permalink to this definition">¶</a><br /></dt>
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq14observe_result14observe_resultEdRK7spin_op13sample_result">
<span class="target" id="classcudaq_1_1observe__result_1a0f3241a87d3924049763257e7f4caece"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">observe_result</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">e</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5cudaq7spin_opE" title="cudaq::spin_op"><span class="n"><span class="pre">spin_op</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">H</span></span>, <a class="reference internal" href="#_CPPv4N5cudaq13sample_resultE" title="cudaq::sample_result"><span class="n"><span class="pre">sample_result</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">counts</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5cudaq14observe_result14observe_resultEdRK7spin_op13sample_result" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Constructor, takes the precomputed expectation value for &lt;psi(x) | H | psi(x)&gt; for the given <a class="reference internal" href="#classcudaq_1_1spin__op"><span class="std std-ref">spin_op</span></a>. If this execution was shots based, also provide the <a class="reference internal" href="#classcudaq_1_1sample__result"><span class="std std-ref">sample_result</span></a> data containing counts for each term in H. </p>
</dd></dl>

Expand Down Expand Up @@ -2907,7 +2908,14 @@ <h2>Platform<a class="headerlink" href="#platform" title="Permalink to this head
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq22BaseRemoteSimulatorQPUE">
<span class="target" id="classcudaq_1_1BaseRemoteSimulatorQPU"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BaseRemoteSimulatorQPU</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv45cudaq" title="cudaq"><span class="n"><span class="pre">cudaq</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5cudaq3QPUE" title="cudaq::QPU"><span class="n"><span class="pre">QPU</span></span></a><a class="headerlink" href="#_CPPv4N5cudaq22BaseRemoteSimulatorQPUE" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dd><p>Subclassed by <a class="reference internal" href="#classcudaq_1_1BaseNvcfSimulatorQPU"><span class="std std-ref">cudaq::BaseNvcfSimulatorQPU</span></a></p>
</dd></dl>

<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq20BaseNvcfSimulatorQPUE">
<span class="target" id="classcudaq_1_1BaseNvcfSimulatorQPU"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BaseNvcfSimulatorQPU</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv45cudaq" title="cudaq"><span class="n"><span class="pre">cudaq</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5cudaq22BaseRemoteSimulatorQPUE" title="cudaq::BaseRemoteSimulatorQPU"><span class="n"><span class="pre">BaseRemoteSimulatorQPU</span></span></a><a class="headerlink" href="#_CPPv4N5cudaq20BaseNvcfSimulatorQPUE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Implementation of base <a class="reference internal" href="#classcudaq_1_1QPU"><span class="std std-ref">QPU</span></a> subtype that submits simulation request to NVCF. </p>
</dd></dl>

<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N5cudaq16quantum_platformE">
Expand Down
Loading

0 comments on commit c87331a

Please sign in to comment.