DeveloperAPI#

ray.util.annotations.DeveloperAPI(obj: F) → F[source]#
ray.util.annotations.DeveloperAPI() → Callable[[F], F]

Annotation for documenting developer APIs.

Developer APIs are lower-level methods explicitly exposed to advanced Ray users and library developers. Their interfaces may change across minor Ray releases.

Parameters:

  • *args – When used as a bare @DeveloperAPI decorator, contains the wrapped function or class as the single positional argument.

  • **kwargs – Reserved for future use; no keyword arguments are currently supported.

Returns:

Either the annotated object (when used as @DeveloperAPI) or a decorator that annotates an object (when used as @DeveloperAPI()).

Examples

>>> from ray.util.annotations import DeveloperAPI
>>> @DeveloperAPI
... def func(x):
...     return x
On this page