Skip to content

Commit a073fcf

Browse files
cuda-quantum-botcuda-quantum-bot
committed
Docs preview for PR #2660.
1 parent 2221184 commit a073fcf

File tree

11 files changed

+366
-21
lines changed

11 files changed

+366
-21
lines changed

‎pr-2660/_sources/api/languages/cpp_api.rst.txt

+27
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,33 @@ Noise Modeling
131131
.. doxygenclass:: cudaq::depolarization_channel
132132
:members:
133133

134+
.. doxygenclass:: cudaq::x_error
135+
:members:
136+
137+
.. doxygenclass:: cudaq::y_error
138+
:members:
139+
140+
.. doxygenclass:: cudaq::z_error
141+
:members:
142+
143+
.. doxygenclass:: cudaq::amplitude_damping
144+
:members:
145+
146+
.. doxygenclass:: cudaq::phase_damping
147+
:members:
148+
149+
.. doxygenclass:: cudaq::pauli1
150+
:members:
151+
152+
.. doxygenclass:: cudaq::pauli2
153+
:members:
154+
155+
.. doxygenclass:: cudaq::depolarization1
156+
:members:
157+
158+
.. doxygenclass:: cudaq::depolarization2
159+
:members:
160+
134161
.. doxygenclass:: cudaq::noise_model
135162
:members:
136163

‎pr-2660/_sources/api/languages/python_api.rst.txt

+16
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,22 @@ Noisy Simulation
237237
:members:
238238
:special-members: __init__
239239

240+
.. autoclass:: cudaq::PhaseDamping
241+
242+
.. autoclass:: cudaq::XError
243+
244+
.. autoclass:: cudaq::YError
245+
246+
.. autoclass:: cudaq::ZError
247+
248+
.. autoclass:: cudaq::Pauli1
249+
250+
.. autoclass:: cudaq::Pauli2
251+
252+
.. autoclass:: cudaq::Depolarization1
253+
254+
.. autoclass:: cudaq::Depolarization2
255+
240256
.. autoclass:: cudaq::KrausChannel
241257
:members:
242258
:special-members: __getitem__

‎pr-2660/api/languages/cpp_api.html

+101-1
Large diffs are not rendered by default.

‎pr-2660/api/languages/python_api.html

+107-9
Large diffs are not rendered by default.

‎pr-2660/applications/python/deutschs_algorithm.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,7 @@ <h2>XOR <span class="math notranslate nohighlight">\(\oplus\)</span><a class="he
816816
</section>
817817
<section id="Quantum-oracles">
818818
<h2>Quantum oracles<a class="headerlink" href="#Quantum-oracles" title="Permalink to this heading"></a></h2>
819-
<p><img alt="cd459d1f95934fdea70a8623142b1b46" class="no-scaled-link" src="../../_images/oracle.png" style="width: 300px; height: 150px;" /></p>
819+
<p><img alt="f8ab6c8ba92b417484801e404c49d34b" class="no-scaled-link" src="../../_images/oracle.png" style="width: 300px; height: 150px;" /></p>
820820
<p>Suppose we have <span class="math notranslate nohighlight">\(f(x): \{0,1\} \longrightarrow \{0,1\}\)</span>. We can compute this function on a quantum computer using oracles which we treat as black box functions that yield the output with an appropriate sequence of logical gates.</p>
821821
<p>Above you see an oracle represented as <span class="math notranslate nohighlight">\(U_f\)</span> which allows us to transform the state <span class="math notranslate nohighlight">\(\ket{x}\ket{y}\)</span> into:</p>
822822
<div class="math notranslate nohighlight">
@@ -864,7 +864,7 @@ <h2>Quantum parallelism<a class="headerlink" href="#Quantum-parallelism" title="
864864
<h2>Deutsch’s Algorithm:<a class="headerlink" href="#Deutsch's-Algorithm:" title="Permalink to this heading"></a></h2>
865865
<p>Our aim is to find out if <span class="math notranslate nohighlight">\(f: \{0,1\} \longrightarrow \{0,1\}\)</span> is a constant or a balanced function? If constant, <span class="math notranslate nohighlight">\(f(0) = f(1)\)</span>, and if balanced, <span class="math notranslate nohighlight">\(f(0) \neq f(1)\)</span>.</p>
866866
<p>We step through the circuit diagram below and follow the math after the application of each gate.</p>
867-
<p><img alt="1399566aaf23404e84b6657cedc13fa3" class="no-scaled-link" src="../../_images/deutsch.png" style="width: 500px; height: 210px;" /></p>
867+
<p><img alt="8cf391ec16714d96ae05c6cbc05f7116" class="no-scaled-link" src="../../_images/deutsch.png" style="width: 500px; height: 210px;" /></p>
868868
<div class="math notranslate nohighlight">
869869
\[\ket{\psi_0} = \ket{01}
870870
\tag{1}\]</div>

