Skip to content

Commit

Permalink
deploy: 330ec7d
Browse files Browse the repository at this point in the history
  • Loading branch information
yitchen-tim committed Jul 2, 2024
1 parent f508b2e commit 853c6df
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0539b712ce279f295b482fffc9bd8254
config: 4c16fa173344b1def39bcaa18808c29a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
33 changes: 31 additions & 2 deletions _modules/qiskit_braket_provider/providers/braket_provider.html
Original file line number Diff line number Diff line change
Expand Up @@ -246,12 +246,12 @@ <h1>Source code for qiskit_braket_provider.providers.braket_provider</h1><div cl
<span class="kn">from</span> <span class="nn">braket.device_schema.dwave</span> <span class="kn">import</span> <span class="n">DwaveDeviceCapabilities</span>
<span class="kn">from</span> <span class="nn">braket.device_schema.quera</span> <span class="kn">import</span> <span class="n">QueraDeviceCapabilities</span>
<span class="kn">from</span> <span class="nn">braket.device_schema.xanadu</span> <span class="kn">import</span> <span class="n">XanaduDeviceCapabilities</span>
<span class="kn">from</span> <span class="nn">qiskit.providers</span> <span class="kn">import</span> <span class="n">ProviderV1</span>
<span class="kn">from</span> <span class="nn">qiskit.providers.exceptions</span> <span class="kn">import</span> <span class="n">QiskitBackendNotFoundError</span>

<span class="kn">from</span> <span class="nn">.braket_backend</span> <span class="kn">import</span> <span class="n">BraketAwsBackend</span><span class="p">,</span> <span class="n">BraketLocalBackend</span>


<span class="k">class</span> <span class="nc">BraketProvider</span><span class="p">(</span><span class="n">ProviderV1</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">BraketProvider</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;BraketProvider class for accessing Amazon Braket backends.</span>

<span class="sd"> Example:</span>
Expand All @@ -269,7 +269,36 @@ <h1>Source code for qiskit_braket_provider.providers.braket_provider</h1><div cl
<span class="sd"> BraketBackend[dm1]]</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">get_backend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return a single backend matching the specififed filters.</span>

<span class="sd"> Args:</span>
<span class="sd"> name (str): name of the selected backend</span>
<span class="sd"> **kwargs: dict with additional options for filitering and storing aws session</span>
<span class="sd"> Returns:</span>
<span class="sd"> BraketAwsBackend: a backend matching the filters.</span>
<span class="sd"> Raises:</span>
<span class="sd"> QiskitBackendNotFoundError: if no backend could be found or</span>
<span class="sd"> more than one backend matches the filters.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">backends</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">backends</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">backends</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">QiskitBackendNotFoundError</span><span class="p">(</span>
<span class="s2">&quot;More than one backend matches the criteria&quot;</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">backends</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">QiskitBackendNotFoundError</span><span class="p">(</span><span class="s2">&quot;No backend matches the criteria&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">backends</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

<span class="k">def</span> <span class="nf">backends</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Return a list of backends matching the specififed filters.</span>

<span class="sd"> Args:</span>
<span class="sd"> name (str): name of the selected backend</span>
<span class="sd"> **kwargs: dict with additional options for filitering and storing aws session</span>
<span class="sd"> Returns:</span>
<span class="sd"> BraketAwsBackend: a list of backends matching the filters.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;local&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[</span>
<span class="n">BraketLocalBackend</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;braket_sv&quot;</span><span class="p">),</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,4 @@



.. rubric:: Attributes

.. autosummary::

~AWSBraketProvider.version


2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

14 changes: 2 additions & 12 deletions stubs/qiskit_braket_provider.providers.AWSBraketProvider.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,20 +259,10 @@ <h1>qiskit_braket_provider.providers.AWSBraketProvider<a class="headerlink" href
<td><p>This throws a deprecation warning on initialization.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">backends</span></code>([name])</p></td>
<td><p>Return a list of backends matching the specified filtering.</p></td>
<td><p>Return a list of backends matching the specififed filters.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_backend</span></code>([name])</p></td>
<td><p>Return a single backend matching the specified filtering.</p></td>
</tr>
</tbody>
</table>
</div>
<p class="rubric">Attributes</p>
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">version</span></code></p></td>
<td><p></p></td>
<td><p>Return a single backend matching the specififed filters.</p></td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 853c6df

Please sign in to comment.