io.ray.api.runtime

Interface RayRuntime

public interface RayRuntime

Base interface of a Ray runtime.

Method Summary

Modifier and Type	Method and Description
ObjectRef	call(PyFunction pyFunction, Object[] args, CallOptions options) Invoke a remote Python function.
ObjectRef	call(RayFunc func, Object[] args, CallOptions options) Invoke a remote function.
ObjectRef	callActor(ActorHandle<?> actor, RayFunc func, Object[] args) Invoke a remote function on an actor.
ObjectRef	callActor(PyActorHandle pyActor, PyActorMethod pyActorMethod, Object[] args) Invoke a remote Python function on an actor.
PyActorHandle	createActor(PyActorClass pyActorClass, Object[] args, ActorCreationOptions options) Create a Python actor on a remote node.
<T> ActorHandle<T>	createActor(RayFunc actorFactoryFunc, Object[] args, ActorCreationOptions options) Create an actor on a remote node.
PlacementGroup	createPlacementGroup(List<Map<String,Double>> bundles, PlacementStrategy strategy)
void	exitActor() Intentionally exit the current actor.
void	free(List<ObjectRef<?>> objectRefs, boolean localOnly, boolean deleteCreatingTasks) Free a list of objects from Plasma Store.
<T> List<T>	get(List<ObjectRef<T>> objectRefs) Get a list of objects from the object store.
<T> T	get(ObjectRef<T> objectRef) Get an object from the object store.
<T extends BaseActorHandle> Optional<T>	getActor(String name, boolean global) Get a handle to a named actor.
<T extends BaseActorHandle> T	getActorHandle(ActorId actorId)
Object	getAsyncContext()
RuntimeContext	getRuntimeContext()
void	killActor(BaseActorHandle actor, boolean noRestart) Kill the actor immediately.
<T> ObjectRef<T>	put(T obj) Store an object in the object store.
void	setAsyncContext(Object asyncContext)
void	setResource(String resourceName, double capacity, UniqueId nodeId) Set the resource for the specific node.
void	shutdown() Shutdown the runtime.
<T> WaitResult<T>	wait(List<ObjectRef<T>> waitList, int numReturns, int timeoutMs) Wait for a list of RayObjects to be locally available, until specified number of objects are ready, or specified timeout has passed.
<T> Callable<T>	wrapCallable(Callable<T> callable) Wrap a Callable with necessary context capture.
Runnable	wrapRunnable(Runnable runnable) Wrap a Runnable with necessary context capture.

Method Detail

shutdown

void shutdown()

Shutdown the runtime.

put

<T> ObjectRef<T> put(T obj)

Store an object in the object store.

Parameters:

obj - The Java object to be stored.

Returns:

A ObjectRef instance that represents the in-store object.

get

<T> T get(ObjectRef<T> objectRef)

Get an object from the object store.

Parameters:

objectRef - The reference of the object to get.

Returns:

The Java object.

get

<T> List<T> get(List<ObjectRef<T>> objectRefs)

Get a list of objects from the object store.

Parameters:

objectRefs - The list of object references.

Returns:

A list of Java objects.

wait

<T> WaitResult<T> wait(List<ObjectRef<T>> waitList,
                       int numReturns,
                       int timeoutMs)

Wait for a list of RayObjects to be locally available, until specified number of objects are ready, or specified timeout has passed.

Parameters:

waitList - A list of ObjectRef to wait for.

numReturns - The number of objects that should be returned.

timeoutMs - The maximum time in milliseconds to wait before returning.

Returns:

Two lists, one containing locally available objects, one containing the rest.

free

void free(List<ObjectRef<?>> objectRefs,
          boolean localOnly,
          boolean deleteCreatingTasks)

Free a list of objects from Plasma Store.

Parameters:

objectRefs - The object references to free.

localOnly - Whether only free objects for local object store or not.

deleteCreatingTasks - Whether also delete objects' creating tasks from GCS.

setResource

void setResource(String resourceName,
                 double capacity,
                 UniqueId nodeId)

Set the resource for the specific node.

Parameters:

resourceName - The name of resource.

capacity - The capacity of the resource.

nodeId - The node that we want to set its resource.

getActorHandle

<T extends BaseActorHandle> T getActorHandle(ActorId actorId)

getActor

<T extends BaseActorHandle> Optional<T> getActor(String name,
                                                 boolean global)

Get a handle to a named actor.

Gets a handle to a named actor with the given name. The actor must have been created with name specified.

Parameters:

name - The name of the named actor.

global - Whether the named actor is global.

Returns:

ActorHandle to the actor.

killActor

void killActor(BaseActorHandle actor,
               boolean noRestart)

Kill the actor immediately.

Parameters:

actor - The actor to be killed.

noRestart - If set to true, the killed actor will not be restarted anymore.

call

ObjectRef call(RayFunc func,
               Object[] args,
               CallOptions options)

Invoke a remote function.

Parameters:

func - The remote function to run.

args - The arguments of the remote function.

options - The options for this call.

Returns:

The result object.

call

ObjectRef call(PyFunction pyFunction,
               Object[] args,
               CallOptions options)

Invoke a remote Python function.

Parameters:

pyFunction - The Python function.

args - Arguments of the function.

options - The options for this call.

Returns:

The result object.

callActor

ObjectRef callActor(ActorHandle<?> actor,
                    RayFunc func,
                    Object[] args)

Invoke a remote function on an actor.

Parameters:

actor - A handle to the actor.

func - The remote function to run, it must be a method of the given actor.

args - The arguments of the remote function.

Returns:

The result object.

callActor

ObjectRef callActor(PyActorHandle pyActor,
                    PyActorMethod pyActorMethod,
                    Object[] args)

Invoke a remote Python function on an actor.

Parameters:

pyActor - A handle to the actor.

pyActorMethod - The actor method.

args - Arguments of the function.

Returns:

The result object.

createActor

<T> ActorHandle<T> createActor(RayFunc actorFactoryFunc,
                               Object[] args,
                               ActorCreationOptions options)

Create an actor on a remote node.

Type Parameters:

T - The type of the actor object.

Parameters:

actorFactoryFunc - A remote function whose return value is the actor object.

args - The arguments for the remote function.

options - The options for creating actor.

Returns:

A handle to the actor.

createActor

PyActorHandle createActor(PyActorClass pyActorClass,
                          Object[] args,
                          ActorCreationOptions options)

Create a Python actor on a remote node.

Parameters:

pyActorClass - The Python actor class.

args - Arguments of the actor constructor.

options - The options for creating actor.

Returns:

A handle to the actor.

createPlacementGroup

PlacementGroup createPlacementGroup(List<Map<String,Double>> bundles,
                                    PlacementStrategy strategy)

getRuntimeContext

RuntimeContext getRuntimeContext()

getAsyncContext

Object getAsyncContext()

setAsyncContext

void setAsyncContext(Object asyncContext)

wrapRunnable

Runnable wrapRunnable(Runnable runnable)

Wrap a Runnable with necessary context capture.

Parameters:

runnable - The runnable to wrap.

Returns:

The wrapped runnable.

wrapCallable

<T> Callable<T> wrapCallable(Callable<T> callable)

Wrap a Callable with necessary context capture.

Parameters:

callable - The callable to wrap.

Returns:

The wrapped callable.

exitActor

void exitActor()

Intentionally exit the current actor.