package tensorflow.tpu

Get desktop application:
View/edit binary Protocol Buffers messages

A 'device' is a physical entity in the system and is comprised of several resources.

Used in: Trace

• string name = 1

  The name of the device.

• uint32 device_id = 2

  The id of this device, unique in a single trace.

• map<uint32, Resource> resources = 3

  The resources on this device, keyed by resource_id;

Result proto for HloExtraInfoMap.

Used in: TfOpStats

• map<string, HloExtraInfoResult> hlo_extrainfo_map = 1

  A map from HLO name to HloExtraInfo.

Result proto for HloExtraInfo.

Used in: HloExtraInfoMapResult

• optional string category = 1

  Category of the HLO op given by the compiler.

• optional string long_name = 2

  The long name of the HLO that includes the dimensions.

• optional int64 per_core_batch_size = 3

  The per-TPU-core batch size inferred from this HLO.

Result proto for host-dependent job information.

Used in: RunEnvironmentResult

• optional string host_id = 1

  This ID of the host where the job was run on.

• optional string command_line = 2

  The command line used to run the job.

• optional int64 start_time = 3

  The start time of the job on this host.

Result proto for host-independent job information.

Used in: RunEnvironmentResult

• optional int64 change_list = 1

  The change-list number of this build.

• optional int64 build_time = 2

  The time of this build.

• optional string build_target = 3

  The target of this build.

Result proto for looping-related metrics.

Used in: TfOpStats

• optional double iteration_time_ns = 1

  The total iteration time in nanoseconds.

• optional int32 num_iterations = 2

  The total number of iterations.

• optional double computation_time_ns = 3

  The total computation time in nanoseconds.

• optional int32 num_computations = 4

  The total number of computations.

Result proto for OpMetricsDb.

Used in: TfOpStats

• repeated OpMetricsResult metrics_db = 1

  A bunch of OpMetricsResults.

Result proto for OpMetrics.

Used in: OpMetricsDbResult

• optional bool on_device = 1

  True if this OP is executed on the device; False if it is executed on the host.

• optional string name = 3

  Name of this OP.

• optional uint64 rank = 4

  Rank of this OP.

• optional double last_starttime_in_cycles = 5

  The starting time in cycles of the last instance of this OP executed.

• optional double last_endtime_in_cycles = 6

  The ending time in cycles of the last instance of this OP executed.

• optional double sum_of_duration_in_us_as_children = 7

  If this OP (say A), is an immediate child of another OP (say B), this field stores the sum of duration in microseconds of A inside B. If A appears more than once in B, the duration of all A's appearances will be added together. This sum will be reset after the self-time of B is calculated so that it can be reused for a new parent OP.

• optional uint64 occurrences = 8

  Number of instances that this OP occurred.

• optional double total_time_in_us = 9

  Total time in microseconds spent in this OP (accumulated over all of its occurrences).

• optional double total_self_time_in_us = 10

  Total self time in microseconds spent in this OP (accumulated over all of its occurrences).

• optional double host_total_self_time_as_fraction_of_all_op_time = 11

  The total self time as a fraction of sum of all OP's total self time on the host.

• optional double host_cumulative_total_self_time_as_fraction_of_all_op_time = 12

  Cumulative total self time in fraction on the host.

• optional double device_total_self_time_as_fraction_of_all_op_time = 13

  The total self time as a fraction of sum of all OP's total self time on the device.

• optional double device_cumulative_total_self_time_as_fraction_of_all_op_time = 14

  Cumulative total self time in fraction on the device.

• optional double total_flops = 15

  Total number of FLOPs incurred by this OP.

• optional double total_bytes_accessed = 16

  Total number of bytes accessed by this OP.

• optional double unit1_occupancy_in_us = 17

  Total time in microseconds that special hw unit 1 is occupied by this OP.

• optional double unit2_occupancy_in_us = 18

  Total time in microseconds that special hw unit 2 is occupied by this OP.

