fatf.utils.kernels.check_kernel_functionality

fatf.utils.kernels.check_kernel_functionality(kernel_function: Callable[..., numpy.ndarray], suppress_warning: bool = False) → bool[source]

Checks whether a kernel function has exactly one required parameter.

New in version 0.0.2.

Parameters
kernel_functionCallable[[numpy.ndarray, …], numpy.ndarray]

A Python callable, e.g., a function or a method, which represents a kernel function.

suppress_warningboolean, optional (default=False)

A boolean parameter that indicates whether the function should suppress its warning message. Defaults to False.

Returns
is_functionalboolean

A boolean variable that indicates whether the kernel function is valid.

Raises
TypeError

The kernel_function parameter is not a Python callable or the suppress_warning parameter is not a boolean.

Warns
UserWarning

Warns about the details of the required functionality that the kernel function lacks.