package tensorflow.profiler

Get desktop application:
View/edit binary Protocol Buffers messages

An XEvent is a trace event, optionally annotated with XStats. Next ID: 6

Used in: XLine

• int64 metadata_id = 1

  XEventMetadata.id of corresponding metadata.

• oneof data

  • int64 offset_ps = 2

    Start time of the event in picoseconds, as offset from XLine.timestamp_ns().

  • int64 num_occurrences = 5

    Number of occurrences of the event, if aggregated.

• int64 duration_ps = 3

  Duration of the event in picoseconds. Can be zero for an instant event.

• repeated XStat stats = 4

  XStats associated with the event.

Metadata for an XEvent, shared by all instances of the same event. Next ID: 5

Used in: XPlane

• int64 id = 1

  XPlane.event_metadata map key.

• string name = 2

  Name of the event.

• string display_name = 4

  Name of the event shown in trace viewer.

• bytes metadata = 3

  Additional metadata in serialized format.

An XLine is a timeline of trace events (XEvents). Next ID: 12

Used in: XPlane

• int64 id = 1

  Id of this line, can be repeated within an XPlane. All XLines with the same id are effectively the same timeline.

• int64 display_id = 10

  Display id of this line. Multiple lines with the same display_id are grouped together in the same trace viewer row.

• string name = 2

  Name of this XLine.

• string display_name = 11

  Name of this XLine to display in trace viewer.

• int64 timestamp_ns = 3

  Start time of this line in nanoseconds since the UNIX epoch. XEvent.offset_ps is relative to this timestamp.

• int64 duration_ps = 9

  Profiling duration for this line in picoseconds.

• repeated XEvent events = 4

  XEvents within the same XLine should not overlap in time, but they can be nested.

An XPlane is a container of parallel timelines (XLines), generated by a profiling source or by post-processing one or more XPlanes. Next ID: 7

Used in: XSpace

• int64 id = 1

• string name = 2

  Name of this line.

• repeated XLine lines = 3

  Parallel timelines grouped in this plane. XLines with the same id are effectively the same timeline.

• map<int64, XEventMetadata> event_metadata = 4

  XEventMetadata map, each entry uses the XEventMetadata.id as key. This map should be used for events that share the same ID over the whole XPlane.

• map<int64, XStatMetadata> stat_metadata = 5

  XStatMetadata map, each entry uses the XStatMetadata.id as key. This map should be used for stats that share the same ID over the whole XPlane.

• repeated XStat stats = 6

  XStats associated with this plane, e.g. device capabilities.

A container of parallel XPlanes, generated by one or more profiling sources. Next ID: 4

• repeated XPlane planes = 1

• repeated string errors = 2

  Errors (if any) in the generation of planes.

• repeated string warnings = 3

  Warnings (if any) in the generation of planes;

An XStat is a named value associated with an XEvent, e.g., a performance counter value, a metric computed by a formula applied over nested XEvents and XStats. Next ID: 8

Used in: XEvent, XPlane

• int64 metadata_id = 1

  XStatMetadata.id of corresponding metadata.

• oneof value

  Value of this stat.

  • double double_value = 2

  • uint64 uint64_value = 3

  • int64 int64_value = 4

  • string str_value = 5

  • bytes bytes_value = 6

  • uint64 ref_value = 7

    A string value that stored in XStatMetadata::name.

Metadata for an XStat, shared by all instances of the same stat. Next ID: 4

Used in: XPlane

• int64 id = 1

  XPlane.stat_metadata map key.

• string name = 2

  Name of the stat (should be short).

• string description = 3

  Description of the stat (might be long).