Struct ModelInput

pub struct ModelInput {
    pub name: String,
    pub data_type: i32,
    pub format: i32,
    pub dims: Vec<i64>,
    pub reshape: Option<ModelTensorReshape>,
    pub is_shape_tensor: bool,
    pub allow_ragged_batch: bool,
    pub optional: bool,
}

@@ @@.. cpp:var:: message ModelInput @@ @@ An input required by the model. @@

Fields

name: String

@@ .. cpp:var:: string name @@ @@ The name of the input. @@

data_type: i32

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

format: i32

@@ .. cpp:var:: Format format @@ @@ The format of the input. Optional. @@

dims: Vec<i64>

@@ .. cpp:var:: int64 dims (repeated) @@ @@ The dimensions/shape of the input tensor that must be provided @@ when invoking the inference API for this model. @@

reshape: Option<ModelTensorReshape>

@@ .. cpp:var:: ModelTensorReshape reshape @@ @@ The shape expected for this input by the backend. The input will @@ be reshaped to this before being presented to the backend. The @@ reshape must have the same number of elements as the input shape @@ specified by ‘dims’. Optional. @@

is_shape_tensor: bool

@@ .. cpp:var:: bool is_shape_tensor @@ @@ Whether or not the input is a shape tensor to the model. This field @@ is currently supported only for the TensorRT model. An error will be @@ generated if this specification does not comply with underlying @@ model. @@

allow_ragged_batch: bool

@@ .. cpp:var:: bool allow_ragged_batch @@ @@ Whether or not the input is allowed to be “ragged” in a dynamically @@ created batch. Default is false indicating that two requests will @@ only be batched if this tensor has the same shape in both requests. @@ True indicates that two requests can be batched even if this tensor @@ has a different shape in each request. @@

optional: bool

@@ .. cpp:var:: bool optional @@ @@ Whether or not the input is optional for the model execution. @@ If true, the input is not required in the inference request. @@ Default value is false. @@

Implementations

impl ModelInput

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.

pub fn format(&self) -> Format

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

pub fn set_format(&mut self, value: Format)

Sets format to the provided enum value.

Trait Implementations

impl Clone for ModelInput

fn clone(&self) -> ModelInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelInput

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

Formats the value using the given formatter.

impl Default for ModelInput

fn default() -> Self

Returns the “default value” for a type.

impl Message for ModelInput

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_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated 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 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<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 ModelInput

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