Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc DeallocateObject (DeallocateObjectRequest, AckReply)

  ray.proto:194

  Tell the object store to deallocate an object held by the object store. This is called by the scheduler.

  message DeallocateObjectRequest

  ray.proto:227

  • uint64 canonical_objectid = 1

    The canonical objectid of the object to deallocate

• rpc NotifyAlias (NotifyAliasRequest, AckReply)

  ray.proto:192

  Notify the object store about objectid aliasing. This is called by the scheduler

  message NotifyAliasRequest

  ray.proto:222

  • uint64 alias_objectid = 1

    The objectid being aliased

  • uint64 canonical_objectid = 2

    The canonical objectid that points to the actual object

• rpc ObjStoreInfo (ObjStoreInfoRequest, ObjStoreInfoReply)

  ray.proto:196

  Get info about the object store state

  message ObjStoreInfoRequest

  ray.proto:272

  • repeated uint64 objectid = 1

    Object IDs we want to retrieve from the store for inspection

  message ObjStoreInfoReply

  ray.proto:276

  • repeated uint64 objectid = 1

    List of object IDs in the store

  • repeated Obj obj = 2

    Protocol buffer objects that were requested

• rpc StartDelivery (StartDeliveryRequest, AckReply)

  ray.proto:188

  Tell the object store to begin getting an object from another object store (called by the scheduler)

  message StartDeliveryRequest

  ray.proto:199

  • string objstore_address = 1

    Object store to get the object from

  • uint64 objectid = 2

    ID of object that gets delivered

• rpc StreamObjTo (StreamObjToRequest, stream ObjChunk)

  ray.proto:190

  Accept incoming data from another object store, as a stream of object chunks

  message StreamObjToRequest

  ray.proto:212

  • uint64 objectid = 1

    Object ID of the object being streamed

  message ObjChunk

  ray.proto:216

  • uint64 total_size = 1

    Total size of the object

  • uint64 metadata_offset = 2

    Offset of the arrow metadata

  • bytes data = 3

    Data for this chunk of the object

• rpc AddContainedObjectIDs (AddContainedObjectIDsRequest, AckReply)

  ray.proto:46

  Used by the worker to notify the scheduler about which objectids a particular object contains

  message AddContainedObjectIDsRequest

  ray.proto:139

  • uint64 objectid = 1

    The objectid of the object in question

  • repeated uint64 contained_objectid = 2

    Object IDs contained in the object

• rpc AliasObjectIDs (AliasObjectIDsRequest, AckReply)

  ray.proto:38

  Used by the worker to tell the scheduler that two objectids should refer to the same object

  message AliasObjectIDsRequest

  ray.proto:125

  • uint64 alias_objectid = 1

    ObjectID which will be aliased

  • uint64 target_objectid = 2

    The target ObjectID

• rpc DecrementCount (ChangeCountRequest, AckReply)

  ray.proto:32

  Decrement the count of the object ID

• rpc DecrementRefCount (DecrementRefCountRequest, AckReply)

  ray.proto:44

  Decrements the reference count of a particular object ID

  message DecrementRefCountRequest

  ray.proto:144

  • repeated uint64 objectid = 1

    Object IDs whose reference count should be decremented. Duplicates will be decremented multiple times.

• rpc ExportRemoteFunction (ExportRemoteFunctionRequest, AckReply)

  ray.proto:58

  Exports function to the workers

  message ExportRemoteFunctionRequest

  ray.proto:258

  • optional Function function = 1

• rpc ExportReusableVariable (ExportReusableVariableRequest, AckReply)

  ray.proto:60

  Ship an initializer and reinitializer for a reusable variable to the workers

  message ExportReusableVariableRequest

  ray.proto:262

  • optional ReusableVar reusable_variable = 1

    The reusable variable to export.

• rpc IncrementCount (ChangeCountRequest, AckReply)

  ray.proto:30

  Increment the count of the object ID

• rpc IncrementRefCount (IncrementRefCountRequest, AckReply)

  ray.proto:42

  Increments the reference count of a particular object ID

  message IncrementRefCountRequest

  ray.proto:135

  • repeated uint64 objectid = 1

    Object IDs whose reference count should be incremented. Duplicates will be incremented multiple times.

• rpc KillWorkers (KillWorkersRequest, KillWorkersReply)

  ray.proto:54

  Kills the workers

  message KillWorkersRequest

  ray.proto:247

  (message has no fields)

  message KillWorkersReply

  ray.proto:250

  • bool success = 1

    Currently, the only reason to fail is if there are workers still executing tasks

