Skip to content

Remove unused backend code #38

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
rathishcholarajan merged 2 commits into from
Nov 30, 2021
Merged

Remove unused backend code #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c535e05
remove unused backend code
jyu00 Nov 29, 2021
500a15a
Merge branch 'main' into more-cleanup
rathishcholarajan Nov 30, 2021
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
1 change: 0 additions & 1 deletion qiskit_ibm_runtime/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,6 @@ def interim_result_callback(job_id, interim_result):
from qiskit.providers import BaseBackend, Backend # type: ignore[attr-defined]

from .ibm_backend import IBMBackend
from .backendjoblimit import BackendJobLimit
from .exceptions import *
from .utils.utils import setup_logger
from .runner_result import RunnerResult
Expand Down
62 changes: 0 additions & 62 deletions qiskit_ibm_runtime/apiconstants.py
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions qiskit_ibm_runtime/backendjoblimit.py
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions qiskit_ibm_runtime/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

from qiskit.providers.jobstatus import JobStatus

QISKIT_IBM_RUNTIME_API_URL = "https://auth.quantum-computing.ibm.com/api"


API_TO_JOB_STATUS = {
"QUEUED": JobStatus.QUEUED,
Expand Down
6 changes: 0 additions & 6 deletions qiskit_ibm_runtime/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,6 @@ class IBMBackendValueError(IBMBackendError, ValueError):
pass


class IBMBackendJobLimitError(IBMBackendError):
"""Errors raised when job limit is reached."""

pass


class IBMInputValueError(IBMError):
"""Error raised due to invalid input value."""

Expand Down
190 changes: 5 additions & 185 deletions qiskit_ibm_runtime/ibm_backend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,10 @@
"""Module for interfacing with an IBM Quantum Backend."""

import logging
import warnings

from typing import List, Union, Optional, Any
from datetime import datetime as python_datetime

from qiskit.circuit import QuantumCircuit, Delay
from qiskit.circuit.duration import duration_in_dt
from qiskit.pulse import Schedule
from qiskit.qobj.utils import MeasLevel, MeasReturnType
from qiskit.providers.backend import BackendV1 as Backend
from qiskit.providers.options import Options
Expand All @@ -36,10 +32,9 @@
from qiskit_ibm_runtime import ibm_runtime_service

from .api.clients import AccountClient
from .backendjoblimit import BackendJobLimit
from .backendreservation import BackendReservation
from .credentials import Credentials
from .exceptions import IBMBackendApiProtocolError, IBMBackendError
from .exceptions import IBMBackendApiProtocolError
from .utils.converters import utc_to_local_all, local_to_utc
from .utils.json_decoder import decode_pulse_defaults, decode_backend_properties
from .utils.backend import convert_reservation_data
Expand All @@ -65,12 +60,6 @@ class IBMBackend(Backend):
status = backend.status()
is_operational = status.operational
jobs_in_queue = status.pending_jobs

It is also possible to see the number of remaining jobs you are able to submit to the
backend with the :meth:`job_limit()` method, which returns a
:class:`BackendJobLimit<qiskit_ibm_runtime.BackendJobLimit>` instance::

job_limit = backend.job_limit()
"""

id_warning_issued = False
Expand Down Expand Up @@ -222,78 +211,6 @@ def defaults(self, refresh: bool = False) -> Optional[PulseDefaults]:

return self._defaults

def job_limit(self) -> BackendJobLimit:
"""Return the job limit for the backend.

The job limit information includes the current number of active jobs
you have on the backend and the maximum number of active jobs you can have
on it.

Note:
Job limit information for a backend is provider specific.
For example, if you have access to the same backend via
different providers, the job limit information might be
different for each provider.

If the method call was successful, you can inspect the job limit for
the backend by accessing the ``maximum_jobs`` and ``active_jobs`` attributes
of the :class:`BackendJobLimit<BackendJobLimit>` instance returned. For example::

backend_job_limit = backend.job_limit()
maximum_jobs = backend_job_limit.maximum_jobs
active_jobs = backend_job_limit.active_jobs

If ``maximum_jobs`` is equal to ``None``, then there is
no limit to the maximum number of active jobs you could
have on the backend.

Returns:
The job limit for the backend, with this provider.

Raises:
IBMBackendApiProtocolError: If an unexpected value is received from the server.
"""
api_job_limit = self._api_client.backend_job_limit(self.name())

try:
job_limit = BackendJobLimit(**api_job_limit)
if job_limit.maximum_jobs == -1:
# Manually set `maximum` to `None` if backend has no job limit.
job_limit.maximum_jobs = None
return job_limit
except TypeError as ex:
raise IBMBackendApiProtocolError(
"Unexpected return value received from the server when "
"querying job limit data for the backend: {}.".format(ex)
) from ex

def remaining_jobs_count(self) -> Optional[int]:
"""Return the number of remaining jobs that could be submitted to the backend.

Note:
The number of remaining jobs for a backend is provider
specific. For example, if you have access to the same backend
via different providers, the number of remaining jobs might
be different for each. See :class:`BackendJobLimit<BackendJobLimit>`
for the job limit information of a backend.

If ``None`` is returned, there are no limits to the maximum
number of active jobs you could have on the backend.

Returns:
The remaining number of jobs a user could submit to the backend, with
this provider, before the maximum limit on active jobs is reached.

Raises:
IBMBackendApiProtocolError: If an unexpected value is received from the server.
"""
job_limit = self.job_limit()

if job_limit.maximum_jobs is None:
return None

return job_limit.maximum_jobs - job_limit.active_jobs

def reservations(
self,
start_datetime: Optional[python_datetime] = None,
Expand Down Expand Up @@ -341,89 +258,12 @@ def configuration(
def __repr__(self) -> str:
return "<{}('{}')>".format(self.__class__.__name__, self.name())

def _deprecate_id_instruction(
self,
circuits: Union[
QuantumCircuit, Schedule, List[Union[QuantumCircuit, Schedule]]
],
) -> None:
"""Raise a DeprecationWarning if any circuit contains an 'id' instruction.

Additionally, if 'delay' is a 'supported_instruction', replace each 'id'
instruction (in-place) with the equivalent ('sx'-length) 'delay' instruction.

Args:
circuits: The individual or list of :class:`~qiskit.circuits.QuantumCircuit` or
:class:`~qiskit.pulse.Schedule` objects passed to
:meth:`IBMBackend.run()<IBMBackend.run>`. Modified in-place.

Returns:
None
"""

id_support = "id" in getattr(self.configuration(), "basis_gates", [])
delay_support = "delay" in getattr(
self.configuration(), "supported_instructions", []
)

if not delay_support:
return

if not isinstance(circuits, List):
circuits = [circuits]

circuit_has_id = any(
instr.name == "id"
for circuit in circuits
if isinstance(circuit, QuantumCircuit)
for instr, qargs, cargs in circuit.data
)

if not circuit_has_id:
return

if not self.id_warning_issued:
if id_support and delay_support:
warnings.warn(
"Support for the 'id' instruction has been deprecated "
"from IBM hardware backends. Any 'id' instructions "
"will be replaced with their equivalent 'delay' instruction. "
"Please use the 'delay' instruction instead.",
DeprecationWarning,
stacklevel=4,
)
else:
warnings.warn(
"Support for the 'id' instruction has been removed "
"from IBM hardware backends. Any 'id' instructions "
"will be replaced with their equivalent 'delay' instruction. "
"Please use the 'delay' instruction instead.",
DeprecationWarning,
stacklevel=4,
)

self.id_warning_issued = True

dt_in_s = self.configuration().dt

for circuit in circuits:
if isinstance(circuit, Schedule):
continue

for idx, (instr, qargs, cargs) in enumerate(circuit.data):
if instr.name == "id":

sx_duration = self.properties().gate_length("sx", qargs[0].index)
sx_duration_in_dt = duration_in_dt(sx_duration, dt_in_s)

delay_instr = Delay(sx_duration_in_dt)

circuit.data[idx] = (delay_instr, qargs, cargs)

def run(self, *args: Any, **kwargs: Any) -> None:
"""Run on the backend"""
"""Not supported method"""
# pylint: disable=arguments-differ
pass
raise RuntimeError(
"IBMBackend.run() is not supported in the Qiskit Runtime environment."
)


class IBMSimulator(IBMBackend):
Expand All @@ -442,11 +282,6 @@ def properties(
"""Return ``None``, simulators do not have backend properties."""
return None

def run(self, *args: Any, **kwargs: Any) -> None:
"""Run on the backend"""
# pylint: disable=arguments-differ
pass


class IBMRetiredBackend(IBMBackend):
"""Backend class interfacing with an IBM Quantum device no longer available."""
Expand Down Expand Up @@ -494,28 +329,13 @@ def status(self) -> BackendStatus:
"""Return the backend status."""
return self._status

def job_limit(self) -> None:
"""Return the job limits for the backend."""
return None

def remaining_jobs_count(self) -> None:
"""Return the number of remaining jobs that could be submitted to the backend."""
return None

def reservations(
self,
start_datetime: Optional[python_datetime] = None,
end_datetime: Optional[python_datetime] = None,
) -> List[BackendReservation]:
return []

def run(self, *args: Any, **kwargs: Any) -> None: # type: ignore[override]
"""Run a Circuit."""
# pylint: disable=arguments-differ
raise IBMBackendError(
"This backend ({}) is no longer available.".format(self.name())
)

@classmethod
def from_name(
cls,
Expand Down
Loading