Fix code examples in primitives-examples.mdx (#1342)

Follow up to #1146. There were a few issues: * all imports should be at the top of the code block * we were defining Estimator a few times it was not used, or that it was redeclared later * not using the n_qubits arg --------- Co-authored-by: Rebecca Dimock <[email protected]>
Qiskit · May 10, 2024 · 60e36ca · 60e36ca
1 parent 8a70b8e
commit 60e36ca
Showing 1 changed file with 50 additions and 77 deletions.
diff --git a/docs/run/primitives-examples.mdx b/docs/run/primitives-examples.mdx
@@ -39,15 +39,13 @@ import numpy as np
 from qiskit.circuit.library import IQP
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import SparsePauliOp, random_hermitian
-from qiskit_ibm_runtime import EstimatorV2 as Estimator
-
-from qiskit_ibm_runtime import QiskitRuntimeService
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-estimator = Estimator(backend)
+from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 mat = np.real(random_hermitian(n_qubits, seed=1234))
 circuit = IQP(mat)
 observable = SparsePauliOp("Z" * n_qubits)
@@ -56,6 +54,7 @@ pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
 isa_circuit = pm.run(circuit)
 isa_observable = observable.apply_layout(isa_circuit.layout)
 
+estimator = Estimator(backend)
 job = estimator.run([(isa_circuit, isa_observable)])
 result = job.result()
 
@@ -77,12 +76,11 @@ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import SparsePauliOp, random_hermitian
 from qiskit_ibm_runtime import QiskitRuntimeService, Estimator
 
-service = QiskitRuntimeService()
-
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 mat = np.real(random_hermitian(n_qubits, seed=1234))
 circuit = IQP(mat)
 observable = SparsePauliOp("Z" * n_qubits)
@@ -113,14 +111,13 @@ import numpy as np
 from qiskit.circuit.library import IQP
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import SparsePauliOp, random_hermitian
-from qiskit_ibm_runtime import EstimatorV2 as Estimator
-from qiskit_ibm_runtime import QiskitRuntimeService
+from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator
+
+n_qubits = 127
 
 service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-estimator = Estimator(backend)
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
 
-n_qubits = 127
 rng = np.random.default_rng()
 mats = [np.real(random_hermitian(n_qubits, seed=rng)) for _ in range(3)]
 
@@ -168,12 +165,10 @@ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import SparsePauliOp, random_hermitian
 from qiskit_ibm_runtime import QiskitRuntimeService, Estimator
 
+n_qubits = 127
 
 service = QiskitRuntimeService()
-
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-
-n_qubits = 127
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
 
 rng = np.random.default_rng()
 mats = [np.real(random_hermitian(n_qubits, seed=rng)) for _ in range(3)]
@@ -209,11 +204,12 @@ import numpy as np
 from qiskit.circuit import QuantumCircuit, Parameter
 from qiskit.quantum_info import SparsePauliOp
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
-from qiskit_ibm_runtime import EstimatorV2 as Estimator
+from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False)
 
 # Step 1: Map classical inputs to a quantum problem
-
 theta = Parameter("θ")
 
 chsh_circuit = QuantumCircuit(2)
@@ -233,11 +229,6 @@ ops = [ZZ, ZX, XZ, XX]
 
 # Step 2: Optimize problem for quantum execution.
 
-from qiskit_ibm_runtime import QiskitRuntimeService
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False)
-estimator = Estimator(backend)
-
 pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
 chsh_isa_circuit = pm.run(chsh_circuit)
 isa_observables = [operator.apply_layout(chsh_isa_circuit.layout) for operator in ops]
@@ -308,7 +299,6 @@ from qiskit.quantum_info import SparsePauliOp
 from qiskit_ibm_runtime import QiskitRuntimeService, Estimator
 
 service = QiskitRuntimeService()
-
 backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
 
 circuit = RealAmplitudes(num_qubits=127, reps=2)
@@ -343,15 +333,13 @@ import numpy as np
 from qiskit.circuit.library import IQP
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import SparsePauliOp, random_hermitian
-from qiskit_ibm_runtime import Session, EstimatorV2 as Estimator
-from qiskit_ibm_runtime import QiskitRuntimeService
-
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-estimator = Estimator(backend)
+from qiskit_ibm_runtime import QiskitRuntimeService, Session, EstimatorV2 as Estimator
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 rng = np.random.default_rng(1234)
 mat = np.real(random_hermitian(n_qubits, seed=rng))
 circuit = IQP(mat)
@@ -404,6 +392,9 @@ from qiskit_ibm_runtime import QiskitRuntimeService, Session, Estimator, Options
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 rng = np.random.default_rng(1234)
 mat = np.real(random_hermitian(n_qubits, seed=rng))
 circuit = IQP(mat)
