Skip to content

Hot fix for Session creation #321

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

Merged
MoritzWillmann merged 7 commits into from
Apr 7, 2025
Merged

Hot fix for Session creation #321

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7aca8c4
fix input arguments in Session creation
David-Kreplin Mar 24, 2025
246df74
black
David-Kreplin Mar 24, 2025
c5abe81
Merge branch 'develop' into fix_session
MoritzWillmann Mar 25, 2025
f1f9070
removed service
David-Kreplin Apr 7, 2025
07ee94f
removed service from the executor
David-Kreplin Apr 7, 2025
bddd795
merge
David-Kreplin Apr 7, 2025
57a06bd
Merge branch 'develop' into fix_session
David-Kreplin Apr 7, 2025
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
121 changes: 34 additions & 87 deletions src/squlearn/util/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,15 +215,14 @@ class Executor:
* A Qiskit backend, to run the jobs on IBM Quantum systems or simulators
* A list of Qiskit backends for automatic backend selection later on
* A QiskitRuntimeService, to run the jobs on the Qiskit Runtime service.
In this case the backend has to be provided separately via ``backend=``
In this case the backends are automatically selected based on the
available backends of the service, similar to providing a list of backends.
* A Session, to run the jobs on the Qiskit Runtime service
* A Estimator primitive (either simulator or Qiskit Runtime primitive - V1 or V2)
* A Sampler primitive (either simulator or Qiskit Runtime primitive - V1 or V2)

