AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[rocprofv3-avail] Documentation update and column formatting (#447)

Browse Source 
* addressing issues

* doc fix

* test fix

* fix

* fix formatting issue and doc update

* fix column size

* fix

* fix formatting in output

* tests fix

* test fix

* add new line

* add new line

* fix new line

* fixing typo in using-rocprofv3-avail.rst
This commit is contained in:
Nagaraj, Sriraksha
2025-07-10 11:41:12 -05:00
committed by GitHub
parent e5161f6e06
commit 3aaffc42da
12 changed files with 138 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/docs/how-to/using-pc-sampling.rst
+16 -9
View File
@@ -41,11 +41,14 @@ The output lists if ``rocprofv3`` supports PC sampling on the GPU and the suppor
.. code-block:: bash
List available PC Sample Configurations for node_id 11
Method: ROCPROFILER_PC_SAMPLING_METHOD_HOST_TRAP
Unit: ROCPROFILER_PC_SAMPLING_UNIT_TIME
Minimum_Interval: 1
Maximum_Interval: 18446744073709551615
GPU:0
NAME:gfx90a
configs:
Method :host_trap
Unit :time
Min_Interval :1
Max_Interval :18446744073709551615
Flags :none
The preceding output shows that the GPU supports PC sampling with the ``ROCPROFILER_PC_SAMPLING_METHOD_HOST_TRAP`` method and the ``ROCPROFILER_PC_SAMPLING_UNIT_TIME`` unit. The minimum and maximum intervals are also displayed.
@@ -220,10 +223,14 @@ Output similar to the following indicates that the ``ROCPROFILER_PC_SAMPLING_MET
.. code-block:: bash
Method: ROCPROFILER_PC_SAMPLING_METHOD_STOCHASTIC
Unit: ROCPROFILER_PC_SAMPLING_UNIT_CYCLES
Minimum_Interval: 256
Maximum_Interval: 2147483648
GPU:1
NAME:gfx942
configs:
Method :stochastic
Unit :cycle
Min_Interval :256
Max_Interval :2147483648
Flags :interval pow2
Please note that on gfx942, `ROCPROFILER_PC_SAMPLING_METHOD_STOCHASTIC` requires intervals to be specified in cycles, whose values are powers of 2
source/docs/how-to/using-rocprofv3-avail.rst
+19 -25
View File
@@ -42,60 +42,55 @@ The following table lists ``rocprofv3-avail`` command-line options categorized a
| ``list``
| ``pmc-check``
- | Info options for detailed information of counters, agents, and pc-sampling configurations.
| List options for hw counters, agents and pc-sampling support".
| Checking counters collection support on agents.
| List options for hardware counters, agents and pc-sampling support.
| Checking if a set of counters can be collected together on agent.
Available Hardware Counters
++++++++++++++++++++++++++++
.. code-block:: bash
rocprofv3-avail -d 0
The preceding command selects a device with logical node type id as 0 in the node.
The option is applied to further sub commands and options
.. code-block:: bash
rocprofv3-avail list
The preceding command generates an output listing agents and hardware counters
The preceding command generates an output listing agents and hardware counters.
.. code-block:: bash
rocprofv3-avail list --agent
The preceding command generates an output listing basic info for all agents, if used with -d only basic info for device -d is listed.
The preceding command generates an output listing basic info for all agents, if used with ``-d``, only basic info for device ``-d`` is listed.
Following is the sample output
.. code-block:: bash
rocprofv3-avail list --pmc
The preceding command generates an output listing counters for all agents, if used with -d only counters on the the -d device is listed
The preceding command generates an output listing counters for all agents, if used with ``-d``, only counters on the ``-d`` device is listed.
Output contains following information: logical node id, name and list of PMC counters supported on the agent.
.. code-block:: bash
rocprofv3-avail list --pc-sampling
The preceding command generates an output listing agents that supports any kind of PC Sampling. -d option is not applicable here.
The preceding command generates an output listing agents that supports any kind of PC Sampling. ``-d`` option is not applicable here.
.. code-block:: bash
rocprofv3-avail info
The preceding command generates an output with agent information and listing all counters
supported on each
The preceding command generates an output with agent information and listing all counters supported on each agent.
.. code-block:: bash
rocprofv3-avail info --pmc
The preceding command generates an output with the pmc info, if used with -d information of pmc for device -d is generated.
The preceding command generates an output with the pmc info, if used with ``-d`` information of pmc for device ``-d`` is generated.
Output includes the following information: logical node id, name, counter_name, description of the counter, dimensions, block/expression for every counter.
.. code-block:: bash
rocprofv3-avail info --pc-sampling
The preceding command generates list of supported PC sampling configurations for each agent that supports PC sampling. -d option is not applicable here.
The preceding command generates list of supported PC sampling configurations for each agent that supports PC sampling. ``-d`` option is not applicable here.
Output has following information: logical node id, method supported, unit, minimum sampling interval, maximum sampling interval
flags.
.. code-block:: bash
@@ -107,11 +102,10 @@ The preceding command checks if the pmc can be collected together
rocprofv3-avail pmc-check -d 0 <pmc1> <pmc2> <pmc3>:device=1
The preceding command checks if the pmc1 and pmc2 can be collected together on agent 0
and pmc3 on agent 1
The preceding command checks if the pmc1 and pmc2 can be collected together on agent 0 and pmc3 on agent 1
.. note::
The above command writes the ouptut to the standard output.
All commands writes to the standard output.