Update code for runtime 0.24.1 (#1580)

This PR bumps the `qiskit_ibm_runtime` version to the most recent, and
updates our code examples to work with that version.

---------

Co-authored-by: Eric Arellano <[email protected]>

Author: frankharkins

docs/build/pulse.ipynb

@@ -87,9 +87,9 @@
    "source": [
     "from qiskit import pulse\n",
     "from qiskit.pulse.library import Gaussian\n",
-    "from qiskit_ibm_runtime.fake_provider import FakeValencia\n",
+    "from qiskit_ibm_runtime.fake_provider import FakeValenciaV2\n",
     "\n",
-    "backend = FakeValencia()\n",
+    "backend = FakeValenciaV2()\n",
     "\n",
     "with pulse.build(backend, name='hadamard') as h_q0:\n",
     "    pulse.play(Gaussian(duration=128, amp=0.1, sigma=16), pulse.drive_channel(0))"
@@ -169,7 +169,22 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "['id', 'rz', 'sx', 'x', 'cx', 'reset']\n"
+      "Instruction(name='sx', num_qubits=1, num_clbits=0, params=[]) (0,)\n",
+      "Instruction(name='sx', num_qubits=1, num_clbits=0, params=[]) (1,)\n",
+      "Instruction(name='cx', num_qubits=2, num_clbits=0, params=[]) (0, 1)\n",
+      "Instruction(name='cx', num_qubits=2, num_clbits=0, params=[]) (1, 0)\n",
+      "Instruction(name='reset', num_qubits=1, num_clbits=0, params=[]) (0,)\n",
+      "Instruction(name='reset', num_qubits=1, num_clbits=0, params=[]) (1,)\n",
+      "Instruction(name='x', num_qubits=1, num_clbits=0, params=[]) (0,)\n",
+      "Instruction(name='x', num_qubits=1, num_clbits=0, params=[]) (1,)\n",
+      "Delay(duration=t[unit=dt]) (0,)\n",
+      "Delay(duration=t[unit=dt]) (1,)\n",
+      "Instruction(name='measure', num_qubits=1, num_clbits=1, params=[]) (0,)\n",
+      "Instruction(name='measure', num_qubits=1, num_clbits=1, params=[]) (1,)\n",
+      "Instruction(name='id', num_qubits=1, num_clbits=0, params=[]) (0,)\n",
+      "Instruction(name='id', num_qubits=1, num_clbits=0, params=[]) (1,)\n",
+      "Instruction(name='rz', num_qubits=1, num_clbits=0, params=[Parameter(λ)]) (0,)\n",
+      "Instruction(name='rz', num_qubits=1, num_clbits=0, params=[Parameter(λ)]) (1,)\n"
      ]
     },
     {
@@ -187,14 +202,17 @@
     }
    ],
    "source": [
-    "from qiskit_ibm_runtime.fake_provider import FakeHanoi\n",
+    "from qiskit_ibm_runtime.fake_provider import FakeHanoiV2\n",
     "from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager\n",
     "\n",
-    "backend = FakeHanoi()\n",
+    "backend = FakeHanoiV2()\n",
     "passmanager = generate_preset_pass_manager(optimization_level=1, backend=backend)\n",
     "circ = passmanager.run(circ)\n",
     "\n",
-    "print(backend.configuration().basis_gates)\n",
+    "# Print instructions that only affect qubits 0 and 1\n",
+    "for instruction, qubits in FakeHanoiV2().instructions:\n",
+    "    if qubits and set(qubits).issubset({0, 1}):\n",
+    "        print(instruction, qubits)\n",
     "circ.draw('mpl', idle_wires=False)"
    ]
   },
