io.ray.api.runtimecontext

Interface RuntimeContext

public interface RuntimeContext

A class used for getting information of Ray runtime.

Method Summary

Modifier and Type	Method and Description
List<NodeInfo>	getAllNodeInfo() Get all node information in Ray cluster.
<T extends BaseActorHandle> T	getCurrentActorHandle() Get the handle to the current actor itself.
ActorId	getCurrentActorId() Get the current actor ID.
JobId	getCurrentJobId() Get the current Job ID.
UniqueId	getCurrentNodeId() Get the node id of this worker.
RuntimeEnv	getCurrentRuntimeEnv() Get the runtime env of this worker.
TaskId	getCurrentTaskId() Get current task ID.
List<Long>	getGpuIds() Get available GPU(deviceIds) for this worker.
String	getNamespace() Get the namespace of this job.
boolean	isLocalMode() Returns true if Ray is running in local mode, false if Ray is running in cluster mode.
boolean	wasCurrentActorRestarted() Returns true if the current actor was restarted, otherwise false.

Method Detail

getCurrentJobId

JobId getCurrentJobId()

Get the current Job ID.

getCurrentTaskId

TaskId getCurrentTaskId()

Get current task ID.

getCurrentActorId

ActorId getCurrentActorId()

Get the current actor ID.

Note, this can only be called in actors.

wasCurrentActorRestarted

boolean wasCurrentActorRestarted()

Returns true if the current actor was restarted, otherwise false.

isLocalMode

boolean isLocalMode()

Returns true if Ray is running in local mode, false if Ray is running in cluster mode.

getAllNodeInfo

List<NodeInfo> getAllNodeInfo()

Get all node information in Ray cluster.

getCurrentActorHandle

<T extends BaseActorHandle> T getCurrentActorHandle()

Get the handle to the current actor itself. Note that this method must be invoked in an actor.

getGpuIds

List<Long> getGpuIds()

Get available GPU(deviceIds) for this worker.

getNamespace

String getNamespace()

Get the namespace of this job.

getCurrentNodeId

UniqueId getCurrentNodeId()

Get the node id of this worker.

getCurrentRuntimeEnv

RuntimeEnv getCurrentRuntimeEnv()

Get the runtime env of this worker. If it is a driver, job level runtime env will be returned.