Merge pull request #1304 from IntelPython/refactor/kernel_api

Move the kernel_iface module from experimental into a top-level module

Author: Diptorup Deb

numba_dpex/experimental/_kernel_dpcpp_spirv_overloads/_atomic_ref_overloads.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 """
-Implements the SPIR-V overloads for the kernel_api.atomic_ref class methods.
+Implements the SPIR-V overloads for the kernel_api.AtomicRef class methods.
 """
 
 from llvmlite import ir as llvmir
@@ -15,9 +15,14 @@
 from numba_dpex.core.targets.kernel_target import CC_SPIR_FUNC, LLVM_SPIRV_ARGS
 from numba_dpex.core.types import USMNdArray
 from numba_dpex.experimental.flag_enum import FlagEnum
+from numba_dpex.kernel_api import (
+    AddressSpace,
+    AtomicRef,
+    MemoryOrder,
+    MemoryScope,
+)
 
 from ..dpcpp_types import AtomicRefType
-from ..kernel_iface import AddressSpace, AtomicRef, MemoryOrder, MemoryScope
 from ..target import DPEX_KERNEL_EXP_TARGET_NAME
 from ._spv_atomic_inst_helper import (
     get_atomic_inst_name,
@@ -358,7 +363,7 @@ def ol_atomic_ref(
     address_space=AddressSpace.GLOBAL,
 ):
     """Overload of the constructor for the class
-    class:`numba_dpex.experimental.kernel_iface.AtomicRef`.
+    class:`numba_dpex.kernel_api.AtomicRef`.
 
     Raises:
         errors.TypingError: If the `ref` argument is not a UsmNdArray type.
@@ -436,8 +441,7 @@ def ol_atomic_ref_ctor_impl(
 
 @overload_method(AtomicRefType, "fetch_add", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_add(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_add`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_add`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_add` function.
@@ -461,8 +465,7 @@ def ol_fetch_add_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "fetch_sub", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_sub(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_sub`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_sub`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_sub` function.
@@ -486,8 +489,7 @@ def ol_fetch_sub_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "fetch_min", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_min(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_min`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_min`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_min` function.
@@ -511,8 +513,7 @@ def ol_fetch_min_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "fetch_max", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_max(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_max`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_max`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_max` function.
@@ -536,8 +537,7 @@ def ol_fetch_max_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "fetch_and", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_and(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_and`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_and`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_and` function.
@@ -566,8 +566,7 @@ def ol_fetch_and_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "fetch_or", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_or(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_or`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_or`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_or` function.
@@ -596,8 +595,7 @@ def ol_fetch_or_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "fetch_xor", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_fetch_xor(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.fetch_xor`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.fetch_xor`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::fetch_xor` function.
@@ -626,8 +624,7 @@ def ol_fetch_xor_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "load", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_load(atomic_ref):  # pylint: disable=unused-argument
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.load`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.load`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::load` function.
@@ -643,8 +640,7 @@ def ol_load_impl(atomic_ref):
 
 @overload_method(AtomicRefType, "store", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_store(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.store`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.store`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::store` function.
@@ -669,8 +665,7 @@ def ol_store_impl(atomic_ref, val):
 
 @overload_method(AtomicRefType, "exchange", target=DPEX_KERNEL_EXP_TARGET_NAME)
 def ol_exchange(atomic_ref, val):
-    """SPIR-V overload for
-    :meth:`numba_dpex.experimental.kernel_iface.AtomicRef.exchange`.
+    """SPIR-V overload for :meth:`numba_dpex.kernel_api.AtomicRef.exchange`.
 
     Generates the same LLVM IR instruction as dpcpp for the
     `atomic_ref::exchange` function.

numba_dpex/experimental/_kernel_dpcpp_spirv_overloads/_spv_atomic_inst_helper.py

@@ -8,7 +8,7 @@
 
 from numba.core import types
 
-from ..kernel_iface import MemoryOrder, MemoryScope
+from numba_dpex.kernel_api import MemoryOrder, MemoryScope
 
 
 class _SpvScope(IntEnum):

numba_dpex/experimental/dpcpp_types.py

@@ -2,15 +2,15 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""Collection of numba-dpex typing classes for kernel_iface Python classes.
+"""Collection of numba-dpex typing classes for kernel_api Python classes.
 """
 
 from numba.core.types import Type
 
 
 class AtomicRefType(Type):
     """numba-dpex internal type to represent a Python object of
-    :class:`numba_dpex.experimental.kernel_iface.AtomicRef`.
+    :class:`numba_dpex.kernel_api.AtomicRef`.
     """
 
     def __init__(
@@ -38,21 +38,21 @@ def __init__(
     @property
     def memory_order(self) -> int:
         """Returns the integer value for a memory order that corresponds to
-        kernel_iface.MemoryOrder.
+        kernel_api.MemoryOrder.
         """
         return self._memory_order
 
     @property
     def memory_scope(self) -> int:
         """Returns the integer value for a memory order that corresponds to
-        kernel_iface.MemoryScope.
+        kernel_api.MemoryScope.
         """
         return self._memory_scope
 
     @property
     def address_space(self) -> int:
         """Returns the integer value for a memory order that corresponds to
-        kernel_iface.AddressSpace.
+        kernel_api.AddressSpace.
         """
         return self._address_space
 

numba_dpex/experimental/typeof.py

@@ -9,8 +9,9 @@
 
 from numba.extending import typeof_impl
 
+from numba_dpex.kernel_api import AtomicRef
+
 from .dpcpp_types import AtomicRefType
-from .kernel_iface import AtomicRef
 
 
 @typeof_impl.register(AtomicRef)

numba_dpex/experimental/kernel_iface/__init__.py renamed to numba_dpex/kernel_api/__init__.py

@@ -2,10 +2,11 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""The kernel_iface provides a set of Python classes and functions that are
-analogous to the C++ SYCL API. The kernel_iface API is meant to allow
+"""
+The kernel_api module provides a set of Python classes and functions that are
+analogous to the C++ SYCL API. The kernel_api module is meant to allow
 prototyping SYCL-like kernels in pure Python before compiling them using
-numba_dpex.kernel.
+numba_dpex.
 """
 
 from .atomic_ref import AtomicRef

numba_dpex/experimental/kernel_iface/atomic_ref.py renamed to numba_dpex/kernel_api/atomic_ref.py

@@ -8,7 +8,7 @@
 
 import numba_dpex as dpex
 import numba_dpex.experimental as dpex_exp
-from numba_dpex.experimental.kernel_iface import AtomicRef
+from numba_dpex.kernel_api import AtomicRef
 from numba_dpex.tests._helper import get_all_dtypes
 
 list_of_supported_dtypes = get_all_dtypes(