neuralqx.utils.experimental module

Experimental decorator implementation

experimental(obj)

Decorator to mark functions or classes as experimental.

When an experimental function or class is used, it raises a RuntimeError unless the ‘EXPERIMENTAL’ configuration variable is set to True.

Parameters:

obj (Callable or Type) – the function or class to be decorated.

Returns:

the decorated function or class

Return type:

Callable or Type

Raises:

RuntimeError – if experimental features are not enabled