diff --git a/docs/conceptual/performance-model.rst b/docs/conceptual/performance-model.rst index 22a015bf2b..6577d2d2fd 100644 --- a/docs/conceptual/performance-model.rst +++ b/docs/conceptual/performance-model.rst @@ -45,4 +45,4 @@ key hardware blocks, each detailed in the following sections: * :doc:`command-processor` -* :doc:`system-speed-of-light` +* :doc:`system-speed-of-light` \ No newline at end of file diff --git a/docs/how-to/pc_sampling.rst b/docs/how-to/pc_sampling.rst index a89721c5f7..1c6e4acd19 100644 --- a/docs/how-to/pc_sampling.rst +++ b/docs/how-to/pc_sampling.rst @@ -19,30 +19,31 @@ particularly useful for understanding stalls during the kernel execution. The PC Profiling options --------------------- For using profiling options for PC sampling the configuration needed are: -- ``--pc-sampling-method``: Should be either ``stochastic`` or ``host_trap`` -- ``--pc-sampling-interval``: For stochastic sampling, the interval is in cycles. The finest granularity is 1 cycle. For host_trap sampling, the interval is in microsecond (DEFAULT: 1048576). The interval should be the power of 2. You are recommended to try to starting from 1048576, and lowering until reaching 65536. + +* ``--pc-sampling-method``: Should be either ``stochastic`` or ``host_trap`` +* ``--pc-sampling-interval``: For stochastic sampling, the interval is in cycles. The finest granularity is 1 cycle. For host_trap sampling, the interval is in microsecond (DEFAULT: 1048576). The interval should be the power of 2. You are recommended to try to starting from 1048576, and lowering until reaching 65536. **Sample command:** -.. code-block:: bash - rocprof-compute profile -n pc_test -b 21 --no-roof --pc-sampling-method stochastic --pc-sampling-interval 1048576 -VVV -- target_app +.. code-block:: shell + + $ rocprof-compute profile -n pc_test -b 21 --no-roof --pc-sampling-method stochastic --pc-sampling-interval 1048576 -VVV -- target_app ----------------------- Analysis options ----------------------- For using analysis options for PC sampling the configuration needed are: -- ``--pc-sampling-sorting-type``: ``offset`` or ``count``. The default option is ``offset``. ``offset`` is an assembly instruction offset in the code object. +* ``--pc-sampling-sorting-type``: ``offset`` or ``count``. The default option is ``offset``. ``offset`` is an assembly instruction offset in the code object. **Sample command:** -.. code-block:: bash - rocprof-compute analyze -p workloads/pc_test/MI300A_A1/ -b 21 -k 0 --pc-sampling-sorting-type offset +.. code-block:: shell + $ rocprof-compute analyze -p workloads/pc_test/MI300A_A1/ -b 21 -k 0 --pc-sampling-sorting-type offset .. note:: - - PC sampling feature is currently in BETA version. To enable PC sampling, - you have to explicitly enable it with block index 21. - - To associate PC sampling info back to HIP source code, you need to build the profiling target app with ``-g`` to keep the symbols. Otherwise, PC sampling info would be only associated with assembly lines. + * PC sampling feature is currently in BETA version. To enable PC sampling, you have to explicitly enable it with block index 21. + * To associate PC sampling info back to HIP source code, you need to build the profiling target app with ``-g`` to keep the symbols. Otherwise, PC sampling info would be only associated with assembly lines. diff --git a/docs/how-to/profile/mode.rst b/docs/how-to/profile/mode.rst index 8852704c83..676797d889 100644 --- a/docs/how-to/profile/mode.rst +++ b/docs/how-to/profile/mode.rst @@ -252,7 +252,7 @@ Filtering options .. _profiling-hw-component-filtering: Hardware report block filtering -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can profile specific hardware report blocks to speed up the profiling process. In ROCm Compute Profiler, the term hardware report block refers to a section of the diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index a5e776cc43..fae84782cf 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -19,8 +19,8 @@ subtrees: entries: - file: how-to/use.rst - file: how-to/pc_sampling.rst - - file: how-to/profile/mode.rst title: Use PC sampling + - file: how-to/profile/mode.rst - file: how-to/analyze/mode.rst entries: - file: how-to/analyze/cli.rst diff --git a/docs/what-is-rocprof-compute.rst b/docs/what-is-rocprof-compute.rst index b40b1ad10d..ce96499f46 100644 --- a/docs/what-is-rocprof-compute.rst +++ b/docs/what-is-rocprof-compute.rst @@ -15,7 +15,7 @@ ROCm Compute Profiler primarily targets use with :doc:`accelerators in the MI300, MI200, and MI100 families `. Development is in progress to support Radeon™ (RDNA) GPUs. -ROCm Compute Profiler is built on top of :doc:`ROCProfiler ` to +ROCm Compute Profiler is built on top of :doc:`ROCProfiler ` to monitor hardware performance counters. .. _high-level-design: @@ -88,8 +88,7 @@ high level. * :ref:`Memory Chart Analysis panel ` - * :ref:`Roofline Analysis panel ` - (*Supported on MI200 and above architectures only) + * :ref:`Roofline Analysis panel ` (Supported on MI200 and above architectures only) * :ref:`Command Processor (CP) panel `