Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework tutorials to use the new workflow #404

Merged
merged 11 commits into from
Sep 12, 2023
Merged

Rework tutorials to use the new workflow #404

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6b62f45
Rework tutorials to use the new workflow
caleb-johnson Sep 5, 2023
1f5fb23
Merge branch 'main' of github.com:Qiskit-Extensions/circuit-knitting-…
caleb-johnson Sep 8, 2023
2691899
Update observable note
caleb-johnson Sep 8, 2023
0bdde15
black
caleb-johnson Sep 8, 2023
d0a9721
Update tutorials
caleb-johnson Sep 10, 2023
737fe61
ruff
caleb-johnson Sep 10, 2023
0921c9d
Peer review
caleb-johnson Sep 11, 2023
12d4763
clean up logic
caleb-johnson Sep 11, 2023
a7bba02
Fix runtime options code
caleb-johnson Sep 11, 2023
51b7271
Commented block readability
caleb-johnson Sep 12, 2023
c94403b
black
caleb-johnson Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 105 additions & 59 deletions docs/circuit_cutting/tutorials/01_gate_cutting_to_reduce_circuit_width.ipynb
View file
Open in desktop
caleb-johnson marked this conversation as resolved.
Show resolved Hide resolved
garrison marked this conversation as resolved.
Show resolved Hide resolved
caleb-johnson marked this conversation as resolved.
Show resolved Hide resolved
caleb-johnson marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"Like any circuit knitting technique, gate cutting can be described as three consecutive steps:\n",
"\n",
"- **cut** some non-local gates in the circuit and possibly separate the circuit into subcircuits\n",
"- **execute** many sampled subexperiments on the backend(s)\n",
"- **execute** many sampled subexperiments using the Qiskit Sampler primitive\n",
"- **reconstruct** the expectation value of the full-sized circuit"
]
},
Expand All @@ -25,14 +25,7 @@
"source": [
"import numpy as np\n",
"from qiskit.circuit.library import EfficientSU2\n",
"from qiskit.quantum_info import PauliList\n",
"from qiskit_aer.primitives import Estimator, Sampler\n",
"\n",
"from circuit_knitting.cutting import (\n",
" partition_problem,\n",
" execute_experiments,\n",
" reconstruct_expectation_values,\n",
")"
"from qiskit.quantum_info import PauliList"
]
},
{
Expand Down Expand Up @@ -75,7 +68,7 @@
"source": [
"### Specify some observables\n",
"\n",
"Currently, only `Pauli` observables with phase equal to 1 are supported. Full support for `SparsePauliOp` is expected in CKT v0.4.0."
"Currently, only `Pauli` observables with phase equal to 1 are supported. Full support for `SparsePauliOp` is expected in CKT v0.5.0."
]
},
{
Expand Down Expand Up @@ -105,6 +98,8 @@
"metadata": {},
"outputs": [],
"source": [
"from circuit_knitting.cutting import partition_problem\n",
"\n",
"partitioned_problem = partition_problem(\n",
" circuit=circuit, partition_labels=\"AABB\", observables=observables\n",
")\n",
Expand All @@ -113,18 +108,6 @@
"bases = partitioned_problem.bases"
]
},
{
"cell_type": "markdown",
"id": "3518e2df",
"metadata": {},
"source": [
"`partition_problem` returns a data structure that includes:\n",
"\n",
"- `subcircuits`: a `Dict` mapping partition labels to subcircuits\n",
"- `subobservables`: a `Dict` mapping partition labels to subobservables\n",
"- `bases`: a `list` of ``QPDBasis`` instances, one for each decomposed instruction"
]
},
{
"cell_type": "markdown",
"id": "9d2d42c3",
Expand Down Expand Up @@ -238,78 +221,139 @@
},
{
"cell_type": "markdown",
"id": "495ce676",
"id": "ef3b061c-cd1d-4931-85f6-155e00b355be",
"metadata": {},
"source": [
"### Generate and run the cutting experiments\n",
"### Generate the subexperiments to run on the backend\n",
"\n",
"`execute_experiments` accepts `circuits`/`subobservables` args as dictionaries mapping qubit partition labels to the respective `subcircuit`/`subobservables`.\n",
"`generate_cutting_experiments` accepts `circuits`/`observables` args as dictionaries mapping qubit partition labels to the respective `subcircuit`/`subobservables`.\n",
"\n",
"To simulate the expectation value of the full-sized circuit, many subexperiments are generated from the decomposed gates' joint quasiprobability distribution and then executed on one or more backends. The number of samples taken from the distribution is controlled by `num_samples`, and one combined weight is given for each unique sample. For more information on how the weights are calculated, refer to the [explanatory material](../explanation/index.rst)."
]
},
{
"cell_type": "code",
"execution_count": 9,
"id": "2029d18e-0e91-4160-b8c9-02cb9e1ba3cb",
"metadata": {},
"outputs": [],
"source": [
"from circuit_knitting.cutting import generate_cutting_experiments\n",
"\n",
"subexperiments, weights = generate_cutting_experiments(circuits=subcircuits, observables=subobservables, num_samples=np.inf)"
]
},
{
"cell_type": "markdown",
"id": "d8870454-2173-4454-90b4-a034779510e0",
"metadata": {},
"source": [
"### Run the subexperiments using the Qiskit Sampler primitive"
]
},
{
"cell_type": "code",
"execution_count": 10,
"id": "7430eef1",
"metadata": {},
"outputs": [],
"source": [
"# Keep in mind, Terra Sampler does not support mid-circuit measurements at all,\n",
"# and Aer Sampler does not support mid-circuit measurements when shots==None.\n",
"samplers = {\n",
" \"A\": Sampler(run_options={\"shots\": 2**12}),\n",
" \"B\": Sampler(run_options={\"shots\": 2**12}),\n",
"}\n",
"from qiskit_aer.primitives import Sampler\n",
"\n",
"quasi_dists, coefficients = execute_experiments(\n",
" circuits=subcircuits,\n",
" subobservables=subobservables,\n",
" num_samples=np.inf,\n",
" samplers=samplers,\n",
")"
"# Set up Qiskit Aer Sampler primitives.\n",
"sampler_a = Sampler(run_options={\"shots\": 2**12})\n",
"sampler_b = Sampler(run_options={\"shots\": 2**12})\n",
"\n",
"# Retrieve results from each subexperiment\n",
"results_a = sampler_a.run(subexperiments[\"A\"]).result()\n",
"results_b = sampler_b.run(subexperiments[\"B\"]).result()"
]
},
{
"cell_type": "markdown",
"id": "a1482b93",
"id": "68eb0522-8c01-4f56-aacc-0bfc60159896",
"metadata": {},
"source": [
"`execute_experiments` returns:\n",
"To use the Qiskit Runtime Sampler, replace the code above with this commented block."
]
},
{
"cell_type": "code",
"execution_count": 11,
"id": "3c9a7e78-4bf9-4dbd-a8f9-3db185591d9c",
"metadata": {},
"outputs": [],
"source": [
"# from qiskit_ibm_runtime import Session, Options, Sampler\n",
"\n",
"# with Session(backend=\"ibmq_qasm_simulator\") as session:\n",
"# options = Options()\n",
"# options.execution.shots = 2**12\n",
"# sampler_a = Sampler(options=options)\n",
"# sampler_b = Sampler(options=options)\n",
"\n",
"# job_a = sampler_a.run(subexperiments[\"A\"])\n",
"# job_b = sampler_b.run(subexperiments[\"B\"])\n",
"\n",
"- A 3D list of length-2 tuples containing a quasiprobability distribution and QPD bit information for each unique subexperiment\n",
"- The coefficients for each subexperiment"
"# results_a = job_a.result()\n",
"# results_b = job_b.result()\n",
"\n",
"# session.close()"
]
},
{
"cell_type": "markdown",
"id": "f0032570",
"id": "749ba4f9-3dda-49d0-ba67-bf83e5839e3c",
"metadata": {},
"source": [
"### Reconstruct the expectation values\n",
"`reconstruct_expectation_values` expects `quasi_dists` and `coefficients` in the same format as returned from `execute_experiments`. `quasi_dists` is a 3D list of shape (`num_unique_samples`, `num_partitions`, `num_commuting_observ_groups`), and `coefficients` is a list with length equal to the number of unique samples. `subobservables` is the dictionary mapping qubit partition label to the associated subobservable(s), as output from `decompose_problem` above."
"### Combine the results from each Sampler primitive\n",
"\n",
"Include the number of bits used for cutting measurements in the results metadata. This will be automated in a future release, but users must specify it manually for now."
]
},
{
"cell_type": "code",
"execution_count": 10,
"id": "7d57339c",
"execution_count": 12,
"id": "2c364959-6e5e-4944-9271-62af44e53085",
"metadata": {},
"outputs": [],
"source": [
"reconstructed_expvals = reconstruct_expectation_values(\n",
" quasi_dists,\n",
" coefficients,\n",
" subobservables,\n",
")"
"for i in range(len(subexperiments[\"A\"])):\n",
" results_a.metadata[i][\"num_qpd_bits\"] = len(\n",
" subexperiments[\"A\"][i].cregs[0]\n",
" )\n",
"for i in range(len(subexperiments[\"B\"])):\n",
" results_b.metadata[i][\"num_qpd_bits\"] = len(\n",
" subexperiments[\"B\"][i].cregs[0]\n",
" )\n",
"# Combine results from each partition into a single results dictionary\n",
"results = {\"A\": results_a, \"B\": results_b}"
]
},
{
"cell_type": "markdown",
"id": "b546c0c4",
"id": "f0032570",
"metadata": {},
"source": [
"### Reconstruct the expectation values\n",
"\n",
"Use the subexperiment results, subobservables, and sampling weights to reconstruct the expectation value of the original circuit."
]
},
{
"cell_type": "code",
"execution_count": 13,
"id": "7d57339c",
"metadata": {},
"outputs": [],
"source": [
"The output of `reconstruct_expectation_values` is a list of expectation values reconstructed from the smaller subexperiments -- one for each observable."
"from circuit_knitting.cutting import reconstruct_expectation_values\n",
"\n",
"reconstructed_expvals = reconstruct_expectation_values(\n",
" results,\n",
" weights,\n",
" subobservables,\n",
")"
]
},
{
Expand All @@ -322,22 +366,24 @@
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": 14,
"id": "e3385ba5",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Simulated expectation values: [0.3519755, 0.51862508, 0.6226452, 0.12015682, 0.23095906, -0.14471573]\n",
"Reconstructed expectation values: [0.37372345, 0.49897975, 0.57569253, 0.09963822, 0.28512102, -0.13684791]\n",
"Exact expectation values: [0.36916216, 0.52511814, 0.59161991, 0.10927476, 0.28001606, -0.12940509]\n",
"Errors in estimation: [-0.01718666, -0.00649306, 0.03102529, 0.01088207, -0.04905701, -0.01531064]\n",
"Relative errors in estimation: [-0.04655586, -0.01236495, 0.05244125, 0.09958448, -0.17519354, 0.1183156]\n"
"Errors in estimation: [0.00456128, -0.02613839, -0.01592738, -0.00963653, 0.00510496, -0.00744283]\n",
"Relative errors in estimation: [0.01235577, -0.04977621, -0.02692164, -0.08818626, 0.01823095, 0.05751572]\n"
]
}
],
"source": [
"from qiskit_aer.primitives import Estimator\n",
"\n",
"estimator = Estimator(run_options={\"shots\": None}, approximation=True)\n",
"exact_expvals = (\n",
" estimator.run([circuit] * len(observables), list(observables)).result().values\n",
Expand All @@ -358,14 +404,14 @@
},
{
"cell_type": "code",
"execution_count": 12,
"execution_count": 15,
"id": "1faa748e",
"metadata": {},
"outputs": [
{
"data": {
"text/html": [
"<h3>Version Information</h3><table><tr><th>Qiskit Software</th><th>Version</th></tr><tr><td><code>qiskit-terra</code></td><td>0.24.1</td></tr><tr><td><code>qiskit-aer</code></td><td>0.12.1</td></tr><tr><td><code>qiskit-ibmq-provider</code></td><td>0.20.2</td></tr><tr><td><code>qiskit</code></td><td>0.43.2</td></tr><tr><td><code>qiskit-nature</code></td><td>0.6.0</td></tr><tr><th>System information</th></tr><tr><td>Python version</td><td>3.8.16</td></tr><tr><td>Python compiler</td><td>Clang 14.0.6 </td></tr><tr><td>Python build</td><td>default, Mar 1 2023 21:19:10</td></tr><tr><td>OS</td><td>Darwin</td></tr><tr><td>CPUs</td><td>8</td></tr><tr><td>Memory (Gb)</td><td>32.0</td></tr><tr><td colspan='2'>Mon Aug 14 08:36:03 2023 CDT</td></tr></table>"
"<h3>Version Information</h3><table><tr><th>Software</th><th>Version</th></tr><tr><td><code>qiskit</code></td><td>0.44.1</td></tr><tr><td><code>qiskit-terra</code></td><td>0.25.1</td></tr><tr><td><code>qiskit_ibm_provider</code></td><td>0.6.3</td></tr><tr><td><code>qiskit_aer</code></td><td>0.12.1</td></tr><tr><th colspan='2'>System information</th></tr><tr><td>Python version</td><td>3.8.16</td></tr><tr><td>Python compiler</td><td>Clang 14.0.6 </td></tr><tr><td>Python build</td><td>default, Mar 1 2023 21:19:10</td></tr><tr><td>OS</td><td>Darwin</td></tr><tr><td>CPUs</td><td>8</td></tr><tr><td>Memory (Gb)</td><td>32.0</td></tr><tr><td colspan='2'>Tue Sep 05 10:55:59 2023 CDT</td></tr></table>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
Expand Down
Loading