Struct OpMetadata 

pub struct OpMetadata {
    pub op_type: String,
    pub op_name: String,
    pub source_file: String,
    pub source_line: i32,
    pub profile_type: Vec<i32>,
    pub size_of_generated_code_in_bytes: i64,
    pub size_of_memory_working_set_in_bytes: i64,
    pub profile_info: Option<ProfileInfo>,
    pub deduplicated_name: String,
    pub preserve_layout: bool,
    pub stack_frame_id: i32,
    pub scheduling_name: String,
}

Symbolization metadata for HLO Instructions.

This metadata is used for debugging XLA code generation, as well as performance profiling of XLA-generated executables.

Fields

op_type: String

The framework op name that generated this XLA op.

Frameworks that build on top of XLA should mirror the names of their ops back to users by specifying the op_type. In this way, even if the framework’s “ops” are implemented as multiple XLA HLO Ops, they can be grouped appropriately. (e.g. if a SoftMax layer is emitted into XLA as multiple ops, then each op should have the op_type be “SoftMax”.)

op_name: String

The user-specified name of the op.

This name is often unique within a computation. Note: some frameworks add auto-generated names if the user does not provide one.

source_file: String

Indicate a file and line that this op is associated to in a user’s program.

e.g. it could be the file and line of user code that generated the op.

source_line: i32

profile_type: Vec<i32>

👎Deprecated

Deprecated, use [ProfileInfo][profile_type] instead.

size_of_generated_code_in_bytes: i64

The footprint of the generated code for the instruction.

size_of_memory_working_set_in_bytes: i64

The size of the working set, i.e., the amount of memory, used by the instruction in a compiler-managed fast device memory.

profile_info: Option<ProfileInfo>

Profile information for the Op.

deduplicated_name: String

Deduplicated HLO name for this op. In some cases, we can have multiple instructions (e.g. fusions) that are considered duplicates. We want to group them together under the same name so that we can group them together during analysis (e.g. HLO Op Profile tool in Xprof). E.g. If we have fusion.1, fusion.2, and fusion.3 marked as duplicates, fusion.2 and fusion.3 will have deduplicated_name = fusion.1

preserve_layout: bool

Whether to preserve the layout of the HLO op.

stack_frame_id: i32

1-based position of the frame in frames flat array. Ids are 1-based to keep 0 value as representation of non-set property.

scheduling_name: String

Instruction name available upon scheduling.

Implementations

impl OpMetadata

pub fn profile_type( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<ProfileType>>

Returns an iterator which yields the valid enum values contained in profile_type.

pub fn push_profile_type(&mut self, value: ProfileType)

Appends the provided enum value to profile_type.

Trait Implementations

impl Clone for OpMetadata

fn clone(&self) -> OpMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpMetadata

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

Formats the value using the given formatter.

impl Default for OpMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for OpMetadata

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 OpMetadata

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