Struct HloPassMetadata 

pub struct HloPassMetadata {
    pub pass_id: i64,
    pub pass_name: String,
    pub pipeline_name: String,
    pub dump_filenames: Vec<String>,
    pub module_changed: bool,
    pub module_id: i64,
    pub module_group_module_ids: Vec<i64>,
    pub start_timestamp_usec: i64,
    pub end_timestamp_usec: i64,
    pub custom_metadata: Option<Any>,
}

Metadata for one run of an HLO pass on a module. Provides more information when processing debug dumps of HloProtos about the order of HLO passes and various other stats like duration. pass_id may also be used to identify a particular run of a pass in debug info that propagates through stages of compilation.

Fields

pass_id: i64

For a given module, pass_id uniquely identifies a run of an HLO pass on that module. Note that a pass_id may not always refer to the same pass because the order of passes during compilation may change. For finding metadata for a particular pass, pass_name and pipeline_name would be more reliable, although note that they may not be unique.

pass_name: String

pipeline_name: String

dump_filenames: Vec<String>

Filenames of the dumps of the module after this pass ran. Module may be dumped in multiple formats, and the order of formats in this field will stay consistent across passes.

module_changed: bool

Return value of pass.Run(). True if this pass changed the module, or, in the case where the module was run through this pass as part of a module group, true if this pass changed any module in the same module group.

module_id: i64

The unique_id of the module that this pass is run on. May be different from the canonical_module_id of the HloModuleMetadata that this HloPassMetadata is inside.

module_group_module_ids: Vec<i64>

If the module went through this pass as part of a module group, this is set as the ids of all the modules in the module group. Empty otherwise.

start_timestamp_usec: i64

Timestamp before and after the pass is run. Note they may be equal.

end_timestamp_usec: i64

custom_metadata: Option<Any>

Custom metadata for the pass.

Trait Implementations

impl Clone for HloPassMetadata

fn clone(&self) -> HloPassMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HloPassMetadata

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

Formats the value using the given formatter.

impl Default for HloPassMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for HloPassMetadata

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 HloPassMetadata

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