@@ -422,10 +413,6 @@ options = Options()
 options.optimization_level = 2
 options.resilience_level = 2
 
-service = QiskitRuntimeService()
-
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-
 with Session(service=service, backend=backend) as session:
     estimator = Estimator(session=session, options=options)
     job = estimator.run(isa_circuit, isa_observable)
@@ -456,17 +443,16 @@ Use Sampler to return the measurement outcome as a quasi-probability distributio
   <TabItem value="SamplerV2" label="Sampler V2">
 ```python
 import numpy as np
-from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.circuit.library import IQP
+from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import random_hermitian
-from qiskit_ibm_runtime import SamplerV2 as Sampler
-from qiskit_ibm_runtime import QiskitRuntimeService
-
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
+from qiskit_ibm_runtime import QiskitRuntimeService, SamplerV2 as Sampler
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 mat = np.real(random_hermitian(n_qubits, seed=1234))
 circuit = IQP(mat)
 circuit.measure_all()
@@ -497,12 +483,11 @@ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import random_hermitian
 from qiskit_ibm_runtime import QiskitRuntimeService, Sampler
 
-service = QiskitRuntimeService()
-
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 mat = np.real(random_hermitian(n_qubits, seed=1234))
 circuit = IQP(mat)
 circuit.measure_all()
@@ -532,15 +517,13 @@ import numpy as np
 from qiskit.circuit.library import IQP
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import random_hermitian
-from qiskit_ibm_runtime import SamplerV2 as Sampler
-from qiskit_ibm_runtime import QiskitRuntimeService
-
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-estimator = Estimator(backend)
+from qiskit_ibm_runtime import QiskitRuntimeService, SamplerV2 as Sampler
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 rng = np.random.default_rng()
 mats = [np.real(random_hermitian(n_qubits, seed=rng)) for _ in range(3)]
 circuits = [IQP(mat) for mat in mats]
@@ -573,12 +556,11 @@ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit.quantum_info import random_hermitian
 from qiskit_ibm_runtime import QiskitRuntimeService, Sampler
 
-service = QiskitRuntimeService()
-
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 rng = np.random.default_rng()
 mats = [np.real(random_hermitian(n_qubits, seed=rng)) for _ in range(3)]
 circuits = [IQP(mat) for mat in mats]
@@ -609,11 +591,14 @@ Run several experiments in a single job, leveraging parameter values to increase
 import numpy as np
 from qiskit.circuit.library import RealAmplitudes
 from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
-
-# Step 1: Map classical inputs to a quantum problem
+from qiskit_ibm_runtime import QiskitRuntimeService, SamplerV2 as Sampler
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
+# Step 1: Map classical inputs to a quantum problem
 circuit = RealAmplitudes(num_qubits=n_qubits, reps=2)
 circuit.measure_all()
 
@@ -625,19 +610,10 @@ parameter_values = [
 
 # Step 2: Optimize problem for quantum execution.
 
-from qiskit_ibm_runtime import SamplerV2 as Sampler
-from qiskit_ibm_runtime import QiskitRuntimeService
-
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-
 pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
 isa_circuit = pm.run(circuit)
 
 # Step 3: Execute using Qiskit primitives.
-
-from qiskit_ibm_runtime import SamplerV2 as Sampler
-
 sampler = Sampler(backend)
 job = sampler.run([(isa_circuit, parameter_values)])
 result = job.result()
@@ -660,7 +636,6 @@ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit_ibm_runtime import QiskitRuntimeService, Sampler
 
 service = QiskitRuntimeService()
-
 backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
 
 circuit = RealAmplitudes(num_qubits=127, reps=2)
@@ -699,12 +674,11 @@ from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
 from qiskit_ibm_runtime import Session, SamplerV2 as Sampler
 from qiskit_ibm_runtime import QiskitRuntimeService
 
-service = QiskitRuntimeService()
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-estimator = Estimator(backend)
-
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 rng = np.random.default_rng(1234)
 mat = np.real(random_hermitian(n_qubits, seed=rng))
 circuit = IQP(mat)
@@ -752,6 +726,9 @@ from qiskit_ibm_runtime import QiskitRuntimeService, Sampler, Session, Options
 
 n_qubits = 127
 
+service = QiskitRuntimeService()
+backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
+
 rng = np.random.default_rng(1234)
 mat = np.real(random_hermitian(n_qubits, seed=rng))
 circuit = IQP(mat)
@@ -760,10 +737,6 @@ mat = np.real(random_hermitian(n_qubits, seed=rng))
 another_circuit = IQP(mat)
 another_circuit.measure_all()
 
-service = QiskitRuntimeService()
-
-backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
-
 pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
 isa_circuit = pm.run(circuit)
 another_isa_circuit = pm.run(another_circuit)