ExperimentalCapabilityContext

exception braket.experimental_capabilities.experimental_capability_context.ExperimentalCapabilityContextError

Bases: Exception

Exception raised for errors related to experimental capability contexts.

class braket.experimental_capabilities.experimental_capability_context.GlobalExperimentalCapabilityContext

Bases: object

A global singleton that tracks whether experimental capabilities are enabled.

is_enabled()

Check if experimental capabilities are enabled.

Return type:

bool

Returns:

bool – True if experimental capabilities are enabled, False otherwise.

enable(experimental_capabilities='ALL')

Enable all experimental capabilities. Default behavior is to enable all.

Parameters:

• experimental_capabilities (Literal['ALL'])

• capabilities. (The experimental capabilities to enable. Defaults to all)

Raises:

ExperimentalCapabilityContextError – If the experimental capabilities are not valid.

Return type:

None

disable()

Disable all experimental capabilities.

Return type:

None

get_enabled_capabilities()

Get the set of currently enabled experimental capabilities.

Return type:

Optional[Literal['ALL']]

Returns:

ExperimentalCapabilitiesEnabled | None –

The currently enabled

experimental capabilities.

set_state(experimental_capabilities)

Set the state of experimental capabilities. :param experimental_capabilities: The state of enabled experimental capabilities. :type experimental_capabilities: Optional[Literal['ALL']]

Return type:

None

class braket.experimental_capabilities.experimental_capability_context.EnableExperimentalCapability(experimental_capabilities='ALL')

Bases: object

This context manager temporarily enables experimental capabilities for the duration of a code block, after which the capabilities are returned to their previous states.

Experimental capabilities are those that hardware providers are rapidly developing. As hardware improve and the support on the capabilities are expanded, the behavior may change, including becoming less restrictive, more performant and having higher quality. See the developer guide [1] to learn more about experimental capabilities on Amazon Braket. [1] https://docs.aws.amazon.com/braket/latest/developerguide/ braket-experimental-capabilities.html

Args: experimental_capabilities (ExperimentalCapabilitiesEnabled | None):

The experimental capabilities to enable. Defaults to all capabilities.

Examples

>>> with EnableExperimentalCapability():
...     circuit = Circuit()
...     circuit.cc_prx(0, 0.1, 0.2, 0)

Parameters:

experimental_capabilities (Literal['ALL'])