class PulseBackendConfigurationSchema(QasmBackendConfigurationSchema):
"""Schema for pulse backend"""
# Required properties.
open_pulse = Boolean(required=True, validate=OneOf([True]))
n_uchannels = Integer(required=True, validate=Range(min=0))
u_channel_lo = List(
Nested(UchannelLOSchema,
validate=Length(min=1),
required=True,
many=True))
meas_levels = List(Integer(), validate=Length(min=1), required=True)
qubit_lo_range = List(List(Float(validate=Range(min=0)),
validate=Length(equal=2)),
required=True)
meas_lo_range = List(List(Float(validate=Range(min=0)),
validate=Length(equal=2)),
required=True)
dt = Float(required=True, validate=Range(min=0)) # pylint: disable=invalid-name
dtm = Float(required=True, validate=Range(min=0))
rep_times = List(Float(validate=Range(min=0)), required=True)
meas_kernels = List(String(), required=True)
discriminators = List(String(), required=True)
# Optional properties.
meas_map = List(List(Integer(), validate=Length(min=1)))
channel_bandwidth = List(List(Float(), validate=Length(equal=2)))
acquisition_latency = List(List(Integer()))
conditional_latency = List(List(Integer()))
hamiltonian = PulseHamiltonianSchema()
class QasmQobjInstructionSchema(QobjInstructionSchema):
"""Schema for QasmQobjInstruction."""
# Optional properties.
qubits = List(Integer(validate=Range(min=0)), validate=Length(min=1))
params = List(InstructionParameter())
memory = List(Integer(validate=Range(min=0)), validate=Length(min=1))
conditional = Integer(validate=Range(min=0))
class QobjExperimentConfigSchema(BaseSchema):
"""Schema for QobjExperimentConfig."""
# Required properties.
# Optional properties.
memory_slots = Integer(validate=Range(min=0))
n_qubits = Integer(validate=Range(min=1))
class QobjConfigSchema(BaseSchema):
"""Base Schema for QobjConfig."""
# Optional properties.
max_credits = Integer()
seed_simulator = Integer()
memory_slots = Integer(validate=Range(min=0))
shots = Integer(validate=Range(min=1))
class PulseHamiltonianSchema(BaseSchema):
"""Schema for PulseHamiltonian."""
# Required properties.
h_str = List(String(), validate=Length(min=1), required=True)
dim_osc = List(Integer(validate=Range(min=1)), required=True)
dim_qub = List(Integer(validate=Range(min=2)), required=True)
vars = Dict(validate=PatternProperties(
{Regexp('^([a-z0-9])+$'): InstructionParameter()}),
required=True)
class QobjConfigSchema(BaseSchema):
"""Schema for QobjConfig."""
# Required properties.
# Optional properties.
max_credits = Integer()
seed = Integer()
memory_slots = Integer(validate=Range(min=0))
n_qubits = Integer(validate=Range(min=1))
shots = Integer(validate=Range(min=1))
class RunConfigSchema(BaseSchema):
"""Schema for RunConfig."""
# Required properties.
# None
# Optional properties.
shots = Integer(validate=Range(min=1))
max_credits = Integer(validate=Range(
min=3, max=10)) # TODO: can we check the range
seed = Integer()
memory = Boolean() # set default to be False
class QobjInstructionSchema(BaseSchema):
"""Schema for QobjInstruction."""
# Required properties.
name = String(required=True)
# Optional properties.
qubits = List(Integer(validate=Range(min=0)),
validate=Length(min=1))
params = List(InstructionParameter())
memory = List(Integer(validate=Range(min=0)),
validate=Length(min=1))
conditional = Nested(QobjConditionalSchema)
class PulseQobjConfigSchema(QobjConfigSchema):
"""Schema for PulseQobjConfig."""
# Required properties.
# TODO : check if they are always required by backend
meas_level = Integer(required=True, validate=Range(min=0, max=2))
memory_slot_size = Integer(required=True)
pulse_library = Nested(QobjPulseLibrarySchema, many=True, required=True)
qubit_lo_freq = List(Number(), required=True)
meas_lo_freq = List(Number(), required=True)
rep_time = Integer(required=True)
meas_return = String(validate=OneOf(choices=(MeasReturnType.AVERAGE,
MeasReturnType.SINGLE)))
class PulseQobjConfigSchema(QobjConfigSchema):
"""Schema for PulseQobjConfig of device backend."""
# Required properties.
meas_level = Integer(required=True, validate=Range(min=0, max=2))
meas_return = String(required=True, validate=OneOf(choices=(MeasReturnType.AVERAGE,
MeasReturnType.SINGLE)))
pulse_library = Nested(PulseLibraryItemSchema, required=True, many=True)
qubit_lo_freq = List(Number(validate=Range(min=0)), required=True)
meas_lo_freq = List(Number(validate=Range(min=0)), required=True)
# Optional properties.
memory_slot_size = Integer(validate=Range(min=1))
rep_time = Integer(validate=Range(min=0))
class BackendJobLimitResponseSchema(BaseSchema):
"""Schema for BackendJobLimit"""
# Optional properties
maximum_jobs = Integer(required=True)
running_jobs = Integer(required=True)
@pre_load
def preprocess_field_names(self, data, **_): # type: ignore
"""Pre-process the jobs limit response fields."""
FIELDS_MAP = { # pylint: disable=invalid-name
'maximumJobs': 'maximum_jobs',
'runningJobs': 'running_jobs'
}
return map_field_names(FIELDS_MAP, data)
class GateConfigSchema(BaseSchema):
"""Schema for GateConfig."""
# Required properties.
name = String(required=True)
parameters = List(String(), required=True)
qasm_def = String(required=True)
# Optional properties.
coupling_map = List(List(Integer(), validate=Length(min=1)),
validate=Length(min=1))
latency_map = List(List(Integer(validate=OneOf([0, 1])),
validate=Length(min=1)),
validate=Length(min=1))
conditional = Boolean()
description = String()
class JobResponseSchema(BaseSchema):
"""Schema for IBMQJob.
Schema for an `IBMQJob`. The following conventions are in use in order to
provide enough flexibility in regards to attributes:
* the "Required properties" reflect attributes that will always be present
in the model.
* the "Optional properties with a default value" reflect attributes that
are always present in the model, but might contain uninitialized values
depending on the state of the job.
* some properties are prepended by underscore due to name clashes and extra
constraints in the IBMQJob class (for example, existing IBMQJob methods
that have the same name as a response field).
The schema is used for GET Jobs, GET Jobs/{id}, and POST Jobs responses.
"""
# pylint: disable=invalid-name
# Required properties.
_creation_date = DateTime(required=True)
kind = Enum(required=True, enum_cls=ApiJobKind)
_job_id = String(required=True)
_api_status = Enum(required=True, enum_cls=ApiJobStatus)
# Optional properties with a default value.
_name = String(missing=None)
shots = Integer(validate=Range(min=0), missing=None)
_time_per_step = Dict(keys=String, values=String, missing=None)
_result = Nested(ResultSchema, missing=None)
_qobj = Nested(QobjSchema, missing=None)
_error = Nested(JobResponseErrorSchema, missing=None)
# Optional properties
_backend_info = Nested(JobResponseBackendSchema)
allow_object_storage = Boolean()
error = String()
@pre_load
def preprocess_field_names(self, data, **_): # type: ignore
"""Pre-process the job response fields.
Rename selected fields of the job response due to name clashes, and
convert from camel-case the rest of the fields.
TODO: when updating to terra 0.10, check if changes related to
marshmallow 3 allow to use directly `data_key`, as in 0.9 terra
duplicates the unknown keys.
"""
rename_map = {}
for field_name in data:
if field_name in FIELDS_MAP:
rename_map[field_name] = FIELDS_MAP[field_name]
else:
rename_map[field_name] = to_python_identifier(field_name)
for old_name, new_name in rename_map.items():
data[new_name] = data.pop(old_name)
return data
class ExperimentResultSchema(BaseSchema):
"""Schema for ExperimentResult."""
# Required fields.
shots = ByType([
Integer(),
List(Integer(validate=Range(min=1)), validate=Length(equal=2))
],
required=True)
success = Boolean(required=True)
data = Nested(ExperimentResultDataSchema, required=True)
# Optional fields.
status = String()
seed = Integer()
meas_return = String(validate=OneOf(['single', 'avg']))
header = Nested(ObjSchema)
class ExperimentResultSchema(BaseSchema):
"""Schema for ExperimentResult."""
# Required fields.
shots = ByType([Integer(), List(Integer(validate=Range(min=1)),
validate=Length(equal=2))],
required=True)
success = Boolean(required=True)
data = Nested(ExperimentResultDataSchema, required=True)
# Optional fields.
status = String()
seed = Integer()
meas_level = Integer(validate=Range(min=0, max=2))
meas_return = String(validate=OneOf(choices=(MeasReturnType.AVERAGE,
MeasReturnType.SINGLE)))
header = Nested(ObjSchema)
class CommandSchema(BaseSchema):
"""Schema for Command."""
# Required properties.
name = String(required=True)
# Optional properties.
qubits = List(Integer(validate=Range(min=0)), validate=Length(min=1))
sequence = Nested(PulseQobjInstructionSchema, many=True)
class GateSchema(BaseSchema):
"""Schema for Gate."""
# Required properties.
qubits = List(Integer(), required=True, validate=Length(min=1))
gate = String(required=True)
parameters = Nested(NduvSchema,
required=True,
many=True,
validate=Length(min=1))
class BackendStatusSchema(BaseSchema):
"""Schema for BackendStatus."""
# Required properties.
backend_name = String(required=True)
backend_version = String(required=True,
validate=Regexp("[0-9]+.[0-9]+.[0-9]+$"))
operational = Boolean(required=True)
pending_jobs = Integer(required=True, validate=Range(min=0))
status_msg = String(required=True)
class ExperimentResultDataSchema(BaseSchema):
"""Schema for ExperimentResultData."""
counts = Nested(ObjSchema,
validate=PatternProperties(
{Regexp('^0x([0-9A-Fa-f])+$'): Integer()}))
snapshots = Nested(ObjSchema)
memory = List(Raw(), validate=Length(min=1))
statevector = List(Complex(), validate=Length(min=1))
unitary = List(List(Complex(), validate=Length(min=1)),
validate=Length(min=1))
class BackendConfigurationSchema(BaseSchema):
"""Schema for BackendConfiguration."""
# Required properties.
backend_name = String(required=True)
backend_version = String(required=True,
validate=Regexp("[0-9]+.[0-9]+.[0-9]+$"))
n_qubits = Integer(required=True, validate=Range(min=1))
basis_gates = List(String(), required=True, validate=Length(min=1))
gates = Nested(GateConfigSchema,
required=True,
many=True,
validate=Length(min=1))
local = Boolean(required=True)
simulator = Boolean(required=True)
conditional = Boolean(required=True)
memory = Boolean(required=True)
max_shots = Integer(required=True, validate=Range(min=1))
open_pulse = Boolean(required=True)
# Optional properties.
max_experiments = Integer(validate=Range(min=1))
sample_name = String()
coupling_map = List(List(Integer(), validate=Length(min=1)),
validate=Length(min=1),
allow_none=True)
n_registers = Integer(validate=Range(min=1))
register_map = List(List(Integer(validate=OneOf([0, 1])),
validate=Length(min=1)),
validate=Length(min=1))
configurable = Boolean()
credits_required = Boolean()
online_date = DateTime()
display_name = String()
description = String()
tags = List(String())
class PulseDefaultsSchema(BaseSchema):
"""Schema for PulseDefaults."""
# Required properties.
qubit_freq_est = List(Number(), required=True, validate=Length(min=1))
meas_freq_est = List(Number(), required=True, validate=Length(min=1))
buffer = Integer(required=True, validate=Range(min=0))
pulse_library = Nested(PulseLibraryItemSchema, required=True, many=True)
cmd_def = Nested(CommandSchema, many=True, required=True)
# Optional properties.
meas_kernel = Nested(MeasurementKernelSchema)
discriminator = Nested(DiscriminatorSchema)
class InfoQueueResponseSchema(BaseSchema):
"""Queue information schema, nested in StatusResponseSchema"""
# Optional properties
position = Integer(required=False, missing=None)
_status = String(required=False, missing=None)
estimated_start_time = DateTime(required=False, missing=None)
estimated_complete_time = DateTime(required=False, missing=None)
hub_priority = Float(required=False, missing=None)
group_priority = Float(required=False, missing=None)
project_priority = Float(required=False, missing=None)
@pre_load
def preprocess_field_names(self, data, **_): # type: ignore
"""Pre-process the info queue response fields."""
FIELDS_MAP = { # pylint: disable=invalid-name
'status': '_status',
'estimatedStartTime': 'estimated_start_time',
'estimatedCompleteTime': 'estimated_complete_time',
'hubPriority': 'hub_priority',
'groupPriority': 'group_priority',
'projectPriority': 'project_priority'
}
return map_field_names(FIELDS_MAP, data)
class PulseQobjInstructionSchema(QobjInstructionSchema):
"""Schema for PulseQobjInstruction."""
# pylint: disable=invalid-name
# Required properties
t0 = Integer(required=True, validate=Range(min=0))
# Optional properties.
ch = String(validate=Regexp('[dum]([0-9])+'))
conditional = Integer(validate=Range(min=0))
val = ByType([Complex(), String()])
phase = ByType([Float(), String()])
duration = Integer(validate=Range(min=1))
qubits = List(Integer(validate=Range(min=0)), validate=Length(min=1))
memory_slot = List(Integer(validate=Range(min=0)), validate=Length(min=1))
register_slot = List(Integer(validate=Range(min=0)), validate=Length(min=1))
kernels = Nested(QobjMeasurementOptionSchema, many=True)
discriminators = Nested(QobjMeasurementOptionSchema, many=True)
label = String()
type = String()
class JobResponseErrorSchema(BaseSchema):
"""Nested schema for the error field in JobResponseSchema."""
# Required properties
code = Integer(required=True)
message = String(required=True)
class UchannelLOSchema(BaseSchema):
"""Schema for uchannel LO."""
# Required properties.
q = Integer(required=True, validate=Range(min=0))
scale = Complex(required=True)
class InfoQueueResponseSchema(BaseSchema):
"""Nested schema for StatusResponseSchema"""
# Optional properties
position = Integer(required=False, missing=0)
status = String(required=False)
class QasmQobjConfigSchema(QobjConfigSchema):
"""Schema for QasmQobjConfig."""
# Optional properties.
n_qubits = Integer(validate=Range(min=1))
class QasmQobjExperimentConfigSchema(QobjExperimentConfigSchema):
"""Schema for QasmQobjExperimentConfig."""
# Optional properties.
memory_slots = Integer(validate=Range(min=0))
n_qubits = Integer(validate=Range(min=1))