[rocprof-compute] update yamls for docs (#1887)

2025-11-19 10:46:02 -05:00
commit c778acdb70
@@ -1,7 +1,6 @@
-# AUTOGENERATED FILE. Only edit for testing purposes, not for development. Generated from utils/unified_config.yaml. Generated by utils/split_config.py
 Wavefront launch stats:
  AGPRs:
-    rst: |-
+    rst: >-
      The number of accumulation vector general-purpose registers allocated
      for the kernel, see :ref:`AGPRs <desc-agprs>`. Note: this may not exactly match
      the number of AGPRs requested by the compiler due to allocation granularity.
@@ -12,7 +11,7 @@ Wavefront launch stats:
      total workgroup (or, block) size.
    unit: Work-Items
  LDS Allocation:
-    rst: |-
+    rst: >-
      The number of bytes of :doc:`LDS <local-data-share>` memory (or, shared memory)
      allocated for this kernel. Note: This may also be larger than what was requested
      at compile time due to both allocation granularity and dynamic per-dispatch
@@ -23,7 +22,7 @@ Wavefront launch stats:
      <https://docs.kernel.org/gpu/amdgpu/module-parameters.html?highlight=cwsr>`_.
    unit: Wavefronts
  SGPRs:
-    rst: |-
+    rst: >-
      The number of scalar general-purpose registers allocated for the kernel, see
      :ref:`SALU <desc-salu>`. Note: this may not exactly match the number of
      SGPRs requested by the compiler due to allocation granularity.
@@ -38,14 +37,14 @@ Wavefront launch stats:
      as well as for register spills and restores.
    unit: Bytes per work-item
  Total Wavefronts:
-    rst: |-
+    rst: >-
      The total number of wavefronts launched as part of the kernel dispatch.
      On AMD Instinct\u2122 CDNA\u2122 accelerators and GCN\u2122 GPUs, the wavefront
      size is always 64 work-items. Thus, the total number of wavefronts should
      be equivalent to the ceiling of grid size divided by 64.
    unit: Wavefronts
  VGPRs:
-    rst: |-
+    rst: >-
      The number of architected vector general-purpose registers allocated for the
      kernel, see :ref:`VALU <desc-valu>`. Note: this may not exactly match the
      number of VGPRs requested by the compiler due to allocation granularity.
@@ -98,14 +97,14 @@ Wavefront runtime stats:
    rst: The total duration of the executed kernel in cycles.
    unit: Cycles
  Wave Cycles:
-    rst: |-
+    rst: >-
      The number of cycles a wavefront in the kernel dispatch spent resident
      on a compute unit per :ref:`normalization unit <normalization-units>`. This is
      averaged over all wavefronts in a kernel dispatch. Note: this should not
      be directly compared to the kernel cycles above.
    unit: Cycles per normalization unit
  Wavefront Occupancy:
-    rst: |-
+    rst: >-
      The time-averaged number of wavefronts resident on the accelerator over the
      lifetime of the kernel. Note: this metric may be inaccurate for short-running
      kernels (less than 1ms).
@@ -148,7 +147,7 @@ Overall instruction mix:
    unit: Instructions
 VALU arithmetic instruction mix:
  Conversion:
-    rst: |-
+    rst: >-
      The total number of type conversion instructions (such as converting data
      to or from F32\u2194F64) issued to the VALU per :ref:`normalization unit
      <normalization-units>`.
@@ -240,7 +239,7 @@ MFMA instruction mix:
    unit: Instructions per normalization unit
 Compute Speed-of-Light:
  MFMA FLOPs (BF16):
-    rst: |-
+    rst: >-
      The total number of 16-bit brain floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 16-bit brain floating
      point operations from :ref:`VALU <desc-valu>` instructions. This is also
@@ -248,7 +247,7 @@ Compute Speed-of-Light:
      on the specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F16):
-    rst: |-
+    rst: >-
      The total number of 16-bit floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 16-bit floating point
      operations from :ref:`VALU <desc-valu>` instructions. This is also presented
@@ -256,7 +255,7 @@ Compute Speed-of-Light:
      specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F32):
-    rst: |-
+    rst: >-
      The total number of 32-bit floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 32-bit floating point
      operations from :ref:`VALU <desc-valu>` instructions. This is also presented
@@ -264,7 +263,7 @@ Compute Speed-of-Light:
      specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F64):
-    rst: |-
+    rst: >-
      The total number of 64-bit floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 64-bit floating point
      operations from :ref:`VALU <desc-valu>` instructions. This is also presented
@@ -276,21 +275,21 @@ Compute Speed-of-Light:
      achievable on the specific accelerator.
    unit: GFLOPs
  MFMA IOPs (INT8):
-    rst: |-
+    rst: >-
      The total number of 8-bit integer :ref:`MFMA <desc-mfma>` operations executed
      per second. Note: this does not include any 8-bit integer operations from
      :ref:`VALU <desc-valu>` instructions. This is also presented as a percent
      of the peak theoretical INT8 MFMA operations achievable on the specific accelerator.
    unit: GFLOPs
  VALU FLOPs:
-    rst: |-
+    rst: >-
      The total floating-point operations executed per second on the :ref:`VALU
      <desc-valu>`. This is also presented as a percent of the peak theoretical
      FLOPs achievable on the specific accelerator. Note: this does not include
      any floating-point operations from :ref:`MFMA <desc-mfma>` instructions.
    unit: GFLOPs
  VALU IOPs:
-    rst: |-
+    rst: >-
      The total integer operations executed per second on the :ref:`VALU <desc-valu>`.
      This is also presented as a percent of the peak theoretical IOPs achievable
      on the specific accelerator. Note: this does not include any integer operations
@@ -361,7 +360,7 @@ Pipeline statistics:
    unit: Percent
 Arithmetic operations:
  BF16 OPs:
-    rst: |-
+    rst: >-
      The total number of 16-bit brain floating-point operations executed on
      either the :ref:`VALU <desc-valu>` or :ref:`MFMA <desc-mfma>` units, per :ref:`normalization
      unit <normalization-units>`. Note: on current CDNA accelerators, the VALU
@@ -388,7 +387,7 @@ Arithmetic operations:
      <normalization-units>`.
    unit: FLOP per normalization unit
  INT8 OPs:
-    rst: |-
+    rst: >-
      The total number of 8-bit integer operations executed on either the :ref:`VALU
      <desc-valu>` or :ref:`MFMA <desc-mfma>` units, per :ref:`normalization unit
      <normalization-units>`. Note: on current CDNA accelerators, the VALU has
@@ -460,7 +459,7 @@ LDS Statistics:
      acknowledgment) required for an LDS instruction to complete.
    unit: Cycles
  Mem Violations:
-    rst: |-
+    rst: >-
      The total number of out-of-bounds accesses made to the LDS, per :ref:`normalization
      unit <normalization-units>`. This is unused and expected to be zero in
      most configurations for modern CDNA\u2122 accelerators.
@@ -586,7 +585,7 @@ L1 Unified Translation Cache (UTCL1):
      per normalization unit.
    unit: Requests per normalization unit
  Permission Misses:
-    rst: |-
+    rst: >-
      The total number of translation requests that missed in the UTCL1 due
      to a permission error, per :ref:`normalization unit <normalization-units>`.
      This is unused and expected to be zero in most configurations for modern
@@ -925,7 +924,7 @@ L2-Fabric interface metrics:
      before data was returned to the L2.
    unit: Cycles
  Read Stall:
-    rst: |-
+    rst: >-
      The ratio of the total number of cycles the L2-Fabric interface was stalled
      on a read request to any destination (local HBM, remote PCIe\xAE connected
      accelerator or CPU, or remote Infinity Fabric connected accelerator [#inf]_
@@ -1198,7 +1197,7 @@ Scalar L1D Cache - L2 Interface:
      per :ref:`normalization unit <normalization-units>`.
    unit: Requests per normalization unit
  Stall Cycles:
-    rst: |-
+    rst: >-
      The total number of cycles the sL1D\u2194 :doc:`L2 <l2-cache>` interface
      was stalled, per :ref:`normalization unit <normalization-units>`.
    unit: Cycles per normalization unit
@@ -1208,7 +1207,7 @@ Scalar L1D Cache - L2 Interface:
      CDNA accelerators.
    unit: Requests per normalization unit
  sL1D-L2 BW:
-    rst: |-
+    rst: >-
      The total number of bytes read from, written to, or atomically updated
      across the sL1D\u2194:doc:`L2 <l2-cache>` interface, divided by total duration.
      Note that sL1D writes and atomics are typically
@@ -1227,7 +1226,7 @@ L1I Speed-of-Light:
      over the number of all L1I requests.
    unit: Percent
  L1I-L2 Bandwidth Utilization:
-    rst: |-
+    rst: >-
      The percent of the peak theoretical L1I \u2192 L2 cache request bandwidth
      achieved. Calculated as the ratio of the total number of requests from
      the L1I to the L2 cache over the :ref:`total L1I-L2 interface cycles <total-l1i-cycles>`.
@@ -1286,7 +1285,7 @@ Workgroup manager utilizations:
      not fully saturated by the kernel, or a potential load-imbalance issue.
    unit: Percent
  Scheduler-Pipe Utilization:
-    rst: |-
+    rst: >-
      The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>`
      in the kernel where the scheduler-pipes were actively doing any work. Note: this
      value is expected to range between 0% and 25%. See :ref:`desc-spi`.
@@ -1332,7 +1331,7 @@ Workgroup Manager - Resource Allocation:
      lack of available :ref:`waveslots <desc-valu>`.
    unit: Percent
  Not-scheduled Rate (Scheduler-Pipe):
