Merge pull request #4 from qiqb-osaka/feature-apikey

Change "API Token" and use_transpiler -> transpiler

docs_html/quri_parts/riqu/quri_parts.riqu.backend.html

@@ -292,7 +292,7 @@
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingBackend.sample">
-<span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">circuit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">quri_parts.circuit.circuit.NonParametricQuantumCircuit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_shots</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_transpiler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remark</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">quri_parts.backend.SamplingJob</span></span></span><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingBackend.sample" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">circuit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">quri_parts.circuit.circuit.NonParametricQuantumCircuit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_shots</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transpiler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'normal'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remark</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">quri_parts.backend.SamplingJob</span></span></span><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingBackend.sample" title="Permalink to this definition">#</a></dt>
 <dd><p>Perform a sampling measurement of a circuit.</p>
 <p>The circuit is transpiled on riqu server.
 The QURI Parts transpiling feature is not supported.
@@ -302,7 +302,7 @@
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>circuit</strong> – The circuit to be sampled.</p></li>
 <li><p><strong>n_shots</strong> – Number of repetitions of each circuit, for sampling.</p></li>
-<li><p><strong>use_transpiler</strong> – Whether to use transpilers on riqu server.</p></li>
+<li><p><strong>transpiler</strong> – The transpiler setting.</p></li>
 <li><p><strong>remark</strong> – The remark to be assigned to the job.</p></li>
 </ul>
 </dd>
@@ -320,7 +320,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingBackend.sample_qasm">
-<span class="sig-name descname"><span class="pre">sample_qasm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qasm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_shots</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_transpiler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remark</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">quri_parts.backend.SamplingJob</span></span></span><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingBackend.sample_qasm" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">sample_qasm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">qasm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_shots</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transpiler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'normal'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remark</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">quri_parts.backend.SamplingJob</span></span></span><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingBackend.sample_qasm" title="Permalink to this definition">#</a></dt>
 <dd><p>Perform a sampling measurement of a OpenQASM 3.0 program.</p>
 <p>The OpenQASM 3.0 program is transpiled on riqu server.
 The QURI Parts transpiling feature is not supported.</p>
@@ -329,7 +329,7 @@
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>qasm</strong> – The OpenQASM 3.0 program to be sampled.</p></li>
 <li><p><strong>n_shots</strong> – Number of repetitions of each circuit, for sampling.</p></li>
-<li><p><strong>use_transpiler</strong> – Whether to use transpilers on riqu server.</p></li>
+<li><p><strong>transpiler</strong> – The transpiler setting.</p></li>
 <li><p><strong>remark</strong> – The remark to be assigned to the job.</p></li>
 </ul>
 </dd>
@@ -400,9 +400,9 @@
 </dd></dl>
 
 <dl class="py property">
-<dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingJob.use_transpiler">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">use_transpiler</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingJob.use_transpiler" title="Permalink to this definition">#</a></dt>
-<dd><p>Whether to transpile on riqu server.</p>
+<dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingJob.transpiler">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transpiler</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingJob.transpiler" title="Permalink to this definition">#</a></dt>
+<dd><p>The transpiler setting.</p>
 </dd></dl>
 
 <dl class="py property">
@@ -423,6 +423,18 @@
 <dd><p><code class="docutils literal notranslate"><span class="pre">datetime</span></code> when riqu server received the new job.</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingJob.in_queue">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">in_queue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime.datetime</span></em><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingJob.in_queue" title="Permalink to this definition">#</a></dt>
+<dd><p><code class="docutils literal notranslate"><span class="pre">datetime</span></code> when the job is in queue.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingJob.out_queue">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">out_queue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime.datetime</span></em><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingJob.out_queue" title="Permalink to this definition">#</a></dt>
+<dd><p><code class="docutils literal notranslate"><span class="pre">datetime</span></code> when the job is out queue.</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="quri_parts.riqu.backend.RiquSamplingJob.ended">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ended</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime.datetime</span></em><a class="headerlink" href="#quri_parts.riqu.backend.RiquSamplingJob.ended" title="Permalink to this definition">#</a></dt>