• rpc NotifyFailure (NotifyFailureRequest, AckReply)

  ray.proto:62

  Notify the scheduler that a failure occurred while running a task, importing a remote function, or importing a reusable variable.

  message NotifyFailureRequest

  ray.proto:266

  • optional Failure failure = 1

    The failure object.

• rpc ObjReady (ObjReadyRequest, AckReply)

  ray.proto:40

  Used by an object store to tell the scheduler that an object is ready (i.e. has been finalized and can be shared)

  message ObjReadyRequest

  ray.proto:130

  • uint64 objectid = 1

    Object ID of the object that has been finalized

  • uint64 objstoreid = 2

    ID of the object store the object lives on

• rpc PutObj (PutObjRequest, PutObjReply)

  ray.proto:34

  Request an object ID for an object that will be put in an object store

  message PutObjRequest

  ray.proto:117

  • uint64 workerid = 1

    Worker that tries to put an object

  message PutObjReply

  ray.proto:121

  • uint64 objectid = 1

    Object ID assigned by the scheduler to the object

• rpc ReadyForNewTask (ReadyForNewTaskRequest, AckReply)

  ray.proto:48

  Used by the worker to ask for work, this also returns the status of the previous task if there was one

  message ReadyForNewTaskRequest

  ray.proto:148

  • uint64 workerid = 1

    ID of the worker which executed the task

• rpc RegisterObjStore (RegisterObjStoreRequest, RegisterObjStoreReply)

  ray.proto:24

  Register an object store with the scheduler

  message RegisterObjStoreRequest

  ray.proto:83

  • string objstore_address = 1

    IP address of the object store being registered

  message RegisterObjStoreReply

  ray.proto:87

  • uint64 objstoreid = 1

    Object store ID assigned by the scheduler

• rpc RegisterRemoteFunction (RegisterRemoteFunctionRequest, AckReply)

  ray.proto:26

  Tell the scheduler that a worker successfully imported a remote function.

  message RegisterRemoteFunctionRequest

  ray.proto:91

  • uint64 workerid = 1

    Worker that can execute the function

  • string function_name = 2

    Name of the remote function

  • uint64 num_return_vals = 3

    Number of return values of the function. This is only present if the function was successfully imported.

• rpc RegisterWorker (RegisterWorkerRequest, RegisterWorkerReply)

  ray.proto:22

  Register a new worker with the scheduler

  message RegisterWorkerRequest

  ray.proto:70

  • string node_ip_address = 1

    The IP address of the node the worker is running on.

  • string worker_address = 2

    The address of the worker.

  • string objstore_address = 3

    The address of the object store the worker should connect to. If omitted, this will be assigned by the scheduler.

  • bool is_driver = 4

    True if the worker is a driver, and false otherwise.

  message RegisterWorkerReply

  ray.proto:77

  • uint64 workerid = 1

    Worker ID assigned by the scheduler

  • uint64 objstoreid = 2

    The Object store ID of the worker's local object store

  • string objstore_address = 3

    IP address of the object store the worker should connect to

• rpc RequestObj (RequestObjRequest, AckReply)

  ray.proto:36

  Request delivery of an object from an object store that holds the object to the local object store

  message RequestObjRequest

  ray.proto:112

  • uint64 workerid = 1

    Worker that tries to request the object

  • uint64 objectid = 2

    Object ID of the object being requested

• rpc RunFunctionOnAllWorkers (RunFunctionOnAllWorkersRequest, AckReply)

  ray.proto:56

  Run a function on all workers

  message RunFunctionOnAllWorkersRequest

  ray.proto:254

  • optional Function function = 1

• rpc SchedulerInfo (SchedulerInfoRequest, SchedulerInfoReply)

  ray.proto:50

  Get information about the scheduler state

  message SchedulerInfoRequest

  ray.proto:158

  (message has no fields)

  message SchedulerInfoReply

  ray.proto:166

  • repeated uint64 operationid = 1

    OperationIds of the tasks on the task queue

  • repeated uint64 avail_worker = 3

    List of workers waiting to get a task assigned

  • map<string, FnTableEntry> function_table = 2

    Table of all available remote function

  • repeated uint64 target_objectid = 4

    The target_objectids_ data structure

  • repeated uint64 reference_count = 5

    The reference_counts_ data structure

  • optional CompGraph computation_graph = 6

    The computation graph constructed so far

  • repeated ObjstoreData objstore = 7

    Information about the object stores

