Support local execution on simulators #1243

merav-aharoni · 2023-11-29T13:54:42Z

Summary

When the backend is a FakeBackend or AerSimulator, run the program locally, rather than through the IBM Cloud.

Details and comments

Fixes #

merav-aharoni · 2023-11-29T16:43:28Z

I wrote the basic flow, including a simple test. However, I encountered quite a few problems/questions:

What is the correct way to transfer options? Which options should be transferred?
Currently working only when skip_transpilation=True - fixed
Should we support FakeBackends V1 in addition to V2? - see @kt474's comments below
Still need to add support for circuit-runner. Is QASM3 supported on simulators?
Should ibmq_qasm_simulator also run locally? - see @kt474's comments below
Does Session have any meaning when running on simulator? - see @kt474's comments below
Must the user have an account to run on a simulator? Currently, we need to initialize a QiskitRuntimeService, and this fails when no account. - see @kt474's comments below

@kt474 , @jyu00 - any insights on the above are welcome.

kt474 · 2023-12-05T04:33:31Z

What is the correct way to transfer options? Which options should be transferred?
I'm not sure about how options would work in these fake backends, i'll have to take a look. @jyu00 thoughts here?

Should we support FakeBackends V1 in addition to V2?

I don't believe so, we can just support V2 for now

Still need to add support for circuit-runner. Is QASM3 supported on simulators?

No, QASM3 is not currently supported on simulators

Should ibmq_qasm_simulator also run locally?

No, I don't believe so - ibmq_qasm_simulator is one of the simulators that will be sunset.

Does Session have any meaning when running on simulator?

No, sessions don't have any meaning when using simulators - jobs on simulators run the same way, independent of whether
or not they are in a session

Must the user have an account to run on a simulator? Currently, we need to initialize a QiskitRuntimeService, and this fails when no account.

Yes, the user must have an account

…untime into fake_backends

merav-aharoni · 2023-12-07T17:22:40Z

On second thought, I am not sure we need to do anything more for executing backend.run for fake backends. Have a look at the following code:

from qiskit_ibm_runtime import QiskitRuntimeService
from qiskit import QuantumCircuit

backend_name="fake_almaden"
service = QiskitRuntimeService(channel="ibm_quantum")
backend = service.backend(name=backend_name)

circuit = QuantumCircuit(2,2)
circuit.h(0)
circuit.cx(0, 1)
circuit.measure([0,1], [0,1])
result = backend.run(circuit, seed_simulator=4, shots=10, method="statevector").result()

print("name = ", result.backend_name)
print("shots = ", result.results[0].shots)
print("seed = ", result.results[0].seed_simulator)
print("method = ", result.results[0].metadata["method"])

Results are:

name =  aer_simulator
shots =  10
seed =  4
method =  statevector

What do you think?

ElePT · 2023-12-08T14:39:28Z

qiskit_ibm_runtime/fake_provider/fake_provider.py

 from qiskit.providers.provider import ProviderV1
 from qiskit.providers.exceptions import QiskitBackendNotFoundError
+from qiskit.providers.fake_provider.fake_backend import FakeBackendV2


I have recently opened a PR that migrates the fake provider base classes from qiskit (#1270), should it be merged before this PR, this import path would change to from qiskit_ibm_runtime.fake_provider.fake_backend import FakeBackendV2. I'm happy to monitor it on my side, but thought it would make sense to bring it to your attention too.

ElePT · 2023-12-08T14:40:13Z

qiskit_ibm_runtime/fake_runtime_job.py

+
+from qiskit.primitives.primitive_job import PrimitiveJob
+from qiskit.providers import JobStatus, JobV1
+from qiskit.providers.fake_provider import FakeBackendV2 as FakeBackend


same comment as above regarding the import path

ElePT · 2023-12-08T14:42:03Z

qiskit_ibm_runtime/options/utils.py

@@ -12,6 +12,7 @@

 """Utility functions for options."""

+from qiskit.providers.fake_provider import fake_backend


kt474 · 2023-12-08T17:39:44Z

qiskit_ibm_runtime/fake_runtime_job.py

+    ) -> None:
+        """FakeRuntimeJob constructor."""
+        super().__init__(backend=backend, job_id=job_id)
+        # self._service = service  # do we need this?


I don't think we need service, but it would be nice to have the other ones - creation_date, user_callback, result_decoder, tags

I added creation_date and tags.
Removed user_callback as you wrote below and also because it refers to interim results.
Removed result_decoder as you wrote below, because results will not be returned encoded.

kt474 · 2023-12-09T15:13:34Z

qiskit_ibm_runtime/base_primitive.py

+                inputs=primitive_inputs,
+                # are the following relevant for simulators?
+                # callback=combined.get("environment", {}).get("callback", None),
+                # result_decoder=DEFAULT_DECODERS.get(self._program_id()),


I think we can leave these out for simulators

In terms of the other options, I think it'd be nice to have the run options like:

