Struct State 

pub struct State {
    pub input_name: String,
    pub output_name: String,
    pub data_type: i32,
    pub dims: Vec<i64>,
    pub initial_state: Vec<InitialState>,
    pub use_same_buffer_for_input_output: bool,
    pub use_growable_memory: bool,
}

@@ .. cpp:var:: message State @@ @@ An input / output pair of tensors that carry state for the sequence. @@

Fields

input_name: String

@@ .. cpp:var:: string input_name @@ @@ The name of the model state input. @@

output_name: String

@@ .. cpp:var:: string output_name @@ @@ The name of the model state output. @@

data_type: i32

@@ .. cpp:var:: DataType data_type @@ @@ The data-type of the state. @@

dims: Vec<i64>

@@ .. cpp:var:: int64 dim (repeated) @@ @@ The dimension. @@

initial_state: Vec<InitialState>

@@ .. cpp:var:: InitialState initial_state (repeated) @@ @@ The optional field to specify the initial state for the model. @@

use_same_buffer_for_input_output: bool

@@ .. cpp:var:: bool use_same_buffer_for_input_output @@ @@ The optional field to use a single buffer for both input and output @@ state. Without this option, Triton allocates separate buffers @@ for input and output state @@ which can be problematic if the state size is @@ large. This option reduces the memory usage by allocating a single @@ buffer. Enabling this option is recommended whenever @@ the input state is processed before the output state is written. @@ When enabled the state @@ will always be updated independent of whether @@ TRITONBACKEND_StateUpdate is called @@ (however TRITONBACKEND_StateUpdate should still be called for @@ completeness). @@ @@ The default value is false. @@

use_growable_memory: bool

@@ .. cpp:var:: bool use_growable_memory @@ @@ The optional field to enable an implicit state buffer to grow @@ without reallocating or copying existing memory. @@ Additional memory will be appended to the end of the buffer and @@ existing data will be preserved. @@ This option is only available for CUDA memory and requires enabling @@ use_same_buffer_for_input_output. When using this option, @@ StateBuffer call will always return CUDA memory even if CPU memory @@ is requested. @@ @@ The default value is false. @@

Implementations

impl State

pub fn data_type(&self) -> DataType

Returns the enum value of data_type, or the default if the field is set to an invalid enum value.

pub fn set_data_type(&mut self, value: DataType)

Sets data_type to the provided enum value.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.

impl Message for State

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for State

fn eq(&self, other: &State) -> 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 State