Skip to content

Commit

Permalink
Complete second proofreading with fixes and minor formatting changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
amd-jnovotny committed Jul 3, 2024
1 parent f137dbc commit bd74bf3
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions docs/how-to/performing-causal-profiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ where ``foo`` is ideally 30% faster than ``bar``:
No matter how many optimizations are applied to ``foo``, the application will always
require the same amount of time
because the end-to-end performance is limited by ``bar``. However, a 5% speed-up
in ``bar`` will result in the
in ``bar`` results in the
end-to-end performance improving by 5%. This trend continues linearly, with a 10% speed-up
in ``bar`` yielding a 10% speed-up in
end-to-end performance, and so on, up to a 30% speed-up, at which point ``bar`` runs as fast as ``foo``.
Expand Down Expand Up @@ -149,7 +149,7 @@ There are three key differences between the two backends:

In general, the ``perf`` backend is preferred over the ``timer`` backend when sufficient
security priviledges permit its usage.
If ``OMNITRACE_CAUSAL_BACKEND`` is set to ``auto``, Omnitrace will fallback
If ``OMNITRACE_CAUSAL_BACKEND`` is set to ``auto``, Omnitrace falls back
to using the ``timer`` backend only if
the ``perf`` backend fails. If ``OMNITRACE_CAUSAL_BACKEND`` is
set to ``perf`` and using this backend fails, Omnitrace aborts.
Expand Down Expand Up @@ -537,7 +537,7 @@ Using ``omnitrace-causal`` with other launchers like ``mpirun``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ``omnitrace-causal`` executable is intended to assist with application replay
and is designed to always be at the start of the command-line as the primary process.
and is designed to always be at the start of the command line as the primary process.
``omnitrace-causal`` typically adds a ``LD_PRELOAD`` of the Omnitrace libraries
into the environment before launching the command to inject the functionality
required to start the causal profiling tooling. However, this is problematic
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/profiling-python-scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Profiling Python scripts
****************************************************

`Omnitrace <https://github.com/ROCm/omnitrace>`_ supports profiling Python code at the
source-level and/or the script-level.
source level and the script level.
Python support is enabled via the ``OMNITRACE_USE_PYTHON`` and the
``OMNITRACE_PYTHON_VERSIONS="<MAJOR>.<MINOR>`` CMake options.
Alternatively, to build multiple Python versions, use
Expand Down
6 changes: 3 additions & 3 deletions docs/how-to/understanding-omnitrace-output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For example, starting with the following base configuration:
[omnitrace] Outputting 'omnitrace-example-output/wall-clock.json'...
If the ``OMNITRACE_USE_PID`` option is enabled, then running a non-MPI executable
with a PID of 63453 results in the following output:
with a PID of ``63453`` results in the following output:

.. code-block:: shell
Expand Down Expand Up @@ -252,7 +252,7 @@ Core configuration settings
:widths: 30, 20, 100

"``OMNITRACE_OUTPUT_PATH``", "Any valid path", "Path to folder where output files should be placed"
"``OMNITRACE_OUTPUT_PREFIX``", "String", "Useful for multiple runs with different arguments. See the next section on output prefix keys"
"``OMNITRACE_OUTPUT_PREFIX``", "String", "Useful for multiple runs with different arguments. See the next section on output prefix keys."
"``OMNITRACE_OUTPUT_FILE``", "Any valid filepath", "Specific location for the Perfetto output file"
"``OMNITRACE_TIME_OUTPUT``", "Boolean", "Place all output in a timestamped folder, timestamp format controlled via ``OMNITRACE_TIME_FORMAT``"
"``OMNITRACE_TIME_FORMAT``", "String", "See ``strftime`` man pages for valid identifiers"
Expand Down Expand Up @@ -367,7 +367,7 @@ mode, so use this setting with caution.
Timemory text output
-----------------------------------------------------------------------

Timemory text output files are meant for human-consumption (while JSON formats are for analysis),
Timemory text output files are meant for human consumption (while JSON formats are for analysis),
so some fields such as the ``LABEL`` might be truncated for readability.
The truncation settings be changed through the ``OMNITRACE_MAX_WIDTH`` setting.

Expand Down

0 comments on commit bd74bf3

Please # to comment.