‎pr-2660/examples/python/performance_optimizations.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -744,9 +744,9 @@ <h1>Optimizing Performance<a class="headerlink" href="#Optimizing-Performance" t
744744
<section id="Gate-Fusion">
745745
<h2>Gate Fusion<a class="headerlink" href="#Gate-Fusion" title="Permalink to this heading"></a></h2>
746746
<p>Gate fusion is an optimization technique where consecutive gates are combined into a single gate operation to improve the efficiency of the simulation (See figure below). By targeting the <code class="docutils literal notranslate"><span class="pre">nvidia-mgpu</span></code> backend and setting the <code class="docutils literal notranslate"><span class="pre">CUDAQ_MGPU_FUSE</span></code> environment variable, you can select the degree of fusion that takes place. A full command line example would look like <code class="docutils literal notranslate"><span class="pre">CUDAQ_MGPU_FUSE=4</span> <span class="pre">python</span> <span class="pre">c2h2VQE.py</span> <span class="pre">--target</span> <span class="pre">nvidia</span> <span class="pre">--target-option</span> <span class="pre">fp64,mgpu</span></code></p>
747-
<p><img alt="e1669ee09c184782b012d8cb72e7782d" src="../../_images/gate-fuse.png" /></p>
747+
<p><img alt="ab2c18f6e0d5452f864220a45ebebf1c" src="../../_images/gate-fuse.png" /></p>
748748
<p>The importance of gate fusion is system dependent, but can have a large influence on the performance of the simulation. See the example below for a 24 qubit VQE experiment where changing the fusion level resulted in significant performance boosts.</p>
749-
<p><img alt="780fa1179ff7454abb9771bd0da1d7e2" src="../../_images/gatefusion.png" /></p>
749+
<p><img alt="0bd04e5a90d745219e8250d68e981ed6" src="../../_images/gatefusion.png" /></p>
750750
</section>
751751
</section>
752752

‎pr-2660/genindex.html

+67-6
Original file line numberDiff line numberDiff line change
@@ -754,6 +754,9 @@ <h1 id="index">Index</h1>
754754
| <a href="#T"><strong>T</strong></a>
755755
| <a href="#U"><strong>U</strong></a>
756756
| <a href="#V"><strong>V</strong></a>
757+
| <a href="#X"><strong>X</strong></a>
758+
| <a href="#Y"><strong>Y</strong></a>
759+
| <a href="#Z"><strong>Z</strong></a>
757760