• rpc SubmitTask (SubmitTaskRequest, SubmitTaskReply)

  ray.proto:28

  Asks the scheduler to execute a task, immediately returns an object ID to the result

  message SubmitTaskRequest

  ray.proto:101

  • uint64 workerid = 1

    The ID of the worker submitting the task

  • optional Task task = 2

    Contains name of the function to be executed and arguments

  message SubmitTaskReply

  ray.proto:106

  • repeated uint64 result = 1

    Object IDs of the function return values

  • bool function_registered = 2

    True if the function was registered, false otherwise

  • bool no_workers = 3

    True if no workers have registered with the scheduler, false otherwise

• rpc TaskInfo (TaskInfoRequest, TaskInfoReply)

  ray.proto:52

  Get information about tasks

  message TaskInfoRequest

  ray.proto:235

  (message has no fields)

  message TaskInfoReply

  ray.proto:238

  • repeated TaskStatus failed_task = 1

    The tasks that have failed.

  • repeated TaskStatus running_task = 2

    The tasks that are currently running.

  • repeated Failure failed_remote_function_import = 3

    The remote function imports that failed.

  • repeated Failure failed_reusable_variable_import = 4

    The reusable variable imports that failed.

  • repeated Failure failed_reinitialize_reusable_variable = 5

    The reusable variable reinitializations that failed.

  • repeated Failure failed_function_to_run = 6

    The function to run on all workers that failed.

• rpc Wait (WaitRequest, WaitReply)

  ray.proto:64

  Polls the scheduler to see what objectids can be retrieved in the input list.

  message WaitRequest

  ray.proto:176

  • repeated uint64 objectids = 1

    List of objectids to be checked.

  message WaitReply

  ray.proto:180

  • repeated uint64 indices = 1

    List of indices that correspond to objectids in the original list that are ready.

• rpc Die (DieRequest, AckReply)

  ray.proto:288

  Kills this worker

  message DieRequest

  ray.proto:308

  (message has no fields)

• rpc ExecuteTask (ExecuteTaskRequest, AckReply)

  ray.proto:284

  Scheduler calls a function from the worker

  message ExecuteTaskRequest

  ray.proto:292

  • optional Task task = 1

    Contains name of the function to be executed and arguments

• rpc ImportRemoteFunction (ImportRemoteFunctionRequest, AckReply)

  ray.proto:286

  Scheduler imports a function into the worker

  message ImportRemoteFunctionRequest

  ray.proto:300

  • optional Function function = 1

• rpc ImportReusableVariable (ImportReusableVariableRequest, AckReply)

  ray.proto:287

  Scheduler imports a reusable variable into the worker

  message ImportReusableVariableRequest

  ray.proto:304

  • optional ReusableVar reusable_variable = 1

    The reusable variable to export.

• rpc PrintErrorMessage (PrintErrorMessageRequest, AckReply)

  ray.proto:289

  Causes an error message to be printed.

  message PrintErrorMessageRequest

  ray.proto:322

  • optional Failure failure = 1

    The failure object.

• rpc RunFunctionOnWorker (RunFunctionOnWorkerRequest, AckReply)

  ray.proto:285

  Runs a function on the worker.

  message RunFunctionOnWorkerRequest

  ray.proto:296

  • optional Function function = 1

Used as response type in: ObjStore.DeallocateObject, ObjStore.NotifyAlias, ObjStore.StartDelivery, Scheduler.AddContainedObjectIDs, Scheduler.AliasObjectIDs, Scheduler.DecrementCount, Scheduler.DecrementRefCount, Scheduler.ExportRemoteFunction, Scheduler.ExportReusableVariable, Scheduler.IncrementCount, Scheduler.IncrementRefCount, Scheduler.NotifyFailure, Scheduler.ObjReady, Scheduler.ReadyForNewTask, Scheduler.RegisterRemoteFunction, Scheduler.RequestObj, Scheduler.RunFunctionOnAllWorkers, WorkerService.Die, WorkerService.ExecuteTask, WorkerService.ImportRemoteFunction, WorkerService.ImportReusableVariable, WorkerService.PrintErrorMessage, WorkerService.RunFunctionOnWorker

(message has no fields)

Used in: Task

• uint64 objectid = 1

  The objectid for the argument.

• string serialized_arg = 2

  A serialized representation of an argument passed by value.

Used in: Obj

• repeated uint64 shape = 1

• sint64 dtype = 2

• bool is_scalar = 8

• repeated double double_data = 3

• repeated float float_data = 4

• repeated sint64 int_data = 5

• repeated uint64 uint_data = 6

• repeated uint64 objectid_data = 7

Used in: Obj

• bool data = 1

Used as request type in: Scheduler.DecrementCount, Scheduler.IncrementCount

