Struct RunGraphRequest

pub struct RunGraphRequest {
    pub session_handle: String,
    pub create_worker_session_called: bool,
    pub graph_handle: String,
    pub step_id: i64,
    pub exec_opts: Option<ExecutorOpts>,
    pub send: Vec<NamedTensorProto>,
    pub recv_key: Vec<String>,
    pub is_partial: bool,
    pub is_last_partial_run: bool,
    pub store_errors_in_response_body: bool,
    pub request_id: i64,
}

Fields

session_handle: String

session_handle is the master-generated unique id for this session. If session_handle is non-empty, it must be the same as used when registering the graph. If it is empty, a single global namespace is used to search for the graph_handle.

create_worker_session_called: bool

Set to true if CreateWorkerSession was called for session_handle.

graph_handle: String

REQUIRED: graph_handle must be returned by a RegisterGraph call to the same WorkerService.

step_id: i64

A unique ID to distinguish different runs of the same graph.

The master generates a global unique step_id to distinguish different runs of the graph computation. Subgraphs communicate (e.g., send/recv ops) with each other using step_id to distinguish tensors generated by different runs.

exec_opts: Option<ExecutorOpts>

Options for this step.

send: Vec<NamedTensorProto>

Runs the graph.

Sends the tensors in “send” into the graph before the run and fetches the keys into RunGraphResponse.recv after the run.

recv_key: Vec<String>

is_partial: bool

True if the RunGraphRequest is a partial run request.

is_last_partial_run: bool

True if this is the last partial run request in a sequence of requests.

store_errors_in_response_body: bool

If true then some errors, e.g., execution errors that have long error messages, may return an OK RunGraphResponse with the actual error saved in the status_code/status_error_message fields of the response body. This is a workaround since the RPC subsystem may truncate long metadata messages.

request_id: i64

Unique identifier for this request. Every RunGraphRequest must have a unique request_id, and retried RunGraphRequests must have the same request_id. If request_id is zero, retry detection is disabled.

Retried RunGraphRequests are problematic because they may issue a RecvTensor that will have no corresponding sender and will wait forever. Workers use request_ids to reject retried RunGraph requests instead of waiting forever.

Trait Implementations

impl Clone for RunGraphRequest

fn clone(&self) -> RunGraphRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RunGraphRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RunGraphRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RunGraphRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RunGraphRequest

fn eq(&self, other: &RunGraphRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RunGraphRequest