{'shots': 400, 'init_qubits': True, 'noise_model': None, 'seed_simulator': None}
and
{'max_execution_time': None, 'log_level': 'WARNING', 'job_tags': []}

shots and seed_simulator are already supported.

I couldn't fine init_qubits or anything similar in the AerSimulator, so I don't think there is any point of passing it on. Let me know if you know otherwise. I did find it as a parameter of assemble_circuits in Terra, but I am not sure how and if this is called.

Same as above for max_execution_time.

noise_model - I think this is only relevant when calling AerSimulator and not for fake backends, because the latter define their own noise models. For Aer, I pass along all the options that are AerSimulator._default_options().

Regarding log_level, in Terra and in Aer, I only found setting the log_level globally as an environment variable, so I am not sure what we can do here.

job_tags - I added to FakeRuntimeJob.

qiskit_ibm_runtime/fake_provider/fake_provider.py

jyu00 · 2023-12-12T19:08:25Z

qiskit_ibm_runtime/base_primitive.py

@@ -98,6 +101,13 @@ def __init__(
        if isinstance(backend, IBMBackend):
            self._service = backend.service
            self._backend = backend
+        elif isinstance(backend, AerSimulator):


This should check for both Aer and FakeBackend

Good comment. I actually only supported FakeBackendV2 when given as a string. I modified here and added to the test TestRunSimulation.test_basic_flow.

jyu00 · 2023-12-12T19:11:23Z

qiskit_ibm_runtime/base_primitive.py

@@ -20,10 +20,13 @@
 from dataclasses import asdict
 import warnings

+from qiskit_aer import AerSimulator


Aer is not a required package, so this import be wrapped with try/except

Added try and raise exception when attempting to run with a simulator and not aer.
Also added skip for relevant tests.
Please have a look if it is done properly.

jyu00 · 2023-12-12T19:12:15Z

qiskit_ibm_runtime/base_primitive.py

        primitive_inputs.update(Options._get_program_inputs(combined))

-        if self._backend and combined["transpilation"]["skip_transpilation"]:
+        if self._backend and combined["transpilation"]["skip_transpilation"] and not run_simulator:


check_faulty should apply to fake backends as well, if we ever get one that mimics a real backend with faulty edge/qubits

There is currently no check_faulty method in FakeBackendV2 nor in AerSimulator. To support this, we would need to add such a method to FakeBackendV2 after it is transferred to Runtime. So I suggest we defer this to a separate issue.

jyu00 · 2023-12-12T19:14:50Z

qiskit_ibm_runtime/fake_runtime_job.py

+    def result(self) -> Any:
+        """Return the results of the job."""
+        return self._primitive_job.result()
+
+    def cancel(self) -> None:
+        self._primitive_job.cancel()
+
+    def status(self) -> JobStatus:
+        return self._primitive_job.status()


Why not just inherit PrimitiveJob, then you only need to add methods not already supported.

I tried, but couldn't manage to do that, because I am receiving primitive_job as an object and couldn't find a way to construct the FakeRuntimeObject with a pre-constructed super() object. I would need something like a copy constructor.
I could simply use PrimitiveJob directly, but then I wouldn't be able to add any fields/methods.
Can you advise how to do this with inheritance?

jyu00 · 2023-12-12T19:20:22Z

qiskit_ibm_runtime/options/utils.py

+    is_simulator = (
+        isinstance(backend, fake_backend.FakeBackendV2) or backend.configuration().simulator
+    )


There is no need to change optimization_level and resilience_level for fake backends. Fake backends should always have noise model (from the real backend it mimics), so one doesn't have to pass it in. And none supports resilience_level.

Changed so we don't apply this to a FakeBackend.

jyu00 · 2023-12-12T19:23:34Z

qiskit_ibm_runtime/base_primitive.py

+            self._service = (
+                QiskitRuntimeService()
+                if QiskitRuntimeService.global_service is None
+                else QiskitRuntimeService.global_service
+            )


Instead of adding all the local logic into QiskitRuntimeService, it'd be much cleaner to just create a new LocalRuntimeService to "mock" any server requests.

I am not sure I understand your intention in this comment. Do you mean that when running on a simulator, we don't need a real service, and don't need to have a real account?

Yes, so instead of modifying QiskitRuntimeService, base_primitive can set self._service to a mock (local) service. And its run() method would handle the local operation.

I will try this. Are you also saying that the local run will not need an account? because in a comment above, @kt474 thought it should have an account.

We can do it this way, without an account

I didn't get a chance to complete this item. I think it might be best to do in a separate PR. In any case, it is up to you @kt474 or @jyu00 to continue from here.

…untime into fake_backends

…y name.

…on levels as for other simulators

kt474 · 2024-03-20T15:14:39Z

Closing, this was done in #1495

merav-aharoni added 10 commits November 15, 2023 16:05

Recognized fake backends

ef7956f

Continuing support for fake backends in Sampler

d6ab634

Merge branch 'main' into fake_backends

fc6e323

Created FakeRuntimeJob

d105760

Added AerSimulator

80ff68f

Merged with main

7b8578d

Small fixes

e55831b

Cleaning up

9afe8b3

Added sample test

9e0d7ff

Fixed passing options to fake backend

a56063f

merav-aharoni added 2 commits December 4, 2023 12:09

Added set_transpile_options

959445b

Merge branch 'main' into fake_backends

86b402b

merav-aharoni added 16 commits December 5, 2023 11:03

Fixed options parameters

0bb8f03

lint and black

a83701e

Use fake_provider.py to get fake backends

12fe17c

Merge branch 'fake_backends' of github.com:merav-aharoni/qiskit-ibm-r…

c4fbb9f

…untime into fake_backends

Added estimator to test

b4072af

Added check that fake_backend is not IBMBackend, for test suite

fb28323

lint

1918431

Fixes for mypy

a59784b

black

ee0ed3e

Merge branch 'main' into fake_backends

2eae3b5

black

a6516a3

Merge branch 'fake_backends' of github.com:merav-aharoni/qiskit-ibm-r…

0eb8c6a

…untime into fake_backends

Fixed integration tests

e1166f8

Merge branch 'main' into fake_backends

d851705

Added channel to constructor of FakeRuntimeService

3d150f1

Merge branch 'fake_backends' of github.com:merav-aharoni/qiskit-ibm-r…

86f23fd

…untime into fake_backends

merav-aharoni requested review from kt474 and jyu00 December 7, 2023 14:27

merav-aharoni and others added 2 commits December 7, 2023 19:22

Merge branch 'main' into fake_backends

343a0e5

Merge branch 'main' into fake_backends

0d28bf4

ElePT reviewed Dec 8, 2023

View reviewed changes

kt474 reviewed Dec 8, 2023

View reviewed changes

kt474 reviewed Dec 9, 2023

View reviewed changes

Merge branch 'main' into fake_backends

be47496

jyu00 requested changes Dec 12, 2023

View reviewed changes

merav-aharoni added 17 commits December 13, 2023 10:52

Merge branch 'main' into fake_backends

e077401

Added creation_date to FakeRuntimeJob

acfeb20

Merge branch 'fake_backends' of github.com:merav-aharoni/qiskit-ibm-r…

c5ca5fc

…untime into fake_backends

Added creation_date and tags to FakeRuntimeJob

afa0c1a

black

af5fcef

Added docstring. Removed comments that contained questions

ea59600

Added support for FakeBackendV2 also when given as an object, not onl…

22773c5

…y name.

mypy

97a6868

Added checks on importing Aer

606c902

When backend is FakeBackendV2, don't modify resilience and optimizati…

6b8d07f

…on levels as for other simulators

Added test for backend.run() on simulator

8830e76

Merge branch 'main' into fake_backends

9bbac3d

Merge branch 'main' into fake_backends

d3e030b

Merged with main after transfer of FakeBackendV2 to here

e4422a9

black

5171d7e

lint

74ed194

Fixed path in base_primitive

3a90e02

kt474 closed this Mar 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support local execution on simulators #1243

Support local execution on simulators #1243

merav-aharoni commented Nov 29, 2023 •

edited

Loading

merav-aharoni commented Nov 29, 2023 •

edited

Loading

kt474 commented Dec 5, 2023

merav-aharoni commented Dec 7, 2023

ElePT Dec 8, 2023 •

edited

Loading

ElePT Dec 8, 2023

ElePT Dec 8, 2023

kt474 Dec 8, 2023

merav-aharoni Dec 13, 2023

kt474 Dec 9, 2023

kt474 Dec 9, 2023

merav-aharoni Dec 13, 2023

jyu00 Dec 12, 2023

merav-aharoni Dec 13, 2023

jyu00 Dec 12, 2023

merav-aharoni Dec 13, 2023

jyu00 Dec 12, 2023

merav-aharoni Dec 14, 2023

jyu00 Dec 12, 2023

merav-aharoni Dec 13, 2023

jyu00 Dec 12, 2023

merav-aharoni Dec 14, 2023

jyu00 Dec 12, 2023

merav-aharoni Dec 14, 2023

jyu00 Dec 19, 2023

merav-aharoni Dec 20, 2023

kt474 Dec 20, 2023

merav-aharoni Dec 27, 2023

kt474 commented Mar 20, 2024

		@@ -12,6 +12,7 @@

		"""Utility functions for options."""

		from qiskit.providers.fake_provider import fake_backend

Support local execution on simulators #1243

Support local execution on simulators #1243

Conversation

merav-aharoni commented Nov 29, 2023 • edited Loading

Summary

Details and comments

merav-aharoni commented Nov 29, 2023 • edited Loading

kt474 commented Dec 5, 2023

merav-aharoni commented Dec 7, 2023

ElePT Dec 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kt474 commented Mar 20, 2024

merav-aharoni commented Nov 29, 2023 •

edited

Loading

merav-aharoni commented Nov 29, 2023 •

edited

Loading

ElePT Dec 8, 2023 •

edited

Loading