• uint64 objectid = 1

  Object ID of the object whose reference count is increased or decreased

Used in: SchedulerInfoReply

• repeated Operation operation = 1

Used in: Obj

• repeated DictEntry elem = 1

Used in: Dict

• optional Obj key = 1

• optional Obj value = 2

Used in: Obj

• double data = 1

Empty used to represent a None object

Used in: Obj

(message has no fields)

Used in: Failure

• FailedTask = 0

• FailedRemoteFunctionImport = 1

• FailedReusableVariableImport = 2

• FailedReinitializeReusableVariable = 3

• FailedFunctionToRun = 4

Used to represent exceptions thrown in Python. This will happen when a task fails to execute, a remote function fails to be imported, or a reusable variable fails to be imported.

Used in: NotifyFailure, NotifyFailureRequest, PrintErrorMessageRequest, TaskInfoReply

• FailedType type = 1

  The type of the failure.

• uint64 workerid = 2

  The id of the worker on which the failure occurred.

• string worker_address = 3

  The address of the worker on which the failure occurred. This contains the same information as the workerid.

• string name = 4

  The name of the failed object.

• string error_message = 5

  The error message from the failure.

Used in: SchedulerInfoReply

• repeated uint64 workerid = 1

  ID of the worker that can execute the function

• uint64 num_return_vals = 2

  Number of return values of the function

Used for shipping remote functions to workers

Used in: ExportRemoteFunctionRequest, ImportRemoteFunctionRequest, ReusableVar, RunFunctionOnAllWorkersRequest, RunFunctionOnWorkerRequest, WorkerMessage

• string name = 1

• bytes implementation = 2

Used in: Operation

• uint64 objectid = 1

  The objectid for the object that is retrieved

• uint64 objectid = 1

  Object ID of the object being requested by the worker

Used in: Obj

• int64 data = 1

Used in: Obj

• repeated Obj elem = 1

Used in: Obj

• int64 data = 1

• optional Failure failure = 1

  The failure object.

Union of possible object types

Used in: DictEntry, List, ObjStoreInfoReply, Tuple

• optional String string_data = 1

• optional Unicode unicode_data = 13

• optional Int int_data = 2

• optional Long long_data = 12

• optional Double double_data = 3

• optional Bool bool_data = 10

• optional Tuple tuple_data = 7

• optional List list_data = 4

• optional Dict dict_data = 8

• optional Array array_data = 5

• optional Empty empty_data = 9

• optional ObjID objectid_data = 11

• optional PyObj pyobj_data = 6

Used in: Obj

• uint64 data = 1

Used in: SchedulerInfoReply

• uint64 objstoreid = 1

  The ID of the object store.

• string address = 2

  The address of the object store.

This is used internally by the scheduler. From the scheduler's perspective, the submission of tasks (via SubmitTask) and the submission of puts (via PutObj) look very similar, and so it is useful to be able to handle them together (for example in the computation graph).

Used in: CompGraph

• optional Task task = 1

• optional Put put = 2

• optional Get get = 4

• uint64 creator_operationid = 3

  The id of the task that called this task or put.

Used in: Operation

• uint64 objectid = 1

  The objectid for the object that was put

Used in: Obj

• bytes data = 1

• uint64 handle = 1

  Handle to memory segment where object is stored

• uint64 objectid = 1

  ID of object that gets registered

Used in: ExportReusableVariableRequest, ImportReusableVariableRequest, WorkerMessage

• string name = 1

  The name of the reusable variable.

• optional Function initializer = 2

  A serialized version of the function that initializes the reusable variable.

• optional Function reinitializer = 3

  A serialized version of the function that reinitializes the reusable variable.

Used in: Obj

• bytes data = 1

Used in: ExecuteTaskRequest, Operation, SubmitTaskRequest, WorkerMessage

• string name = 1

  Name of the function call. Must not be empty.

• repeated Arg arg = 2

  List of object IDs of the arguments to the function.

• repeated uint64 result = 3

  Object IDs for result

Used in: TaskInfoReply

• uint64 operationid = 1

• string function_name = 2

• string worker_address = 3

• string error_message = 4

Used in: Obj

• repeated Obj elem = 1

Used in: Obj

• string data = 1

This message is used by the worker service to send messages to the worker that are processed by the worker's main loop.

• oneof worker_item

  • Task task = 1

    A task for the worker to execute.

  • Function function = 2

    A remote function to import on the worker.

  • ReusableVar reusable_variable = 3

    A reusable variable to import on the worker.

  • Function function_to_run = 4

    An arbitrary function to run on the worker.