deploy: a30bedf

qiskit-community · Aug 17, 2023 · fa0d782 · fa0d782
1 parent 12eef74
commit fa0d782
Show file tree

Hide file tree

Showing 43 changed files with 284 additions and 182 deletions.
diff --git a/.doctrees/apidocs/index.doctree b/.doctrees/apidocs/index.doctree
diff --git a/.doctrees/apidocs/providers.doctree b/.doctrees/apidocs/providers.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/how_tos/1_how_to_run_circuits_on_Braket_devices.doctree b/.doctrees/how_tos/1_how_to_run_circuits_on_Braket_devices.doctree
diff --git a/.doctrees/how_tos/4_how_to_verbatim_circuits.doctree b/.doctrees/how_tos/4_how_to_verbatim_circuits.doctree
diff --git a/.doctrees/how_tos/5_how_to_run_circuits_on_Braket_local_backend.doctree b/.doctrees/how_tos/5_how_to_run_circuits_on_Braket_local_backend.doctree
diff --git a/.doctrees/stubs/qiskit_braket_provider.providers.AWSBraketBackend.doctree b/.doctrees/stubs/qiskit_braket_provider.providers.AWSBraketBackend.doctree
diff --git a/.doctrees/stubs/qiskit_braket_provider.providers.AWSBraketProvider.doctree b/.doctrees/stubs/qiskit_braket_provider.providers.AWSBraketProvider.doctree
diff --git a/.doctrees/stubs/qiskit_braket_provider.providers.AmazonBraketTask.doctree b/.doctrees/stubs/qiskit_braket_provider.providers.AmazonBraketTask.doctree
diff --git a/.doctrees/stubs/qiskit_braket_provider.providers.BraketLocalBackend.doctree b/.doctrees/stubs/qiskit_braket_provider.providers.BraketLocalBackend.doctree
diff --git a/.doctrees/tutorials/0_tutorial_qiskit-braket-provider_overview.doctree b/.doctrees/tutorials/0_tutorial_qiskit-braket-provider_overview.doctree
diff --git a/.doctrees/tutorials/3_tutorial_minimum_eigen_optimizer.doctree b/.doctrees/tutorials/3_tutorial_minimum_eigen_optimizer.doctree
diff --git a/_modules/index.html b/_modules/index.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -9,9 +9,9 @@
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
     <link rel="stylesheet" type="text/css" href="../_static/jupyter-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../_static/thebelab.css" />
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
+    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
-    <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/thebelab-helper.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
@@ -117,7 +117,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2022.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.2</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
     </div>

diff --git a/_modules/qiskit_braket_provider/providers/braket_backend.html b/_modules/qiskit_braket_provider/providers/braket_backend.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../../../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -9,9 +9,9 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=039e1c02" />
     <link rel="stylesheet" type="text/css" href="../../../_static/jupyter-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/thebelab.css" />
