qbraid.get_devices
- get_devices(filters=None, refresh=False)[source]
Displays a list of all supported devices matching given filters, tabulated by provider, name, and qBraid ID. Each device also has a status given by a solid green bubble or a hollow red bubble, indicating that the device is online or offline, respectively. You can narrow your device search by supplying a dictionary containing the desired criteria.
Request Syntax:
get_devices( filters={ 'name': 'string', 'vendor': 'AWS'|'IBM', 'provider: 'AWS'|'IBM'|'IonQ'|'Rigetti'|'OQC'|'QuEra', 'type': 'QPU'|'SIMULATOR', 'numberQubits': 123, 'paradigm': 'gate-based'|'quantum-annealer'|'AHS'|'continuous-variable', 'status': 'ONLINE'|'OFFLINE'|'RETIRED' } )
Filters:
name (str): Name quantum device name
vendor (str): Company whose software facilitaces access to quantum device
provider (str): Company providing the quantum device
type (str): If the device is a quantum simulator or hardware
numberQubits (int): The number of qubits in quantum device
paradigm (str): The quantum model through which the device operates
status (str): Availability of device
Examples:
from qbraid import get_devices # Search for gate-based devices provided by Google that are online/available get_devices( filters={"paradigm": "gate-based", "provider": "IBM", "status": "ONLINE"} ) # Search for QPUs with at least 5 qubits that are available through AWS or IBM get_devices( filters={"type": "QPU", "numberQubits": {"$gte": 5}, "vendor": {"$in": ["AWS", "IBM"]}} ) # Search for state vector simulators by filtering for device ID's containing string "sv". get_devices( filters={"type": "SIMULATOR", "qbraid_id": {"$regex": "sv"}} )
For a complete list of search operators, see Query Selectors. To refresh the device status column, call
get_devices()
withrefresh=True
keyword argument. The bottom-right corner of the device table indicates time since the last status refresh.- Parameters:
filters (
Optional
[Dict
[str
,Any
]]) – A dictionary containing any filters to be applied.refresh (
bool
) – If True, callsrefresh_devices()
before execution.
- Return type:
Union
[DisplayHandle
,Any
,None
]