• optional double total_memory_stall_in_us = 19

  Total memory stall time in microseconds.

A 'resource' generally is a specific computation component on a device. These can range from threads on CPUs to specific arithmetic units on hardware devices.

Used in: Device

• string name = 1

  The name of the resource.

• uint32 resource_id = 2

  The id of the resource. Unique within a device.

Result proto for RunEnvironment (the run environment of a profiling session).

Used in: TfOpStats

• optional int32 host_count = 1

  Number of hosts used.

• optional string tpu_type = 2

  The type of TPU used.

• optional int32 tpu_core_count = 3

  The number of TPU cores used.

• optional int32 per_core_batch_size = 4

  The per-TPU-core batch size.

• optional HostIndependentJobInfoResult host_independent_job_info = 5

  Host-independent job information.

• repeated HostDependentJobInfoResult host_dependent_job_info = 6

  Host-dependent job information.

Result proto for a StepDatabase.

Used in: TfOpStats

• map<uint32, StepSequenceResult> step_sequence_per_core = 1

  A map from core_id to StepSequenceResult.

Result proto for StepInfo.

Used in: StepSequenceResult

• optional uint32 step_num = 1

  The (micro) step number.

• optional uint64 duration_ps = 2

  The step duration in picoseconds.

• optional uint64 infeed_duration_ps = 3

  The infeed duration in picoseconds. Can turn into a map if we want a variable number of ops.

Result proto for a sequence of steps.

Used in: StepDatabaseResult

• repeated StepInfoResult step_sequence = 1

  A sequence of StepInfoResults.

Result proto for TfStatsHelper.

• optional OpMetricsDbResult tf_metrics_db = 1

  The result for the TF-metric database.

• optional OpMetricsDbResult hlo_metrics_db = 2

  The result for the HLO-metric database.

• optional StepDatabaseResult step_db = 3

  The result for the step database.

• optional LoopingResult looping = 4

  The result for the looping-related metrics.

• optional HloExtraInfoMapResult hlo_extrainfo_map = 5

  The result for the HloExtraInfoMap.

• optional double matrix_unit_utilization_percent = 6

  Overall matrix unit utilization in percentage.

• optional RunEnvironmentResult run_environment = 7

  The run environment of this profiling session.

Describes the geometry of a TPU mesh.

• repeated int32 mesh_shape = 1

  The dimensions of the TPU topology, in cores. Typically, this is a 3D topology [x, y, core], where the major dimensions correspond to TPU chips, and the minor dimension describes the number of cores on a multicore chip.

• int32 num_tasks = 2

  Number of TensorFlow tasks in the cluster.

• int32 num_tpu_devices_per_task = 3

  Number of TPU devices per task.

• repeated int32 device_coordinates = 4

  A flattened rank 3 int32 array with shape [num_tasks, num_tpu_devices_per_task, len(mesh_shape)]. `tasks` is the number of tasks in the TPU cluster, `devices` is the number of TPU devices per task, and the minor dimension corresponds to a position in the TPU mesh topology. Each entry [task, device, axis] gives the `axis`-th coordinate in the topology of a task/device pair.

A 'Trace' contains metadata for the individual traces of a system.

• map<uint32, Device> devices = 1

  The devices that this trace has information about. Maps from device_id to more data about the specific device.

• repeated TraceEvent trace_events = 4

  All trace events capturing in the profiling period.

Used in: Trace

• uint32 device_id = 1

  The id of the device that this event occurred on. The full dataset should have this device present in the Trace object.

• uint32 resource_id = 2

  The id of the resource that this event occurred on. The full dataset should have this resource present in the Device object of the Trace object. A resource_id is unique on a specific device, but not necessarily within the trace.

• string name = 3

  The name of this trace event.

• uint64 timestamp_ps = 9

  The timestamp that this event occurred at (in picos since tracing started).

• uint64 duration_ps = 10

  The duration of the event in picoseconds if applicable. Events without duration are called instant events.