neuralib.util.unstable

neuralib.util.unstable.unstable(doc=True, runtime=True, mark_all=False)[source]

A decorator that mark class/function unstable.

Parameters:

  • doc (bool) – Add unstable message in function/class document.

  • runtime (bool) – Add runtime warning when invoking function/initialization.

  • mark_all (bool) – Mark all public methods when decorate on a class, If False, then only mark __init__()

Return type:

Callable[[T], T]