-    rst: |-
+    rst: >-
      The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>`
      in the kernel where a workgroup could not be scheduled to a :doc:`CU <compute-unit>`
      due to a bottleneck within the scheduler-pipes rather than a lack of a CU
@@ -1341,7 +1340,7 @@ Workgroup Manager - Resource Allocation:
      description.
    unit: Percent
  Not-scheduled Rate (Workgroup Manager):
-    rst: |-
+    rst: >-
      The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>`
      in the kernel where a workgroup could not be scheduled to a :doc:`CU <compute-unit>`
      due to a bottleneck within the workgroup manager rather than a lack of a
@@ -1362,7 +1361,7 @@ Workgroup Manager - Resource Allocation:
      or newer accelerators (and small for previous accelerators).
    unit: Percent
  Scheduler-Pipe Stall Rate:
-    rst: |-
+    rst: >-
      The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>`
      in the kernel where a workgroup could not be scheduled to a :doc:`CU <compute-unit>`
      due to occupancy limitations (like a lack of a CU or :ref:`SIMD <desc-valu>`
@@ -1464,7 +1463,7 @@ System Speed-of-Light:
      over the total number of incoming cache line requests to the L2 cache.
    unit: Percent
  L2-Fabric Read BW:
-    rst: |-
+    rst: >-
      The number of bytes read by the L2 over the :ref:`Infinity Fabric\u2122
      interface <l2-fabric>` per unit time. This is also presented as a percent
      of the peak theoretical bandwidth achievable on the specific accelerator.
@@ -1490,7 +1489,7 @@ System Speed-of-Light:
      Conflict Rate).
    unit: Conflicts/Access
  MFMA FLOPs (BF16):
-    rst: |-
+    rst: >-
      The total number of 16-bit brain floating point :ref:`MFMA <desc-mfma>`
      operations executed per second. Note: this does not include any 16-bit brain
      floating point operations from :ref:`VALU <desc-valu>` instructions. This
@@ -1498,7 +1497,7 @@ System Speed-of-Light:
      achievable on the specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F16):
-    rst: |-
+    rst: >-
      The total number of 16-bit floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 16-bit floating point
      operations from :ref:`VALU <desc-valu>` instructions. This is also presented
@@ -1506,7 +1505,7 @@ System Speed-of-Light:
      specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F32):
-    rst: |-
+    rst: >-
      The total number of 32-bit floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 32-bit floating point
      operations from :ref:`VALU <desc-valu>` instructions. This is also presented
@@ -1514,7 +1513,7 @@ System Speed-of-Light:
      specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F64):
-    rst: |-
+    rst: >-
      The total number of 64-bit floating point :ref:`MFMA <desc-mfma>` operations
      executed per second. Note: this does not include any 64-bit floating point
      operations from :ref:`VALU <desc-valu>` instructions. This is also presented
@@ -1522,7 +1521,7 @@ System Speed-of-Light:
      specific accelerator.
    unit: GFLOPs
  MFMA FLOPs (F8):
-    rst: |-
+    rst: >-
      The total number of 8-bit brain floating point :ref:`MFMA <desc-mfma>`
      operations executed per second. Note: this does not include any 16-bit brain
      floating point operations from :ref:`VALU <desc-valu>` instructions. This
@@ -1531,7 +1530,7 @@ System Speed-of-Light:
      series and later only.
    unit: GFLOPs
  MFMA IOPs (Int8):
-    rst: |-
+    rst: >-
      The total number of 8-bit integer :ref:`MFMA <desc-mfma>` operations executed
      per second. Note: this does not include any 8-bit integer operations from
      :ref:`VALU <desc-valu>` instructions. This is also presented as a percent
@@ -1562,14 +1561,14 @@ System Speed-of-Light:
      time-averaged over all VALU instructions run on all wavefronts in the kernel.
    unit: Work-items
  VALU FLOPs:
-    rst: |-
+    rst: >-
      The total floating-point operations executed per second on the :ref:`VALU
      <desc-valu>`. This is also presented as a percent of the peak theoretical
      FLOPs achievable on the specific accelerator. Note: this does not include
      any floating-point operations from :ref:`MFMA <desc-mfma>` instructions.
    unit: GFLOPs
  VALU IOPs:
-    rst: |-
+    rst: >-
      The total integer operations executed per second on the :ref:`VALU <desc-valu>`.
      This is also presented as a percent of the peak theoretical IOPs achievable
      on the specific accelerator. Note: this does not include any integer operations
@@ -1590,7 +1589,7 @@ System Speed-of-Light:
      issuing VMEM instructions over the :ref:`total CU cycles <total-cu-cycles>`.
    unit: Percent
  Wavefront Occupancy:
-    rst: |-
+    rst: >-
      The time-averaged number of wavefronts resident on the accelerator over
      the lifetime of the kernel. Note: this metric may be inaccurate for short-running
      kernels (less than 1ms). This is also presented as a percent of the peak theoretical