add: qulacus device builder

Author: kenya-sk

qxmt/configs.py

@@ -101,7 +101,7 @@ class DeviceConfig(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     platform: str
-    device_name: str
+    device_name: Optional[str] = None
     backend_name: Optional[str] = None
     n_qubits: int
     shots: Optional[int] = None

qxmt/constants.py

@@ -45,6 +45,7 @@
 if hasattr(qml.devices, "QubitDevice"):
     _pl_devices.append(getattr(qml.devices, "QubitDevice"))
 PENNYLANE_DEVICES: tuple[Any, ...] = tuple(_pl_devices) if _pl_devices else tuple()
+QULACS_PLATFORM: str = "qulacs"
 
 # set default model name
 DEFAULT_MODEL_NAME: str = "model.pkl"

qxmt/devices/base.py

@@ -20,7 +20,7 @@ class BaseDevice(ABC):
     def __init__(
         self,
         platform: str,
-        device_name: str,
+        device_name: Optional[str],
         backend_name: Optional[str],
         n_qubits: int,
         shots: Optional[int],
@@ -31,7 +31,7 @@ def __init__(
 
         Args:
             platform (str): platform name (ex: pennylane, qulacs, etc.)
-            device_name (str): device name provided by the platform (ex: default.qubit, default.tensor, etc.)
+            device_name (Optional[str]): device name provided by the platform (ex: default.qubit, default.tensor, etc.)
             backend_name (Optional[str]): backend name for the real device
             n_qubits (int): number of qubits
             shots (Optional[int]): number of shots for the quantum circuit

qxmt/devices/builder.py

@@ -1,6 +1,7 @@
 from typing import Any
 
 from qxmt.configs import DeviceConfig
+from qxmt.constants import PENNYLANE_PLATFORM, QULACS_PLATFORM
 from qxmt.devices.amazon import AMAZON_BRAKET_DEVICES
 from qxmt.devices.base import BaseDevice
 from qxmt.devices.ibmq import IBMQ_REAL_DEVICES
@@ -9,8 +10,8 @@
 
 LOGGER = set_default_logger(__name__)
 
-PENNYLANE_PLATFORM: str = "pennylane"
-QULACS_PLATFORM: str = "qulacs"
+PENNYLANE_DEFAULT_DEVICE_NAME: str = "default.qubit"
+QULACS_DEFAULT_DEVICE_NAME: str = "cpu.simulator"
 
 
 class DeviceBuilder:
@@ -104,7 +105,7 @@ def build(self) -> BaseDevice:
 
                 return PennyLaneDevice(
                     platform=platform,
-                    device_name=device_name,
+                    device_name=device_name if device_name is not None else PENNYLANE_DEFAULT_DEVICE_NAME,
                     backend_name=backend_name,
                     n_qubits=n_qubits,
                     shots=shots,
@@ -116,7 +117,7 @@ def build(self) -> BaseDevice:
 
             return QulacsDevice(
                 platform=platform,
-                device_name=device_name,
+                device_name=device_name if device_name is not None else QULACS_DEFAULT_DEVICE_NAME,
                 backend_name=backend_name,
                 n_qubits=n_qubits,
                 shots=shots,

qxmt/devices/device_info.py

@@ -2,10 +2,9 @@
 from pydantic import BaseModel
 from qiskit_ibm_runtime import QiskitRuntimeService
 
-from qxmt.constants import PENNYLANE_DEVICES
+from qxmt.constants import PENNYLANE_DEVICES, PENNYLANE_PLATFORM
 from qxmt.devices.base import BaseDevice
 from qxmt.exceptions import InvalidQunatumDeviceError
-from qxmt.types import QuantumDeviceType
 
 STATUS_ONLINE = "ONLINE"
 STATUS_OFFLINE = "OFFLINE"
@@ -17,11 +16,11 @@ class RemoteDeviceStatus(BaseModel):
     status: str
 
 
-def get_platform_from_device(device: BaseDevice | QuantumDeviceType) -> str:
+def get_platform_from_device(device: BaseDevice | object) -> str:
     """Get the platform name from the device.
 
     Args:
-        device (BaseDevice | QuantumDeviceType): quantum device
+        device (BaseDevice | object): quantum device
 
     Returns:
         str: platform name
@@ -30,16 +29,16 @@ def get_platform_from_device(device: BaseDevice | QuantumDeviceType) -> str:
         return device.platform
 
     if isinstance(device, PENNYLANE_DEVICES):
-        return "pennylane"
+        return PENNYLANE_PLATFORM
     else:
         raise InvalidQunatumDeviceError(f"Device {device} is not supported.")
 
 
-def get_number_of_qubits(device: BaseDevice | QuantumDeviceType) -> int:
+def get_number_of_qubits(device: BaseDevice | object) -> int:
     """Get the number of qubits from the device.
 
     Args:
-        device (BaseDevice | QuantumDeviceType): quantum device
+        device (BaseDevice | object): quantum device
 
     Returns:
         int: number of qubits
@@ -48,7 +47,7 @@ def get_number_of_qubits(device: BaseDevice | QuantumDeviceType) -> int:
         return device.n_qubits
 
     if isinstance(device, PENNYLANE_DEVICES):
-        return len(device.wires)
+        return len(device.wires)  # type: ignore[attr-defined]
     else:
         raise InvalidQunatumDeviceError(f"Device {device} is not supported.")