IBM

IBMBackendPreferences

Bases: BackendPreferences

Represents the backend preferences specific to IBM Quantum services.

Inherits from BackendPreferences and adds additional fields and validations specific to IBM Quantum backends.

Attributes:

Name	Type	Description
`backend_service_provider`	`IBM_QUANTUM`	Indicates the backend service provider as IBM Quantum.
`access_token`	`Optional[str]`	The IBM Quantum access token to be used with IBM Quantum hosted backends. Defaults to `None`.
`provider`	`IBMBackendProvider`	Specifications for identifying a single IBM Quantum provider. Defaults to a new `IBMBackendProvider`.
`qctrl_api_key`	`Optional[str]`	QCTRL API key to access QCTRL optimization abilities.
`run_through_classiq`	`bool`	Run through Classiq's credentials. Defaults to `False`.

See examples in the IBM Quantum Backend Documentation.

Attributes:

Name	Type	Description
`access_token`	`Optional[str]`
`backend_service_provider`	`IBM_QUANTUM`
`provider`	`IBMBackendProvider`
`qctrl_api_key`	`Optional[str]`
`run_through_classiq`	`bool`

access_token

access_token: Optional[str] = Field(
    default=None,
    description="IBM Quantum access token to be used with IBM Quantum hosted backends",
)

backend_service_provider

backend_service_provider: IBM_QUANTUM = Field(
    default=IBM_QUANTUM
)

provider

provider: IBMBackendProvider = Field(
    default_factory=IBMBackendProvider,
    description="Provider specs. for identifying a single IBM Quantum provider.",
)

qctrl_api_key

qctrl_api_key: Optional[str] = Field(
    default=None,
    description="QCTRL API key to access QCTRL optimization abilities",
)

run_through_classiq

run_through_classiq: bool = Field(
    default=False,
    description="Run through Classiq's credentials",
)

IBMBackendProvider

Bases: BaseModel

Represents the provider specs for identifying an IBM Quantum backend.

Attributes:

Name	Type	Description
`hub`	`str`	hub parameter of IBM Quantum provider. Defaults to `"ibm-q"`.
`group`	`str`	group parameter of IBM Quantum provider. Defaults to `"open"`.
`project`	`str`	project parameter of IBM Quantum provider. Defaults to `"main"`.

Attributes:

Name	Type	Description
`group`	`str`
`hub`	`str`
`project`	`str`

group

group: str = 'open'

hub

hub: str = 'ibm-q'

project

project: str = 'main'