braket.device_schema.device_service_properties_v1 module

class braket.device_schema.device_service_properties_v1.DeviceCost[source]

Bases: pydantic.main.BaseModel

This class provides the details on the cost of a device.

price

Price of the device in terms of US dollars

unit

unit for charging the price, eg: minute, hour, task [price per task]

Examples

>>> import json
>>> input_json = {
...     "price": 0.25,
...     "unit": "minute"
... }
>>> DeviceCost.parse_raw(json.dumps(input_json))

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

price: float = None
unit: str = None
class braket.device_schema.device_service_properties_v1.DeviceDocumentation[source]

Bases: pydantic.main.BaseModel

This class provides the device documentations like image, summary of it and external documentation.

imageUrl

url for the image of the device

summary

brief description on the device

externalDocumentationUrl

link to provide any useful information to the users.

Examples

>>> import json
>>> input_json = {
...     "imageUrl": "image_url",
...     "summary": "Summary on the device",
...     "externalDocumentationUrl": "exter doc link",
... }
>>> DeviceDocumentation.parse_raw(json.dumps(input_json))

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

imageUrl: Optional[str] = None
summary: Optional[str] = None
externalDocumentationUrl: Optional[str] = None
class braket.device_schema.device_service_properties_v1.DeviceServiceProperties[source]

Bases: braket.schema_common.schema_base.BraketSchemaBase

This class defines the common service properties for each device.

executionWindows

List of the executionWindows, it tells us which days the device can execute a task.

shotsRange

range of the shots for a given device.

Examples

>>> import json
>>> input_json = {
...    "braketSchemaHeader": {
...        "name": "braket.device_schema.device_service_properties",
...        "version": "1",
...    },
...    "executionWindows": [
...        {
...            "executionDay": "Everyday",
...            "windowStartHour": "1966280412345.6789",
...            "windowEndHour": "1966280414345.6789",
...        }
...    ],
...    "shotsRange": [1,10],
...    "deviceCost": {
...        "price": 0.25,
...        "unit": "minute"
...    },
...    "deviceDocumentation": {
...        "imageUrl": "image_url",
...        "summary": "Summary on the device",
...        "externalDocumentationUrl": "exter doc link",
...    },
...    "deviceLocation": "us-east-1"
... }
>>> DeviceServiceProperties.parse_raw_schema(json.dumps(input_json))

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

braketSchemaHeader: BraketSchemaHeader = None
executionWindows: List[DeviceExecutionWindow] = None
shotsRange: Tuple[int, int] = None
deviceCost: Optional[DeviceCost] = None
deviceDocumentation: Optional[DeviceDocumentation] = None
deviceLocation: Optional[str] = None