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

Updating rocprofv3 doc for pc sampling beta option (#59)

Browse Source 
* Updating rocprofv3 doc for pc sampling beta option

* Update source/docs/rocprofv3_input_schema.json

* Update using-rocprofv3.rst

---------

Co-authored-by: Elwazir, Ammar <Ammar.Elwazir@amd.com>

[ROCm/rocprofiler-sdk commit: c509fe799d]
This commit is contained in:
Nagaraj, Sriraksha
2024-12-06 17:41:28 -06:00
committed by GitHub
parent 0ed4441ca7
commit fd9da7dc43
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofv3.rst
+6
View File
@@ -161,6 +161,10 @@ Here is the sample of commonly used ``rocprofv3`` command-line options. Some opt
* - ``--perfetto-shmem-size-hint KB`` * - ``--perfetto-shmem-size-hint KB``
- Perfetto shared memory size hint in KB. default: 64 KB - Perfetto shared memory size hint in KB. default: 64 KB
- Extension - Extension
* - ``--pc-sampling-beta-enabled``
- pc sampling support is in beta version
- This flag set the ROCPROFILER_PC_SAMPLING_BETA_ENABLED environment variable
* - ``--pc-sampling-method`` * - ``--pc-sampling-method``
- Type of PC Sampling, currently only host trap method is supported - Type of PC Sampling, currently only host trap method is supported
@@ -759,6 +763,8 @@ Properties
- **``pc_sampling_unit``** *(string)*: pc sampling unit. - **``pc_sampling_unit``** *(string)*: pc sampling unit.
- **``pc_sampling_method``** *(string)*: pc sampling method. - **``pc_sampling_method``** *(string)*: pc sampling method.
- **``pc_sampling_interval``** *(integer)*: pc sampling interval. - **``pc_sampling_interval``** *(integer)*: pc sampling interval.
- **``pc-sampling-beta-enabled``** *(boolean)*: enable pc
sampling support; beta version.
.. code-block:: shell .. code-block:: shell
projects/rocprofiler-sdk/source/docs/rocprofv3_input_schema.json
+4
View File
@@ -156,6 +156,10 @@
"pc_sampling_interval": { "pc_sampling_interval": {
"type": "integer", "type": "integer",
"description": "pc sampling interval" "description": "pc sampling interval"
},
"pc-sampling-beta-enabled": {
"type": "boolean",
"description": "enable pc sampling support; beta version"
} }
} }
} }