-    <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=b3ba4146"></script>
+    <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
-    <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/thebelab-helper.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
@@ -73,10 +73,14 @@ <h1>Source code for qiskit_braket_provider.providers.braket_backend</h1><div cla
         <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;BraketBackend[</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">]&quot;</span>
 
 
-<div class="viewcode-block" id="BraketLocalBackend"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.BraketLocalBackend.html#qiskit_braket_provider.providers.BraketLocalBackend">[docs]</a><span class="k">class</span> <span class="nc">BraketLocalBackend</span><span class="p">(</span><span class="n">BraketBackend</span><span class="p">):</span>
+<div class="viewcode-block" id="BraketLocalBackend">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.BraketLocalBackend.html#qiskit_braket_provider.providers.BraketLocalBackend">[docs]</a>
+<span class="k">class</span> <span class="nc">BraketLocalBackend</span><span class="p">(</span><span class="n">BraketBackend</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;BraketLocalBackend.&quot;&quot;&quot;</span>
 
-<div class="viewcode-block" id="BraketLocalBackend.__init__"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.BraketLocalBackend.html#qiskit_braket_provider.providers.BraketLocalBackend.__init__">[docs]</a>    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">fields</span><span class="p">):</span>
+<div class="viewcode-block" id="BraketLocalBackend.__init__">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.BraketLocalBackend.html#qiskit_braket_provider.providers.BraketLocalBackend.__init__">[docs]</a>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">fields</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;AWSBraketLocalBackend for local execution of circuits.</span>
 
 <span class="sd">        Example:</span>
@@ -96,6 +100,7 @@ <h1>Source code for qiskit_braket_provider.providers.braket_backend</h1><div cla
         <span class="bp">self</span><span class="o">.</span><span class="n">_target</span> <span class="o">=</span> <span class="n">local_simulator_to_target</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_aws_device</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_aws_device</span><span class="o">.</span><span class="n">status</span></div>
 
+
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">target</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span>
@@ -172,10 +177,15 @@ <h1>Source code for qiskit_braket_provider.providers.braket_backend</h1><div cla
         <span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="AWSBraketBackend"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AWSBraketBackend.html#qiskit_braket_provider.providers.AWSBraketBackend">[docs]</a><span class="k">class</span> <span class="nc">AWSBraketBackend</span><span class="p">(</span><span class="n">BraketBackend</span><span class="p">):</span>
+
+<div class="viewcode-block" id="AWSBraketBackend">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AWSBraketBackend.html#qiskit_braket_provider.providers.AWSBraketBackend">[docs]</a>
+<span class="k">class</span> <span class="nc">AWSBraketBackend</span><span class="p">(</span><span class="n">BraketBackend</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;AWSBraketBackend.&quot;&quot;&quot;</span>
 
-<div class="viewcode-block" id="AWSBraketBackend.__init__"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AWSBraketBackend.html#qiskit_braket_provider.providers.AWSBraketBackend.__init__">[docs]</a>    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>  <span class="c1"># pylint: disable=too-many-arguments</span>
+<div class="viewcode-block" id="AWSBraketBackend.__init__">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AWSBraketBackend.html#qiskit_braket_provider.providers.AWSBraketBackend.__init__">[docs]</a>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>  <span class="c1"># pylint: disable=too-many-arguments</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">device</span><span class="p">:</span> <span class="n">AwsDevice</span><span class="p">,</span>
         <span class="n">provider</span><span class="p">:</span> <span class="n">Provider</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -216,6 +226,7 @@ <h1>Source code for qiskit_braket_provider.providers.braket_backend</h1><div cla
         <span class="bp">self</span><span class="o">.</span><span class="n">_device</span> <span class="o">=</span> <span class="n">device</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_target</span> <span class="o">=</span> <span class="n">aws_device_to_target</span><span class="p">(</span><span class="n">device</span><span class="o">=</span><span class="n">device</span><span class="p">)</span></div>
 
+
     <span class="k">def</span> <span class="nf">retrieve_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AmazonBraketTask</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return a single job submitted to AWS backend.</span>
 
@@ -295,6 +306,7 @@ <h1>Source code for qiskit_braket_provider.providers.braket_backend</h1><div cla
         <span class="k">return</span> <span class="n">AmazonBraketTask</span><span class="p">(</span>
             <span class="n">task_id</span><span class="o">=</span><span class="n">task_id</span><span class="p">,</span> <span class="n">tasks</span><span class="o">=</span><span class="n">tasks</span><span class="p">,</span> <span class="n">backend</span><span class="o">=</span><span class="bp">self</span><span class="p">,</span> <span class="n">shots</span><span class="o">=</span><span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;shots&quot;</span><span class="p">)</span>
         <span class="p">)</span></div>
+
 </pre></div>
 
           </div>
@@ -376,7 +388,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2022.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.2</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
     </div>

diff --git a/_modules/qiskit_braket_provider/providers/braket_job.html b/_modules/qiskit_braket_provider/providers/braket_job.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../../../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -9,9 +9,9 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=039e1c02" />
     <link rel="stylesheet" type="text/css" href="../../../_static/jupyter-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/thebelab.css" />
-    <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=b3ba4146"></script>
+    <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
-    <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/thebelab-helper.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
@@ -115,10 +115,14 @@ <h1>Source code for qiskit_braket_provider.providers.braket_job</h1><div class="
     <span class="k">return</span> <span class="n">experiment_results</span>
 
 
-<div class="viewcode-block" id="AmazonBraketTask"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AmazonBraketTask.html#qiskit_braket_provider.providers.AmazonBraketTask">[docs]</a><span class="k">class</span> <span class="nc">AmazonBraketTask</span><span class="p">(</span><span class="n">JobV1</span><span class="p">):</span>
+<div class="viewcode-block" id="AmazonBraketTask">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AmazonBraketTask.html#qiskit_braket_provider.providers.AmazonBraketTask">[docs]</a>
+<span class="k">class</span> <span class="nc">AmazonBraketTask</span><span class="p">(</span><span class="n">JobV1</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;AmazonBraketTask.&quot;&quot;&quot;</span>
 
-<div class="viewcode-block" id="AmazonBraketTask.__init__"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AmazonBraketTask.html#qiskit_braket_provider.providers.AmazonBraketTask.__init__">[docs]</a>    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
+<div class="viewcode-block" id="AmazonBraketTask.__init__">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AmazonBraketTask.html#qiskit_braket_provider.providers.AmazonBraketTask.__init__">[docs]</a>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">task_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
         <span class="n">backend</span><span class="p">:</span> <span class="n">BackendV2</span><span class="p">,</span>
@@ -140,6 +144,7 @@ <h1>Source code for qiskit_braket_provider.providers.braket_job</h1><div class="
         <span class="bp">self</span><span class="o">.</span><span class="n">_tasks</span> <span class="o">=</span> <span class="n">tasks</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_date_of_creation</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>
 
+
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">shots</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return the number of shots.</span>
@@ -193,6 +198,7 @@ <h1>Source code for qiskit_braket_provider.providers.braket_job</h1><div class="
         <span class="k">return</span> <span class="n">status</span></div>
 
 
+
 <span class="k">class</span> <span class="nc">AWSBraketJob</span><span class="p">(</span><span class="n">AmazonBraketTask</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;AWSBraketJob.&quot;&quot;&quot;</span>
 
@@ -301,7 +307,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2022.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.2</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
     </div>

diff --git a/_modules/qiskit_braket_provider/providers/braket_provider.html b/_modules/qiskit_braket_provider/providers/braket_provider.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../../../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
@@ -9,9 +9,9 @@
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=039e1c02" />
     <link rel="stylesheet" type="text/css" href="../../../_static/jupyter-sphinx.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/thebelab.css" />
-    <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=b3ba4146"></script>
+    <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
-    <script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/thebelab-helper.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
@@ -46,7 +46,9 @@ <h1>Source code for qiskit_braket_provider.providers.braket_provider</h1><div cl
 <span class="kn">from</span> <span class="nn">.braket_backend</span> <span class="kn">import</span> <span class="n">AWSBraketBackend</span><span class="p">,</span> <span class="n">BraketLocalBackend</span>
 
 
-<div class="viewcode-block" id="AWSBraketProvider"><a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AWSBraketProvider.html#qiskit_braket_provider.providers.AWSBraketProvider">[docs]</a><span class="k">class</span> <span class="nc">AWSBraketProvider</span><span class="p">(</span><span class="n">ProviderV1</span><span class="p">):</span>
+<div class="viewcode-block" id="AWSBraketProvider">
+<a class="viewcode-back" href="../../../stubs/qiskit_braket_provider.providers.AWSBraketProvider.html#qiskit_braket_provider.providers.AWSBraketProvider">[docs]</a>
+<span class="k">class</span> <span class="nc">AWSBraketProvider</span><span class="p">(</span><span class="n">ProviderV1</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;AWSBraketProvider class for accessing AWS Braket backends.</span>
 
 <span class="sd">    Example:</span>
@@ -97,6 +99,7 @@ <h1>Source code for qiskit_braket_provider.providers.braket_provider</h1><div cl
                 <span class="p">)</span>
             <span class="p">)</span>
         <span class="k">return</span> <span class="n">backends</span></div>
+
 </pre></div>
 
           </div>
@@ -178,7 +181,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2022.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.2</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
     </div>

diff --git a/_static/basic.css b/_static/basic.css
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
     VERSION: '',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,