Enum pjrt_sys::protos::stream_executor::dnn::DataLayout

#[repr(i32)]
pub enum DataLayout {
    KYxDepthBatch = 0,
    KYxBatchDepth = 1,
    KBatchYxDepth = 2,
    KBatchDepthYx = 3,
    KBatchDepthYx4 = 4,
    KBatchDepthYx32 = 5,
}

Describes how a convolution input or output layer’s data is formatted.

Variants

KYxDepthBatch = 0

Naming convention: Y <-> row or height X <-> column or width Batch <-> batch, or N Depth <-> feature, or channel TODO(timshen): turn them into cuDNN names, e.g. kNCHW.

Note: In cudnn, kBatchDepthYX4 and kBatchDepthYX32 are the same layout (namely, NCHW_VECT_C). It differentiates between these two by using a different data type (int8x4 vs int8x32). In StreamExecutor we use different layouts for these, because we don’t usually pass an explicit data type to StreamExecutor functions.

KYxBatchDepth = 1

KBatchYxDepth = 2

cuDNN’s NHWC layout

KBatchDepthYx = 3

cuDNN’s NCHW layout

KBatchDepthYx4 = 4

cuDNN’s NCHW_VECT_C with 4-elem vectors (e.g. int8x4)

KBatchDepthYx32 = 5

cuDNN’s NCHW_VECT_C with 32-elem vects (e.g. int8x32)

Implementations

impl DataLayout

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of DataLayout.

pub fn from_i32(value: i32) -> Option<DataLayout>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a DataLayout, or None if value is not a valid variant.

impl DataLayout

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for DataLayout

fn clone(&self) -> DataLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataLayout

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

Formats the value using the given formatter.

impl Default for DataLayout

fn default() -> DataLayout

Returns the “default value” for a type.

impl From<DataLayout> for i32

fn from(value: DataLayout) -> i32

Converts to this type from the input type.

impl Hash for DataLayout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DataLayout

fn cmp(&self, other: &DataLayout) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DataLayout

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

fn partial_cmp(&self, other: &DataLayout) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for DataLayout

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<DataLayout, UnknownEnumValue>

Performs the conversion.

impl Copy for DataLayout

impl Eq for DataLayout

impl StructuralPartialEq for DataLayout