Additional updates and changes from the external review of Omnitrace

ROCm · Jul 16, 2024 · 57ef62f · 57ef62f
1 parent 821d74a
commit 57ef62f
Show file tree

Hide file tree

Showing 6 changed files with 249 additions and 220 deletions.
diff --git a/docs/conceptual/omnitrace-feature-set.rst b/docs/conceptual/omnitrace-feature-set.rst
@@ -7,7 +7,7 @@ The Omnitrace feature set and use cases
 ***************************************
 
 `Omnitrace <https://github.com/ROCm/omnitrace>`_ is designed to be highly extensible. 
-Internally, it leverages the `timemory performance analysis toolkit <https://github.com/NERSC/timemory>`_ 
+Internally, it leverages the `Timemory performance analysis toolkit <https://github.com/NERSC/timemory>`_ 
 to manage extensions, resources, data, and other items. It supports the following features, 
 modes, metrics, and APIs.
 

diff --git a/docs/how-to/configuring-runtime-options.rst b/docs/how-to/configuring-runtime-options.rst
@@ -26,7 +26,7 @@ use the ``omnitrace-avail -G ~/.omnitrace.cfg --all`` option
 for a verbose configuration file with descriptions, categories, and additional information.
 
 Modify ``${HOME}/.omnitrace.cfg`` as required. For example, enable `Perfetto <https://perfetto.dev/>`_,
-`timemory <https://github.com/NERSC/timemory>`_, sampling, and process-level sampling by default
+`Timemory <https://github.com/NERSC/timemory>`_, sampling, and process-level sampling by default
 and tweak the default sampling values.
 
 .. code-block:: shell
@@ -62,7 +62,7 @@ accepts a case insensitive match for nearly all common Boolean logic expressions
 Exploring components
 -----------------------------------
 
-Omnitrace uses `timemory <https://github.com/NERSC/timemory>`_ extensively to provide 
+Omnitrace uses `Timemory <https://github.com/NERSC/timemory>`_ extensively to provide 
 various capabilities and manage
 data and resources. By default, with ``OMNITRACE_PROFILE=ON``, Omnitrace only collects wall-clock
 timing values. However, by modifying the ``OMNITRACE_TIMEMORY_COMPONENTS`` setting, 
@@ -94,7 +94,7 @@ Omnitrace supports hardware counter collection via PAPI and ROCm.
 Generally, PAPI is used to collect CPU-based hardware counters and ROCm is used to collect GPU-based hardware
 counters. Although it is possible to install PAPI with ROCm support and use it to 
 collect GPU-based hardware counters, this is not recommended because PAPI 
-cannot simultaneously collect CPU hardware counters.
+cannot simultaneously collect CPU and GPU hardware counters.
 
 To view all possible hardware counters and their descriptions, use the following command:
 

diff --git a/docs/how-to/configuring-validating-environment.rst b/docs/how-to/configuring-validating-environment.rst
@@ -9,6 +9,11 @@ Configuring and validating the environment
 After installing the `Omnitrace <https://github.com/ROCm/omnitrace>`_ application, some additional steps are required to set up
 and validate the environment.
 
+.. note::
+
+   The following instructions use the installation path ``/opt/omnitrace``. If
+   Omnitrace is installed elsewhere, substitute the actual installation path.
+
 Configuring the environment
 ========================================