@@ -203,7 +221,7 @@
    "id": "aa09ca2c-25cb-4220-859e-c03dc710c6ea",
    "metadata": {},
    "source": [
-    "Notice that `h` is not a basis gate for the mock backend `FakeHanoi`. Since you added a calibration for it, the transpiler will treat the gate as a basis gate, _but only on the qubits for which it was defined_. A Hadamard applied to a different qubit would be unrolled to the basis gates.\n",
+    "Notice that `h` is not a basis gate for the mock backend `FakeHanoiV2`. Since you added a calibration for it, the transpiler will treat the gate as a basis gate, _but only on the qubits for which it was defined_. A Hadamard applied to a different qubit would be unrolled to the basis gates.\n",
     "\n",
     "### Custom gates\n",
     "\n",
@@ -339,12 +357,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from qiskit_ibm_runtime.fake_provider import FakePerth\n",
+    "from qiskit_ibm_runtime.fake_provider import FakeKyoto\n",
     "from qiskit.circuit import QuantumCircuit, Gate\n",
     "from qiskit.pulse import builder, DriveChannel\n",
     "from qiskit.transpiler import InstructionProperties\n",
     "\n",
-    "backend = FakePerth()\n",
+    "backend = FakeKyoto()\n",
     "\n",
     "custom_gate = Gate(\"my_gate\", 1, [])\n",
     "qc = QuantumCircuit(1, 1)\n",
@@ -493,9 +511,9 @@
     }
    ],
    "source": [
-    "from qiskit_ibm_runtime.fake_provider import FakeValencia\n",
+    "from qiskit_ibm_runtime.fake_provider import FakeValenciaV2\n",
     "\n",
-    "backend = FakeValencia()\n",
+    "backend = FakeValenciaV2()\n",
     "\n",
     "with pulse.build(backend=backend, name='backend_aware') as backend_aware_program:\n",
     "    channel = pulse.drive_channel(0)\n",

docs/run/advanced-runtime-options.mdx

@@ -61,7 +61,7 @@ When creating an instance of the `Estimator` or `Sampler` class, you can pass in
     `SamplerV2` and `EstimatorV2` have separate options classes that do not need to be instantiated.  You can see the available options and update option values during or after primitive initialization.  Those options will then be applied when you use `run()` to perform the calculation.  Example:
 
 ```python
-estimator = Estimator(backend=backend)
+estimator = Estimator(mode=backend)
 
 # Setting options after primitive initialization
 # This uses auto complete.
@@ -74,7 +74,7 @@ estimator.options.default_shots = 4000
 When creating an instance of the `Estimator` or `Sampler` class, you can pass in the `options` you created in the options class. Those options will then be applied when you use `run()` to perform the calculation.  Example:
 
 ```python
-estimator = Estimator(session=backend, options=options)
+estimator = Estimator(mode=backend, options=options)
 result = estimator.run(circuit, observable).result()
 print(f">>> Metadata: {result.metadata[0]}")
 ```
@@ -131,7 +131,7 @@ sampler.run([circuit1, circuit2], shots=128)
   <TabItem value="PrimV1" label="V1 primitives">
 You can pass any options to `run()`. Because most users will only overwrite a few options at the job level, it is not necessary to specify the options category. The code below, for example, specifies `shots=1024` instead of `execution={"shots": 1024}` (which is also valid).
 ```python
-estimator = Estimator(session=backend, options=options)
+estimator = Estimator(mode=backend, options=options)
 result = estimator.run(circuit, observable, shots=1024).result()
 print(f">>> Metadata: {result.metadata[0]}")
 ```
@@ -176,7 +176,7 @@ from qiskit_ibm_runtime import Estimator, Options
 options = Options()
 options.execution.shots = 1024
 
-estimator = Estimator(session=backend, options=options)
+estimator = Estimator(mode=backend, options=options)
 ```
 
 If you need to modify the number of shots set between iterations (primitive calls), you can set the
@@ -185,7 +185,7 @@ shots directly in the `run()` method. This overwrites the initial `shots` settin
 ```python
 from qiskit_ibm_runtime import Estimator
 
-estimator = Estimator(session=backend)
+estimator = Estimator(mode=backend)
 
 estimator.run(circuits=circuits, observables=observables, shots=50)
 
@@ -218,7 +218,7 @@ See the Optimization level table in the
 ```python
 from qiskit_ibm_runtime import EstimatorV2 as Estimator
 
-estimator = Estimator(session=backend, options={"optimization_level": 1})
+estimator = Estimator(mode=backend, options={"optimization_level": 1})
 
 # or..
 estimator.options.optimization_level = 1
@@ -243,7 +243,7 @@ options = Options(optimization_level=1)
 options = Options()
 options.optimization_level = 1
 
-estimator = Estimator(session=backend, options=options)
+estimator = Estimator(mode=backend, options=options)
 ```
 
 Turning off all optional runtime compilation steps requires a "second-level option", as follows:
@@ -254,7 +254,7 @@ from qiskit_ibm_runtime import Estimator, Options
 options = Options()
 options.transpilation.skip_transpilation = True
 
-estimator = Estimator(session=backend, options=options)
+estimator = Estimator(mode=backend, options=options)
 ```
 
 For more information and a complete list of advanced transpilation options, see the Advanced transpilation options table in the
@@ -274,7 +274,7 @@ algorithm.  These methods can be set through the `resilience_level` option.  For
 With Estimator V2, you can set resilience levels 0-2 and you can also turn on and off various error mitigation settings for fine-tuning.
 
 ```python
-estimator = Estimator(backend=backend)
+estimator = Estimator(mode=backend)
 
 estimator.options.resilience_level = 2
 estimator.options.resilience.zne_mitigation = True
@@ -298,7 +298,7 @@ options = Options(resilience_level = 2)
 options = Options()
 options.resilience_level = 2
 
-estimator = Estimator(session=backend, options=options)
+estimator = Estimator(mode=backend, options=options)
 ```
 </TabItem>
 </Tabs>

docs/run/circuit-execution.mdx

@@ -40,7 +40,7 @@ backend = service.least_busy(operational=True, min_num_qubits=100, dynamic_repra
 
 # Determine the allowable range
 backend.rep_delay_range
-sampler = Sampler(backend=backend)
+sampler = Sampler(mode=backend)
 
 #Specify a value in the supported range
 sampler.options.execution.rep_delay = 0.0005

docs/run/configure-error-mitigation.mdx

@@ -334,7 +334,7 @@ options.resilience_level = 2
 options.optimization_level = 1
 backend = service.least_busy(operational=True, simulator=False)
 
-estimator = Estimator(options=options, backend=backend)
+estimator = Estimator(options=options, mode=backend)
 ```
 
 <Admonition type="info" title="Note">
@@ -466,7 +466,7 @@ options.resilience.noise_amplifier = 'CxAmplifier'
 options.resilience.extrapolator = 'QuadraticExtrapolator'
 backend = service.least_busy(operational=True, simulator=False)
 
-estimator = Estimator(options=options, backend=backend)
+estimator = Estimator(options=options, mode=backend)
 job = estimator.run(circuits=[psi1], observables=[H1], parameter_values=[theta1])
 psi1_H1 = job.result()
 ```

docs/run/configure-runtime-compilation.mdx

@@ -88,7 +88,7 @@ pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
 psi = pm.run(psi)
 H = H.apply_layout(psi.layout)
 
-estimator = Estimator(backend=backend)
+estimator = Estimator(mode=backend)
 
 estimator.options.optimization_level = 1
 
@@ -117,7 +117,7 @@ pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
 psi = pm.run(psi)
 H = H.apply_layout(psi.layout)
 
-estimator = Estimator (options=options, backend=backend)
+estimator = Estimator(options=options, mode=backend)
 
 job = estimator.run(circuits=[psi], observables=[H], parameter_values=[theta])
 psi1_H1 = job.result()

docs/run/error-mitigation-explanation.ipynb

@@ -68,7 +68,7 @@
    },
    "outputs": [],
    "source": [
-    "estimator = Estimator(backend=backend)\n",
+    "estimator = Estimator(mode=backend)\n",
     "estimator.options.dynamical_decoupling.enable = True\n",
     "estimator.options.dynamical_decoupling.sequence_type = \"XpXm\""
    ]
@@ -114,7 +114,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "estimator = Estimator(backend=backend)\n",
+    "estimator = Estimator(mode=backend)\n",
     "estimator.options.twirling.enable_gates = True\n",
     "estimator.options.twirling.num_randomizations = 32\n",
     "estimator.options.twirling.shots_per_randomization = 100"
@@ -153,7 +153,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "estimator = Estimator(backend=backend)\n",
+    "estimator = Estimator(mode=backend)\n",
     "estimator.options.resilience.measure_mitigation = True\n",
     "estimator.options.resilience.measure_noise_learning.num_randomizations = 32\n",
     "estimator.options.resilience.measure_noise_learning.shots_per_randomization = 100"
@@ -201,7 +201,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "estimator = Estimator(backend=backend)\n",
+    "estimator = Estimator(mode=backend)\n",
     "estimator.options.resilience.zne_mitigation = True\n",
     "estimator.options.resilience.zne.noise_factors = (1, 3, 5)\n",
     "estimator.options.resilience.zne.extrapolator = \"exponential\""
@@ -243,7 +243,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "estimator = Estimator(backend=backend)\n",
+    "estimator = Estimator(mode=backend)\n",
     "estimator.options.resilience.pec_mitigation = True\n",
     "estimator.options.resilience.pec.max_overhead = 100"
    ]

