6738946346

Committed 02 Nov 2023 10:31PM UTC coverage: 78.671% (+0.4%) from 78.279%

Build # 6738946346

Build Type

Pull #1178

github

Committed by

web-flow

Commit Message

Merge 199183c66 into ac05c1a87

Pull Request Pull Request #1178: An experimental kernel dispatcher for numba_dpex.kernel decorator

Run Details

1132 of 1705 branches covered (0.0%)

Branch coverage included in aggregate %.

380 of 432 new or added lines in 13 files covered. (87.96%)

10 existing lines in 1 file now uncovered.

5050 of 6153 relevant lines covered (82.07%)

0.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

28.57

/numba_dpex/experimental/decorators.py

# SPDX-FileCopyrightText: 2023 Intel Corporation
#
# SPDX-License-Identifier: Apache-2.0

""" The set of experimental decorators provided by numba_dpex that are not yet
ready to move to numba_dpex.core.
"""
import inspect

from numba.core import sigutils

from .kernel_dispatcher import KernelDispatcher


def kernel(func_or_sig=None, debug=False, cache=False, **options):
    """A decorator to define a kernel function.

    A kernel function is conceptually equivalent to a SYCL kernel function, and
    gets compiled into either an OpenCL or a LevelZero SPIR-V binary kernel.
    A kernel decorated Python function has the following restrictions:

        * The function can not return any value.
        * All array arguments passed to a kernel should adhere to compute
          follows data programming model.
    """
    # FIXME: The options need to be evaluated and checked here like it is
    # done in numba.core.decorators.jit

    def _kernel_dispatcher(pyfunc, sigs=None):
        return KernelDispatcher(
            pyfunc=pyfunc,
            debug_flags=debug,
            enable_cache=cache,
            specialization_sigs=sigs,
            targetoptions=options,
        )

    if func_or_sig is None:
        return _kernel_dispatcher

    if isinstance(func_or_sig, str):
        raise NotImplementedError(
            "Specifying signatures as string is not yet supported by numba-dpex"
        )

    if isinstance(func_or_sig, list) or sigutils.is_signature(func_or_sig):
        # String signatures are not supported as passing usm_ndarray type as
        # a string is not possible. Numba's sigutils relies on the type being
        # available in Numba's `types.__dict__` and dpex types are not
        # registered there yet.
        if isinstance(func_or_sig, list):
            for sig in func_or_sig:
                if isinstance(sig, str):
                    raise NotImplementedError(
                        "Specifying signatures as string is not yet supported "
                        "by numba-dpex"
                    )
        # Specialized signatures can either be a single signature or a list.
        # In case only one signature is provided convert it to a list
        if not isinstance(func_or_sig, list):
            func_or_sig = [func_or_sig]

        def _specialized_kernel_dispatcher(pyfunc):
            return KernelDispatcher(
                pyfunc=pyfunc,
                debug_flags=debug,
                enable_cache=cache,
                specialization_sigs=func_or_sig,
            )

        return _specialized_kernel_dispatcher
    func = func_or_sig
    if not inspect.isfunction(func):
        raise ValueError(
            "Argument passed to the kernel decorator is neither a "
            "function object, nor a signature. If you are trying to "
            "specialize the kernel that takes a single argument, specify "
            "the return type as void explicitly."
        )
    return _kernel_dispatcher(func)

1	# SPDX-FileCopyrightText: 2023 Intel Corporation
2	#
3	# SPDX-License-Identifier: Apache-2.0
4
5	""" The set of experimental decorators provided by numba_dpex that are not yet	1✔
6	ready to move to numba_dpex.core.
7	"""
8	import inspect	1✔
9
10	from numba.core import sigutils	1✔
11
12	from .kernel_dispatcher import KernelDispatcher	1✔
13
14
15	def kernel(func_or_sig=None, debug=False, cache=False, **options):	1✔
16	"""A decorator to define a kernel function.
17
18	A kernel function is conceptually equivalent to a SYCL kernel function, and
19	gets compiled into either an OpenCL or a LevelZero SPIR-V binary kernel.
20	A kernel decorated Python function has the following restrictions:
21
22	* The function can not return any value.
23	* All array arguments passed to a kernel should adhere to compute
24	follows data programming model.
25	"""
26	# FIXME: The options need to be evaluated and checked here like it is
27	# done in numba.core.decorators.jit
28
29	def _kernel_dispatcher(pyfunc, sigs=None):	1✔
30	return KernelDispatcher(	1✔
31	pyfunc=pyfunc,
32	debug_flags=debug,
33	enable_cache=cache,
34	specialization_sigs=sigs,
35	targetoptions=options,
36	)
37
38	if func_or_sig is None:	1!
39	return _kernel_dispatcher	1✔
40
NEW 41	if isinstance(func_or_sig, str):	×
42	raise NotImplementedError(
43	"Specifying signatures as string is not yet supported by numba-dpex"
44	)
45
NEW 46	if isinstance(func_or_sig, list) or sigutils.is_signature(func_or_sig):	×
47	# String signatures are not supported as passing usm_ndarray type as
48	# a string is not possible. Numba's sigutils relies on the type being
49	# available in Numba's `types.__dict__` and dpex types are not
50	# registered there yet.
NEW 51	if isinstance(func_or_sig, list):	×
NEW 52	for sig in func_or_sig:	×
NEW 53	if isinstance(sig, str):	×
54	raise NotImplementedError(
55	"Specifying signatures as string is not yet supported "
56	"by numba-dpex"
57	)
58	# Specialized signatures can either be a single signature or a list.
59	# In case only one signature is provided convert it to a list
NEW 60	if not isinstance(func_or_sig, list):	×
NEW 61	func_or_sig = [func_or_sig]	×
62
NEW 63	def _specialized_kernel_dispatcher(pyfunc):	×
NEW 64	return KernelDispatcher(	×
65	pyfunc=pyfunc,
66	debug_flags=debug,
67	enable_cache=cache,
68	specialization_sigs=func_or_sig,
69	)
70
NEW 71	return _specialized_kernel_dispatcher	×
NEW 72	func = func_or_sig	×
NEW 73	if not inspect.isfunction(func):	×
NEW 74	raise ValueError(	×
75	"Argument passed to the kernel decorator is neither a "
76	"function object, nor a signature. If you are trying to "
77	"specialize the kernel that takes a single argument, specify "
78	"the return type as void explicitly."
79	)
NEW 80	return _kernel_dispatcher(func)	×

IntelPython / numba-dpex / 6738946346

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous