Skip to content

Commit

Permalink
Add quick start install guide and fix spelling errors in other files
Browse files Browse the repository at this point in the history
  • Loading branch information
amd-jnovotny committed Jun 23, 2024
1 parent dd65bd8 commit 1840d32
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/conceptual/how-omnitrace-works.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ collect the required information and, thus, has the potential to cause performan
changes which may, in some cases, lead to inaccurate results. The effect depends on
what information being collected and which features are activated in Omnitrace.
For example, collecting only the wall-clock timing data
will have less effect than collected the wall-clock timing, cpu-clock timing,
will have less effect than collected the wall-clock timing, CPU-clock timing,
memory usage, cache-misses, and number of instructions executed. Similarly,
collecting a flat profile will have less overhead than a hierarchical profile
and collecting a trace OR a profile will have less overhead than collecting a
Expand Down Expand Up @@ -223,7 +223,7 @@ Binary instrumentation vs. statistical sampling example

Consider the following code:

.. code:: cpp
.. code:: c++

long fib(long n)
{
Expand Down
8 changes: 4 additions & 4 deletions docs/conceptual/omnitrace-feature-set.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,15 +115,15 @@ runtime of your application. In other words, it does not matter
how fast or slow the code on GPU is if the application has a
bottleneck on waiting on the GPU.

Use OmniTrace to obtain a high-level view of the entire application. Use it
Use Omnitrace to obtain a high-level view of the entire application. Use it
to determine where the performance bottlenecks are and
obtain clues to why these bottlenecks are happening. If you want extensive
insight into the execution of individual kernels
on the GPU, AMD Research is working on another tool for this but you should
start with the tool which characterizes the
broad picture: OmniTrace.
broad picture: Omnitrace.

With regard to the CPU, OmniTrace does not target any specific vendor,
With regard to the CPU, Omnitrace does not target any specific vendor,
it works just as well with non-AMD CPUs as with AMD CPUs.
With regard to the GPU, OmniTrace is currently restricted to the HIP and HSA APIs
With regard to the GPU, Omnitrace is currently restricted to the HIP and HSA APIs
and kernels executing on AMD GPUs.
48 changes: 48 additions & 0 deletions docs/install/quick-start.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
.. meta::
:description: Omnitrace documentation and reference
:keywords: Omnitrace, ROCm, profiler, tracking, visualization, tool, Instinct, accelerator, AMD

*************************************
Omnitrace quick start installation
*************************************

To install Omnitrace, download the `Omnitrace installer <https://github.com/ROCm/omnitrace/releases/latest/download/omnitrace-install.py>`_
and specify ``--prefix <install-directory>``. This script attempts to auto-detect
the appropriate OS distribution and version. To include AMD ROCm (TM) Software support,
specify ``--rocm X.Y``, where ``X`` is the ROCm major
version and ``Y`` is the ROCm minor version, for example, ``--rocm 6.2``.

.. code:: shell
wget https://github.com/ROCm/omnitrace/releases/latest/download/omnitrace-install.py
python3 ./omnitrace-install.py --prefix /opt/omnitrace --rocm 6.2
This script supports installation on Ubuntu, OpenSUSE, Red Hat, Debian, CentOS, and Fedora.
If the target OS is compatible with one of the operating system versions listed here,
specify ``-d <DISTRO> -v <VERSION>``. For example, if the OS is compatible with Ubuntu 18.04, pass
``-d ubuntu -v 18.04`` to the script.

Operating system support
========================================

Omnitrace is only supported on Linux. The following distributions are tested:

* Ubuntu 18.04
* Ubuntu 20.04
* Ubuntu 22.04
* OpenSUSE 15.2
* OpenSUSE 15.3
* OpenSUSE 15.4
* Red Hat 8.7
* Red Hat 9.0
* Red Hat 9.1

Other OS distributions might be supported but are not tested.

Release links
========================================

To review and install either the current Omnitrace release or earlier releases, use these links:

* `Latest Omnitrace Release <https://github.com/ROCm/omnitrace/releases/latest>`_
* `All Omnitrace Releases <https://github.com/ROCm/omnitrace/releases>`_

0 comments on commit 1840d32

Please sign in to comment.