docs/run/instances.mdx

@@ -69,8 +69,8 @@ backend1 = service.backend("ibmq_manila")
 # Optional: Specify it at the backend level, which overwrites the service-level specification when this backend is used. 
 backend2 = service.backend("ibmq_manila", instance="hub2/group2/project2")
 
-sampler1 = SamplerV2(backend=backend1)    # this will use hub1/group1/project1
-sampler2 = SamplerV2(backend=backend2)    # this will use hub2/group2/project2
+sampler1 = SamplerV2(mode=backend1)    # this will use hub1/group1/project1
+sampler2 = SamplerV2(mode=backend2)    # this will use hub2/group2/project2
 ```
   </TabItem>
 
@@ -88,8 +88,8 @@ backend1 = service.backend("ibmq_manila")
 # Optional: Specify it at the backend level, which overwrites the service-level specification when this backend is used. 
 backend2 = service.backend("ibmq_manila", instance="hub2/group2/project2")
 
-sampler1 = Sampler(backend=backend1)    # this will use hub1/group1/project1
-sampler2 = Sampler(backend=backend2)    # this will use hub2/group2/project2
+sampler1 = Sampler(mode=backend1)    # this will use hub1/group1/project1
+sampler2 = Sampler(mode=backend2)    # this will use hub2/group2/project2
 ```
   </TabItem>
 </Tabs>