758761
</div>
759762
<h2 id="_">_</h2>
@@ -897,6 +900,8 @@ <h2 id="C">C</h2>
897900
</li>
898901
</ul></li>
899902
<li><a href="api/languages/cpp_api.html#_CPPv45cudaq">cudaq (C++ type)</a>
903+
</li>
904+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq17amplitude_dampingE">cudaq::amplitude_damping (C++ class)</a>
900905
</li>
901906
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq25amplitude_damping_channelE">cudaq::amplitude_damping_channel (C++ class)</a>
902907
</li>
@@ -943,6 +948,12 @@ <h2 id="C">C</h2>
943948
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq14complex_matrix10value_typeE">cudaq::complex_matrix::value_type (C++ type)</a>
944949
</li>
945950
<li><a href="api/languages/cpp_api.html#_CPPv4I0EN5cudaq9CusvStateE">cudaq::CusvState (C++ class)</a>
951+
</li>
952+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq15depolarization1E">cudaq::depolarization1 (C++ class)</a>
953+
</li>
954+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq15depolarization2E">cudaq::depolarization2 (C++ class)</a>
955+
</li>
956+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq15depolarization215depolarization2EK4real">cudaq::depolarization2::depolarization2 (C++ function)</a>
946957
</li>
947958
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq22depolarization_channelE">cudaq::depolarization_channel (C++ class)</a>
948959
</li>
@@ -1247,6 +1258,16 @@ <h2 id="C">C</h2>
12471258
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq4orca12sample_asyncERNSt6vectorINSt6size_tEEERNSt6vectorINSt6size_tEEERNSt6vectorIdEERNSt6vectorIdEEiNSt6size_tE">cudaq::orca::sample_async (C++ function)</a>, <a href="api/languages/cpp_api.html#_CPPv4N5cudaq4orca12sample_asyncERNSt6vectorINSt6size_tEEERNSt6vectorINSt6size_tEEERNSt6vectorIdEEiNSt6size_tE">[1]</a>
12481259
</li>
12491260
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq17OrcaRemoteRESTQPUE">cudaq::OrcaRemoteRESTQPU (C++ class)</a>
1261+
</li>
1262+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq6pauli1E">cudaq::pauli1 (C++ class)</a>
1263+
</li>
1264+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq6pauli16pauli1ERKNSt6vectorIN5cudaq4realEEE">cudaq::pauli1::pauli1 (C++ function)</a>
1265+
</li>
1266+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq6pauli2E">cudaq::pauli2 (C++ class)</a>
1267+
</li>
1268+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq6pauli26pauli2ERKNSt6vectorIN5cudaq4realEEE">cudaq::pauli2::pauli2 (C++ function)</a>
1269+
</li>
1270+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq13phase_dampingE">cudaq::phase_damping (C++ class)</a>
12501271
</li>
12511272
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq18phase_flip_channelE">cudaq::phase_flip_channel (C++ class)</a>
12521273
</li>
@@ -1256,14 +1277,14 @@ <h2 id="C">C</h2>
12561277
</li>
12571278
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPU15getConnectivityEv">cudaq::QPU::getConnectivity (C++ function)</a>
12581279
</li>
1280+
</ul></td>
1281+
<td style="width: 33%; vertical-align: top;"><ul>
12591282
<li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq3QPU20getExecutionThreadIdEv">cudaq::QPU::getExecutionThreadId (C++ function)</a>
12601283
</li>
12611284
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPU12getNumQubitsEv">cudaq::QPU::getNumQubits (C++ function)</a>
12621285
</li>
12631286
<li><a href="api/languages/cpp_api.html#_CPPv4NK5cudaq3QPU21getRemoteCapabilitiesEv">cudaq::QPU::getRemoteCapabilities (C++ function)</a>
12641287
</li>
1265-
</ul></td>
1266-
<td style="width: 33%; vertical-align: top;"><ul>
12671288
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPU10isEmulatedEv">cudaq::QPU::isEmulated (C++ function)</a>
12681289
</li>
12691290
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq3QPU11isSimulatorEv">cudaq::QPU::isSimulator (C++ function)</a>
@@ -1653,6 +1674,12 @@ <h2 id="C">C</h2>
16531674
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq5TraceE">cudaq::Trace (C++ class)</a>
16541675
</li>
16551676
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq11unset_noiseEv">cudaq::unset_noise (C++ function)</a>
1677+
</li>
1678+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq7x_errorE">cudaq::x_error (C++ class)</a>
1679+
</li>
1680+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq7y_errorE">cudaq::y_error (C++ class)</a>
1681+
</li>
1682+
<li><a href="api/languages/cpp_api.html#_CPPv4N5cudaq7z_errorE">cudaq::z_error (C++ class)</a>
16561683
</li>
16571684
<li><a href="api/languages/python_api.html#cudaq.operator.cudm_state.CuDensityMatState">CuDensityMatState (class in cudaq.operator.cudm_state)</a>
16581685
</li>
@@ -1663,15 +1690,19 @@ <h2 id="D">D</h2>
16631690
<table style="width: 100%" class="indextable genindextable"><tr>
16641691
<td style="width: 33%; vertical-align: top;"><ul>
16651692
<li><a href="api/languages/python_api.html#cudaq.operator.expressions.ElementaryOperator.define">define() (cudaq.operator.expressions.ElementaryOperator class method)</a>
1693+
</li>
1694+
<li><a href="api/languages/python_api.html#cudaq.Depolarization1">Depolarization1 (class in cudaq)</a>
1695+
</li>
1696+
<li><a href="api/languages/python_api.html#cudaq.Depolarization2">Depolarization2 (class in cudaq)</a>
16661697
</li>
16671698
<li><a href="api/languages/python_api.html#cudaq.DepolarizationChannel">DepolarizationChannel (class in cudaq)</a>
16681699
</li>
16691700
<li><a href="api/languages/python_api.html#cudaq.Target.description">description (cudaq.Target property)</a>
1670-
</li>
1671-
<li><a href="api/languages/python_api.html#cudaq.SampleResult.deserialize">deserialize() (cudaq.SampleResult method)</a>
16721701
</li>
16731702
</ul></td>
16741703
<td style="width: 33%; vertical-align: top;"><ul>
1704+
<li><a href="api/languages/python_api.html#cudaq.SampleResult.deserialize">deserialize() (cudaq.SampleResult method)</a>
1705+
</li>
16751706
<li><a href="api/languages/python_api.html#cudaq.draw">draw() (in module cudaq)</a>
16761707
</li>
16771708
<li><a href="api/languages/python_api.html#cudaq.ObserveResult.dump">dump() (cudaq.ObserveResult method)</a>
@@ -1983,12 +2014,18 @@ <h2 id="P">P</h2>
19832014
<td style="width: 33%; vertical-align: top;"><ul>
19842015
<li><a href="api/languages/python_api.html#cudaq.gradients.ParameterShift">ParameterShift (class in cudaq.gradients)</a>
19852016
</li>
1986-
<li><a href="api/languages/python_api.html#cudaq.PhaseFlipChannel">PhaseFlipChannel (class in cudaq)</a>
2017+
<li><a href="api/languages/python_api.html#cudaq.Pauli1">Pauli1 (class in cudaq)</a>
19872018
</li>
1988-
<li><a href="api/languages/python_api.html#cudaq.Target.platform">platform (cudaq.Target property)</a>
2019+
<li><a href="api/languages/python_api.html#cudaq.Pauli2">Pauli2 (class in cudaq)</a>
2020+
</li>
2021+
<li><a href="api/languages/python_api.html#cudaq.PhaseDamping">PhaseDamping (class in cudaq)</a>
2022+
</li>
2023+
<li><a href="api/languages/python_api.html#cudaq.PhaseFlipChannel">PhaseFlipChannel (class in cudaq)</a>
19892024
</li>
19902025
</ul></td>
19912026
<td style="width: 33%; vertical-align: top;"><ul>
2027+
<li><a href="api/languages/python_api.html#cudaq.Target.platform">platform (cudaq.Target property)</a>
2028+
</li>
19922029
<li><a href="api/languages/python_api.html#cudaq.SampleResult.probability">probability() (cudaq.SampleResult method)</a>
19932030
</li>
19942031
<li><a href="api/languages/python_api.html#cudaq.operator.expressions.ProductOperator">ProductOperator (class in cudaq.operator.expressions)</a>
@@ -2168,6 +2205,30 @@ <h2 id="V">V</h2>
21682205
</ul></td>
21692206
</tr></table>
21702207