Default is the initialization with PennyLane's
:class:`DefaultQubit <pennylane.devices.default_qubit.DefaultQubit>` simulator.
backend (Union[Backend, str, None]): The backend that is used for the execution.
Only mandatory if a service is provided.
options_estimator (Union[Any]): The options for the created estimator primitives.
options_sampler (Union[Any]): The options for the created sampler primitives.
log_file (str): The name of the log file, if empty, no log file is created.
Expand Down Expand Up @@ -260,7 +259,6 @@ class Executor:
is_statevector (Bool): Returns true if the backend is a statevector simulator.
qpu_parallelization (Bool): Returns true if QPU parallelization is used.
session (Session): The session that is used in the Executor.
service (QiskitRuntimeService): The service that is used in the Executor.
quantum_framework (str): The framework used in the Executor (``"qiskit"`` or
``"pennylane"``).
IBMQuantum (bool): Whether the backend is an IBM Quantum backend.
Expand Down Expand Up @@ -413,7 +411,6 @@ def __init__(
BaseSamplerV2,
PennylaneDevice,
] = "pennylane",
backend: Union[Backend, str, None] = None,
options_estimator: Union[Any, None] = None,
options_sampler: Union[Any, None] = None,
log_file: str = "",
Expand All @@ -430,7 +427,6 @@ def __init__(
# Default values for internal variables
self._backend = None
self._session = None
self._service = None
self._estimator = None
self._sampler = None
self._execution_origin = ""
Expand Down Expand Up @@ -552,8 +548,6 @@ def __init__(

elif isinstance(execution, Backend):
# Execution is a backend class
if hasattr(execution, "service"):
self._service = execution.service
self._backend = execution
self._execution_origin = "Backend"
if shots is None:
Expand All @@ -567,25 +561,11 @@ def __init__(
self._backend = None
self._backend_list = execution
self._execution_origin = "BackendList"
# Execution is a backend class
if hasattr(execution[0], "service"):
self._service = execution[0].service
else:
raise ValueError("Only list of backends are supported!")
elif isinstance(execution, QiskitRuntimeService):
self._service = execution
if isinstance(backend, str):
self._backend = self._service.backend(backend)
elif isinstance(backend, Backend):
self._backend = backend
elif isinstance(backend, list):
self._backend_list = backend
self._backend = None
elif backend is None:
self._backend = None
self._backend_list = self._service.backends()
else:
raise ValueError("Unknown backend type: " + backend)
self._backend = None
self._backend_list = execution.backends()
if shots is None and self._backend is not None:
shots = self._backend.options.shots
if self.is_statevector:
Expand All @@ -594,8 +574,7 @@ def __init__(
elif isinstance(execution, Session):
# Execution is a active? session
self._session = execution
self._service = self._session.service
self._backend = self._session.service.backend(self._session.backend())
self._backend = self._session.service.get_backend(self._session.backend())
self._execution_origin = "Session"
if shots is None:
shots = self._backend.options.shots
Expand All @@ -619,7 +598,6 @@ def __init__(
# Real Backend
elif isinstance(self._estimator, RuntimeEstimatorV1):
self._session = self._estimator._session
self._service = self._estimator._service
self._backend = self._estimator._backend
# TODO: check if this is duplicate
if not shots:
Expand Down Expand Up @@ -649,7 +627,6 @@ def __init__(
shots = shots_sampler
elif isinstance(self._sampler, RuntimeSamplerV1):
self._session = self._sampler._session
self._service = self._sampler._service
self._backend = self._sampler._backend
# TODO: check if this is duplicate
if not shots:
Expand Down Expand Up @@ -683,7 +660,6 @@ def __init__(
self._session = self._estimator._session
elif hasattr(self._estimator, "_mode"):
self._session = self._estimator._mode
self._service = self._estimator._service
self._backend = self._estimator._backend
if shots is None:
if self._estimator.options.default_shots:
Expand Down Expand Up @@ -716,7 +692,6 @@ def __init__(
self._session = self._sampler._session
elif hasattr(self._sampler, "_mode"):
self._session = self._sampler._mode
self._service = self._sampler._service
self._backend = self._sampler._backend
if shots is None:
if self._sampler.options.default_shots:
Expand Down Expand Up @@ -808,8 +783,6 @@ def __init__(
self._logger.info(
f"Executor initialized with backend list: {{}}".format(self._backend_list)
)
if self._service is not None:
self._logger.info(f"Executor initialized with service: {{}}".format(self._service))
if self._session is not None:
self._logger.info(
f"Executor initialized with session: {{}}".format(self._session.session_id)
Expand Down Expand Up @@ -1052,11 +1025,6 @@ def session(self) -> Session:
"""Returns the session that is used in the executor."""
return self._session

@property
def service(self) -> QiskitRuntimeService:
"""Returns the service that is used in the executor."""
return self._service

def _estimator_v1(self) -> BaseEstimatorV1:
"""Returns the Estimator V1 primitive that is used for the execution.

Expand Down Expand Up @@ -1089,25 +1057,22 @@ def _estimator_v1(self) -> BaseEstimatorV1:
self._estimator = RuntimeEstimatorV1(
session=self._session, options=self._options_estimator
)
elif self._service is not None:
# No session but service -> create a new session
else:
# No session -> create a new session
self.create_session()
self._estimator = RuntimeEstimatorV1(
session=self._session, options=self._options_estimator
)
else:
raise RuntimeError(
"Missing Qiskit Runtime service for Estimator initialization!"
)

else:
if self.is_statevector:
# No session, no service, but state_vector simulator -> Estimator
# No session, but state_vector simulator -> Estimator
self._estimator = PrimitiveEstimatorV1(options=self._options_estimator)
self._estimator.set_options(shots=self._shots)
elif self._backend is None:
raise RuntimeError("Backend missing for Estimator initialization!")
else:
# No session, no service and no state_vector simulator -> BackendEstimator
# No session and no state_vector simulator -> BackendEstimator
self._estimator = BackendEstimatorV1(
backend=self._backend, options=self._options_estimator
)
Expand Down Expand Up @@ -1190,8 +1155,8 @@ def _estimator_v2(self) -> BaseEstimatorV2:
self._estimator = RuntimeEstimatorV2(
mode=self._session, options=self._options_estimator
)
elif self._service is not None:
# No session but service -> create a new session
else:
# No session -> create a new session
self.create_session()
if QISKIT_RUNTIME_SMALLER_0_23:
self._estimator = RuntimeEstimatorV2(
Expand All @@ -1201,10 +1166,6 @@ def _estimator_v2(self) -> BaseEstimatorV2:
self._estimator = RuntimeEstimatorV2(
mode=self._session, options=self._options_estimator
)
else:
raise RuntimeError(
"Missing Qiskit Runtime service for Estimator initialization!"
)
else:
if "fake" in str(self._backend):
if shots:
Expand All @@ -1221,7 +1182,7 @@ def _estimator_v2(self) -> BaseEstimatorV2:
mode=self._backend, options=self._options_estimator
)
elif self.is_statevector:
# No session, no service, but state_vector simulator -> Estimator
# No session, but state_vector simulator -> Estimator
self._estimator = StatevectorEstimator(
default_precision=1 / shots**0.5 if shots else 0.0
)
Expand All @@ -1233,7 +1194,7 @@ def _estimator_v2(self) -> BaseEstimatorV2:
self._options_estimator = {"default_precision": 1 / shots**0.5}
else:
self._options_estimator["default_precision"] = 1 / shots**0.5
# No session, no service and no state_vector simulator -> BackendEstimator
# No session and no state_vector simulator -> BackendEstimator
self._estimator = BackendEstimatorV2(
backend=self._backend, options=self._options_estimator
)
Expand Down Expand Up @@ -1332,26 +1293,22 @@ def _sampler_v1(self) -> BaseSamplerV1:
session=self._session, options=self._options_sampler
)

elif self._service is not None:
# No session but service -> create a new session
else:
# No session -> create a new session
self.create_session()
self._sampler = RuntimeSamplerV1(
session=self._session,
options=self._options_sampler,
)
else:
raise RuntimeError(
"Missing Qiskit Runtime service for Sampler initialization!"
)
else:
if self.is_statevector:
# No session, no service, but state_vector simulator -> Sampler
# No session, but state_vector simulator -> Sampler
self._sampler = PrimitiveSamplerV1(options=self._options_sampler)
self._sampler.set_options(shots=self._shots)
elif self._backend is None:
raise RuntimeError("Backend missing for Sampler initialization!")
else:
# No session, no service and no state_vector simulator -> BackendSampler
# No session and no state_vector simulator -> BackendSampler
self._sampler = BackendSamplerV1(
backend=self._backend, options=self._options_sampler
)
Expand Down Expand Up @@ -1430,8 +1387,8 @@ def _sampler_v2(self) -> BaseSamplerV2:
mode=self._session, options=self._options_sampler
)

elif self._service is not None:
# No session but service -> create a new session
else:
# No session -> create a new session
self.create_session()
if QISKIT_RUNTIME_SMALLER_0_23:
self._sampler = RuntimeSamplerV2(
Expand All @@ -1443,11 +1400,6 @@ def _sampler_v2(self) -> BaseSamplerV2:
mode=self._session,
options=self._options_sampler,
)

else:
raise RuntimeError(
"Missing Qiskit Runtime service for Sampler initialization!"
)
else:
if "fake" in str(self._backend).lower():
if QISKIT_RUNTIME_SMALLER_0_23:
Expand All @@ -1459,7 +1411,7 @@ def _sampler_v2(self) -> BaseSamplerV2:
mode=self._backend, options=self._options_sampler
)
elif self.is_statevector:
# No session, no service, but state_vector simulator -> Sampler
# No session, but state_vector simulator -> Sampler
if shots:
self._sampler = StatevectorSampler(default_shots=shots)
else:
Expand All @@ -1468,7 +1420,7 @@ def _sampler_v2(self) -> BaseSamplerV2:
elif self._backend is None:
raise RuntimeError("Backend missing for Sampler initialization!")
else:
# No session, no service and no state_vector simulator -> BackendSampler
# No session and no state_vector simulator -> BackendSampler
self._sampler = BackendSamplerV2(
backend=self._backend, options=self._options_sampler
)
Expand Down Expand Up @@ -2348,16 +2300,11 @@ def create_session(self):
if not self.IBMQuantum:
raise RuntimeError("Sessions can only be created for IBM Quantum devices!")

if self._service is not None:
if self._backend is not None:
self._session = Session(
self._service, backend=self._backend, max_time=self._max_session_time
)
else:
raise RuntimeError("Session can not started because of missing backend!")
self._logger.info("Executor created a new session.")
if self._backend is not None:
self._session = Session(backend=self._backend, max_time=self._max_session_time)
else:
raise RuntimeError("Session can not started because of missing service!")
raise RuntimeError("Session can not started because of missing backend!")
self._logger.info("Executor created a new session.")

def close_session(self):
"""Closes the current session, is called automatically."""
Expand Down Expand Up @@ -2621,13 +2568,13 @@ def is_statevector(self) -> bool:

class ExecutorEstimatorV2(BaseEstimatorV2):
"""
Special Estimator V2 Primitive that uses the Executor service.
Special Estimator V2 Primitive that uses the Executor.

Usefull for automatic restarting sessions and caching results.
The object is created by the Executor method get_estimator()

Args:
executor (Executor): The executor service to use
executor (Executor): The executor to use
options: Options for the estimator
"""

Expand Down Expand Up @@ -2668,13 +2615,13 @@ def options(self):

class ExecutorSamplerV2(BaseSamplerV2):
"""
Special Sampler V2 Primitive that uses the Executor service.
Special Sampler V2 Primitive that uses the Executor.

Usefull for automatic restarting sessions and caching results.
The object is created by the Executor method get_sampler()

Args:
executor (Executor): The executor service to use
executor (Executor): The executor to use
"""

def __init__(self, executor: Executor):
Expand Down Expand Up @@ -2712,13 +2659,13 @@ def options(self):

class ExecutorEstimatorV1(BaseEstimatorV1):
"""
Special Estimator V1 Primitive that uses the Executor service.
Special Estimator V1 Primitive that uses the Executor.

Usefull for automatic restarting sessions and caching results.
The object is created by the Executor method get_estimator()

Args:
executor (Executor): The executor service to use
executor (Executor): The executor to use
options: Options for the estimator

"""
Expand Down Expand Up @@ -2837,13 +2784,13 @@ def set_options(self, **fields):

class ExecutorSamplerV1(BaseSamplerV1):
"""
Special Sampler V1 Primitive that uses the Executor service.
Special Sampler V1 Primitive that uses the Executor.

Useful for automatic restarting sessions and caching the results.
The object is created by the executor method get_sampler()

Args:
executor (Executor): The executor service to use
executor (Executor): The executor to use
options: Options for the sampler

"""
Expand Down