All device creation service functions raise SyclDeviceCreationError

Author: oleksandr-pavlyk

dpctl/_device_selection.py

@@ -1,7 +1,8 @@
 import collections.abc
 from itertools import chain
 
-from . import SyclDevice, get_devices
+from ._sycl_device import SyclDevice, SyclDeviceCreationError
+from ._sycl_device_factory import get_devices
 
 
 def select_device_with_aspects(required_aspects, excluded_aspects=[]):
@@ -66,7 +67,7 @@ def select_device_with_aspects(required_aspects, excluded_aspects=[]):
             selected_dev = dev
 
     if selected_dev is None:
-        raise ValueError(
+        raise SyclDeviceCreationError(
             f"Requested device is unavailable: "
             f"required_aspects={required_aspects}, "
             f"excluded_aspects={excluded_aspects}"

dpctl/_sycl_context.pyx

@@ -174,7 +174,8 @@ cdef class SyclContext(_SyclContext):
     Raises:
         MemoryError: If the constructor could not allocate necessary
                      temporary memory.
-        ValueError: If the :class:`dpctl.SyclContext` object creation failed.
+        SyclContextCreationError: If the :class:`dpctl.SyclContext` object
+                                  creation failed.
         TypeError: If the list of :class:`dpctl.SyclDevice` objects was empty,
                    or the input capsule contained a null pointer or could not
                    be renamed.

dpctl/_sycl_device.pyx

@@ -223,6 +223,20 @@ cdef class SyclDevice(_SyclDevice):
                 gpu = dpctl.select_gpu_device():
                 gpu.print_device_info()
 
+    Args:
+        arg (optional): The argument can be a selector string or None.
+                        Defaults to ``None``.
+
+    Raises:
+        MemoryError: If the constructor could not allocate necessary
+                     temporary memory.
+        SyclDeviceCreationError: If the :class:`dpctl.SyclDevice` object
+                                 creation failed.
+        TypeError: If the list of :class:`dpctl.SyclDevice` objects was empty,
+                   or the input capsule contained a null pointer or could not
+                   be renamed.
+
+
     """
     @staticmethod
     cdef SyclDevice _create(DPCTLSyclDeviceRef dref):

dpctl/_sycl_device_factory.pyx

@@ -46,6 +46,7 @@ from ._backend cimport (  # noqa: E211
     _device_type,
 )
 
+from ._sycl_device import SyclDeviceCreationError
 from .enum_types import backend_type
 from .enum_types import device_type as device_type_t
 
@@ -307,15 +308,15 @@ cpdef SyclDevice select_accelerator_device():
         dpctl.SyclDevice: A Python object wrapping the SYCL ``device``
         returned by the SYCL ``accelerator_selector``.
     Raises:
-        ValueError: If the SYCL ``accelerator_selector`` is unable to select a
-                    ``device``.
+        dpctl.SyclDeviceCreatioError: If the SYCL ``accelerator_selector`` is
+        unable to select a ``device``.
     """
     cdef DPCTLSyclDeviceSelectorRef DSRef = DPCTLAcceleratorSelector_Create()
     cdef DPCTLSyclDeviceRef DRef = DPCTLDevice_CreateFromSelector(DSRef)
     # Free up the device selector
     DPCTLDeviceSelector_Delete(DSRef)
     if DRef is NULL:
-        raise ValueError("Device unavailable.")
+        raise SyclDeviceCreationError("Accelerator device is unavailable.")
     Device = SyclDevice._create(DRef)
     return Device
 
@@ -327,15 +328,15 @@ cpdef SyclDevice select_cpu_device():
         dpctl.SyclDevice: A Python object wrapping the SYCL ``device``
         returned by the SYCL ``cpu_selector``.
     Raises:
-        ValueError: If the SYCL ``cpu_selector`` is unable to select a
-                    ``device``.
+        dpctl.SyclDeviceCreationError: If the SYCL ``cpu_selector`` is
+        unable to select a ``device``.
     """
     cdef DPCTLSyclDeviceSelectorRef DSRef = DPCTLCPUSelector_Create()
     cdef DPCTLSyclDeviceRef DRef = DPCTLDevice_CreateFromSelector(DSRef)
     # Free up the device selector
     DPCTLDeviceSelector_Delete(DSRef)
     if DRef is NULL:
-        raise ValueError("Device unavailable.")
+        raise SyclDeviceCreationError("CPU device is unavailable.")
     Device = SyclDevice._create(DRef)
     return Device
 
@@ -347,15 +348,15 @@ cpdef SyclDevice select_default_device():
         dpctl.SyclDevice: A Python object wrapping the SYCL ``device``
         returned by the SYCL ``default_selector``.
     Raises:
-        ValueError: If the SYCL ``default_selector`` is unable to select a
-            ``device``.
+        dpctl.SyclDeviceCreationError: If the SYCL ``default_selector`` is
+        unable to select a ``device``.
     """
     cdef DPCTLSyclDeviceSelectorRef DSRef = DPCTLDefaultSelector_Create()
     cdef DPCTLSyclDeviceRef DRef = DPCTLDevice_CreateFromSelector(DSRef)
     # Free up the device selector
     DPCTLDeviceSelector_Delete(DSRef)
     if DRef is NULL:
-        raise ValueError("Device unavailable.")
+        raise SyclDeviceCreationError("Default device is unavailable.")
     Device = SyclDevice._create(DRef)
     return Device
 
@@ -367,15 +368,15 @@ cpdef SyclDevice select_gpu_device():
         dpctl.SyclDevice: A Python object wrapping the SYCL ``device``
         returned by the SYCL ``gpu_selector``.
     Raises:
-        ValueError: If the SYCL ``gpu_selector`` is unable to select a
-                    ``device``.
+        dpctl.SyclDeviceCreationError: If the SYCL ``gpu_selector`` is
+        unable to select a ``device``.
     """
     cdef DPCTLSyclDeviceSelectorRef DSRef = DPCTLGPUSelector_Create()
     cdef DPCTLSyclDeviceRef DRef = DPCTLDevice_CreateFromSelector(DSRef)
     # Free up the device selector
     DPCTLDeviceSelector_Delete(DSRef)
     if DRef is NULL:
-        raise ValueError("Device unavailable.")
+        raise SyclDeviceCreationError("Device unavailable.")
     Device = SyclDevice._create(DRef)
     return Device
 
@@ -387,14 +388,14 @@ cpdef SyclDevice select_host_device():
         dpctl.SyclDevice: A Python object wrapping the SYCL ``device``
         returned by the SYCL ``host_selector``.
     Raises:
-        ValueError: If the SYCL ``host_selector`` is unable to select a
-            ``device``.
+        dpctl.SyclDeviceCreationError: If the SYCL ``host_selector`` is
+        unable to select a ``device``.
     """
     cdef DPCTLSyclDeviceSelectorRef DSRef = DPCTLHostSelector_Create()
     cdef DPCTLSyclDeviceRef DRef = DPCTLDevice_CreateFromSelector(DSRef)
     # Free up the device selector
     DPCTLDeviceSelector_Delete(DSRef)
     if DRef is NULL:
-        raise ValueError("Device unavailable.")
+        raise SyclDeviceCreationError("Host device is unavailable.")
     Device = SyclDevice._create(DRef)
     return Device