Update program input section for getting started guides for sampler a…

…nd estimator (#290) * Improve sampler program input section * Add link to Sampler API reference * Fix Sampler API reference link * improve estimator program input section * Update docs/tutorials/how-to-getting-started-with-estimator.ipynb Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update docs/tutorials/how-to-getting-started-with-estimator.ipynb Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update docs/tutorials/how-to-getting-started-with-sampler.ipynb Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> * Update docs/tutorials/how-to-getting-started-with-sampler.ipynb Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com> Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>
Qiskit · Apr 22, 2022 · 24c588f · 24c588f
1 parent bb227fe
commit 24c588f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 13 deletions.
diff --git a/docs/tutorials/how-to-getting-started-with-estimator.ipynb b/docs/tutorials/how-to-getting-started-with-estimator.ipynb
@@ -31,13 +31,16 @@
     "\n",
     "### Specify program inputs\n",
     "\n",
-    "The Estimator takes in:\n",
-    "\n",
-    "- The **circuits** you want to investigate.\n",
-    "- The **parameters** input to evaluate the circuits.\n",
-    "- The **observables** (Hamiltonians) to be evaluated.\n",
-    "- Optional: The **backend** to run on. If one is not specified, the least busy backend is used.\n",
-    "- Optional: The instruction to **skip_transpilation**.\n",
+    "The Estimator takes in the following arguments:\n",
+    "- **circuits**: a list of (parameterized) circuits that you want to investigate.\n",
+    "- **observables**: a list of observables to measure the expectation values.\n",
+    "- **parameters**: a list of parameters for the parameterized circuits. It should be omitted if the circuits provided are not parameterized.\n",
+    "- **skip_transpilation**: circuit transpilation is skipped if set to `True`. Default value is `False`.\n",
+    "- **service**: the `QiskitRuntimeService` instance to run the program on. If not specified, the default saved account for `QiskitRuntimeService` is initialized.\n",
+    "- **options**: Runtime options dictionary that control the execution environment.\n",
+    "  - **backend**: The backend to run on. This option is required if you are running on [IBM Quantum](https://quantum-computing.ibm.com/). However, if you are running on [IBM Cloud](https://cloud.ibm.com/quantum), you can choose not to specify the backend, in which case the least busy backend is used.\n",
+    "  \n",
+    "You can find more details in [the `Estimator` API reference](https://qiskit.org/documentation/partners/qiskit_ibm_runtime/stubs/qiskit_ibm_runtime.Estimator.html).\n",
     "\n",
     "Example:"
    ]

diff --git a/docs/tutorials/how-to-getting-started-with-sampler.ipynb b/docs/tutorials/how-to-getting-started-with-sampler.ipynb
@@ -28,12 +28,15 @@
     "\n",
     "### Specify program inputs\n",
     "\n",
-    "The Sampler takes in:\n",
-    "\n",
-    "- The **circuits** you want to investigate.\n",
-    "- The **parameters** input to evaluate the circuits.\n",
-    "- Optional: The **backend** to run on. If one is not specified, the least busy backend is used.\n",
-    "- Optional: The instruction to **skip_transpilation**.\n",
+    "The Sampler takes in the following arguments:\n",
+    "- **circuits**: a list of (parameterized) circuits that you want to investigate.\n",
+    "- **parameters**: a list of parameters for the parameterized circuits. It should be omitted if the circuits provided are not parameterized.\n",
+    "- **skip_transpilation**: circuit transpilation is skipped if set to `True`. Default value is `False`.\n",
+    "- **service**: the `QiskitRuntimeService` instance to run the program on. If not specified, the default saved account for `QiskitRuntimeService` is initialized.\n",
+    "- **options**: Runtime options dictionary that control the execution environment.\n",
+    "  - **backend**: The backend to run on. This option is required if you are running on [IBM Quantum](https://quantum-computing.ibm.com/). However, if you are running on [IBM Cloud](https://cloud.ibm.com/quantum), you can choose not to specify the backend, in which case the least busy backend is used.\n",
+    "  \n",
+    "You can find more details in [the `Sampler` API reference](https://qiskit.org/documentation/partners/qiskit_ibm_runtime/stubs/qiskit_ibm_runtime.Sampler.html).\n",
     "\n",
     "Example:"
    ]