docs/run/primitives-examples.mdx

@@ -355,7 +355,7 @@ isa_observable = observable.apply_layout(isa_circuit.layout)
 another_isa_observable = another_observable.apply_layout(another_isa_circuit.layout)
 
 with Session(service=service, backend=backend) as session:
-    estimator = Estimator(session=session)
+    estimator = Estimator(mode=session)
 
     estimator.options.optimization_level = 1
     estimator.options.resilience_level = 1
@@ -414,7 +414,7 @@ options.optimization_level = 2
 options.resilience_level = 2
 
 with Session(service=service, backend=backend) as session:
-    estimator = Estimator(session=session, options=options)
+    estimator = Estimator(mode=session, options=options)
     job = estimator.run(isa_circuit, isa_observable)
     another_job = estimator.run(another_isa_circuit, another_isa_observable)
     result = job.result()
@@ -692,7 +692,7 @@ isa_circuit = pm.run(circuit)
 another_isa_circuit = pm.run(another_circuit)
 
 with Session(backend=backend) as session:
-    sampler = Sampler(session=session)
+    sampler = Sampler(mode=session)
     job = sampler.run([isa_circuit])
     another_job = sampler.run([another_isa_circuit])
     result = job.result()
@@ -746,7 +746,7 @@ options.optimization_level = 2
 options.resilience_level = 0
 
 with Session(service=service, backend=backend) as session:
-    sampler = Sampler(session=session, options=options)
+    sampler = Sampler(mode=session, options=options)
     job = sampler.run(isa_circuit)
     another_job = sampler.run(another_isa_circuit)
     result = job.result()

docs/run/primitives-get-started.mdx

@@ -39,7 +39,7 @@ from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator
 
 service = QiskitRuntimeService()
 backend = service.least_busy(operational=True, simulator=False, min_num_qubits=127)
-estimator = Estimator(backend)
+estimator = Estimator(mode=backend)
 ```
 
 ### 2. Create a circuit and an observable
@@ -83,15 +83,15 @@ To use the Estimator V2, import the **EstimatorV2** class. The **Estimator** cla
 ```python
 from qiskit_ibm_runtime import EstimatorV2 as Estimator
 
-estimator = Estimator(backend=backend)
+estimator = Estimator(mode=backend)
  ```
   </TabItem>
 
   <TabItem value="EstimatorV1" label="Estimator (V1)">
 ```python
 from qiskit_ibm_runtime import Estimator
 
-estimator = Estimator(backend=backend)
+estimator = Estimator(mode=backend)
 ```
   </TabItem>
 </Tabs>
@@ -197,15 +197,15 @@ To use the Sampler V2, import the **SamplerV2** class. The **Sampler** class sti
     ```python
 from qiskit_ibm_runtime import SamplerV2 as Sampler
 
-sampler = Sampler(backend=backend)
+sampler = Sampler(mode=backend)
 ```
   </TabItem>
 
   <TabItem value="SamplerV1" label="Sampler (V1)">
     ```python
 from qiskit_ibm_runtime import Sampler
 
-sampler = Sampler(backend=backend)
+sampler = Sampler(mode=backend)
 ```
   </TabItem>
 </Tabs>

docs/run/quantum-serverless.mdx

@@ -166,7 +166,7 @@ target_circuit = selector.optimized_circuit
 # target_circuit = pm.run(abstract_circuit)
 
 # Step 3: Execute the target circuit
-sampler = Sampler(backend=backend, options={"default_shots": 1024})
+sampler = Sampler(mode=backend, options={"default_shots": 1024})
 job = sampler.run([target_circuit])
 result = job.result()