2208+
<h2 id="X">X</h2>
2209+
<table style="width: 100%" class="indextable genindextable"><tr>
2210+
<td style="width: 33%; vertical-align: top;"><ul>
2211+
<li><a href="api/languages/python_api.html#cudaq.XError">XError (class in cudaq)</a>
2212+
</li>
2213+
</ul></td>
2214+
</tr></table>
2215+
2216+
<h2 id="Y">Y</h2>
2217+
<table style="width: 100%" class="indextable genindextable"><tr>
2218+
<td style="width: 33%; vertical-align: top;"><ul>
2219+
<li><a href="api/languages/python_api.html#cudaq.YError">YError (class in cudaq)</a>
2220+
</li>
2221+
</ul></td>
2222+
</tr></table>
2223+
2224+
<h2 id="Z">Z</h2>
2225+
<table style="width: 100%" class="indextable genindextable"><tr>
2226+
<td style="width: 33%; vertical-align: top;"><ul>
2227+
<li><a href="api/languages/python_api.html#cudaq.ZError">ZError (class in cudaq)</a>
2228+
</li>
2229+
</ul></td>
2230+
</tr></table>
2231+
21712232

21722233

21732234
</div>

‎pr-2660/objects.inv

695 Bytes
Binary file not shown.

‎pr-2660/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pr-2660/sphinx/api/languages/cpp_api.rst

+27
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,33 @@ Noise Modeling
131131
.. doxygenclass:: cudaq::depolarization_channel
132132
:members:
133133

134+
.. doxygenclass:: cudaq::x_error
135+
:members:
136+
137+
.. doxygenclass:: cudaq::y_error
138+
:members:
139+
140+
.. doxygenclass:: cudaq::z_error
141+
:members:
142+
143+
.. doxygenclass:: cudaq::amplitude_damping
144+
:members:
145+
146+
.. doxygenclass:: cudaq::phase_damping
147+
:members:
148+
149+
.. doxygenclass:: cudaq::pauli1
150+
:members:
151+
152+
.. doxygenclass:: cudaq::pauli2
153+
:members:
154+
155+
.. doxygenclass:: cudaq::depolarization1
156+
:members:
157+
158+
.. doxygenclass:: cudaq::depolarization2
159+
:members:
160+
134161
.. doxygenclass:: cudaq::noise_model
135162
:members:
136163

‎pr-2660/sphinx/api/languages/python_api.rst

+16
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,22 @@ Noisy Simulation
237237
:members:
238238
:special-members: __init__
239239

240+
.. autoclass:: cudaq::PhaseDamping
241+
242+
.. autoclass:: cudaq::XError
243+
244+
.. autoclass:: cudaq::YError
245+
246+
.. autoclass:: cudaq::ZError
247+
248+
.. autoclass:: cudaq::Pauli1
249+
250+
.. autoclass:: cudaq::Pauli2
251+
252+
.. autoclass:: cudaq::Depolarization1
253+
254+
.. autoclass:: cudaq::Depolarization2
255+
240256
.. autoclass:: cudaq::KrausChannel
241257
:members:
242258
:special-members: __getitem__

0 commit comments

Comments
 (0)