David Galiffi
b75423b173
* Updating install doc page * Removing the Quick Start page * Add documentation for rocpd output * Update links to reference rocm-systems repo * Update README.md Installation instructions references ROCm Docs link. * Updated git clone instructions Back to using https to clone the repository * Fix formatting * Update projects/rocprofiler-systems/docs/how-to/understanding-rocprof-sys-output.rst * Add reference to "rocpd" section to the "Profiling Python" section * Update CONTRIBUTING.md * For ROCPD, document minimum version of SDK. * Update CHANGELOGS Signed-off-by: David Galiffi <David.Galiffi@amd.com> * Update CHANGELOG.md Updated based on feedback from docs team * Update CONTRIBUTING.md * Update CONTRIBUTING.md. Simplify and remove setup information overlapping with the "rocm-systems" contributing documentation. * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Update CHANGELOG.md * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> * Apply suggestion from @prbasyal-amd Co-authored-by: Pratik Basyal <pratik.basyal@amd.com> --------- Signed-off-by: David Galiffi <David.Galiffi@amd.com> Co-authored-by: Pratik Basyal <pratik.basyal@amd.com>
72 строки
2.4 KiB
ReStructuredText
72 строки
2.4 KiB
ReStructuredText
.. meta::
|
|
:description: ROCm Systems Profiler environment validation documentation and reference
|
|
:keywords: rocprof-sys, rocprofiler-systems, Omnitrace, ROCm, profiler, environment, tracking, visualization, tool, Instinct, accelerator, AMD
|
|
|
|
****************************************************
|
|
Configuring and validating the environment
|
|
****************************************************
|
|
|
|
After installing `ROCm Systems Profiler <https://github.com/ROCm/rocm-systems/tree/develop/projects/rocprofiler-systems>`_, additional steps are required to set up
|
|
and validate the environment.
|
|
|
|
.. note::
|
|
|
|
The following instructions use the installation path ``/opt/rocprofiler-systems``. If
|
|
ROCm Systems Profiler is installed elsewhere, substitute the actual installation path.
|
|
|
|
Configuring the environment
|
|
========================================
|
|
|
|
After ROCm Systems Profiler is installed, source the ``setup-env.sh`` script to prefix the
|
|
``PATH``, ``LD_LIBRARY_PATH``, and other environment variables:
|
|
|
|
.. code-block:: shell
|
|
|
|
source /opt/rocprofiler-systems/share/rocprofiler-systems/setup-env.sh
|
|
|
|
Alternatively, if environment modules are supported, add the ``<prefix>/share/modulefiles`` directory
|
|
to ``MODULEPATH``:
|
|
|
|
.. code-block:: shell
|
|
|
|
module use /opt/rocprofiler-systems/share/modulefiles
|
|
|
|
.. note::
|
|
|
|
As an alternative, the above line can be added to the ``${HOME}/.modulerc`` file.
|
|
|
|
After ROCm Systems Profiler has been added to the ``MODULEPATH``, it can be loaded
|
|
using ``module load rocprofiler-systems/<VERSION>`` and unloaded using ``module unload rocprofiler-systems/<VERSION>``.
|
|
|
|
.. code-block:: shell
|
|
|
|
module load rocprofiler-systems/1.0.0
|
|
module unload rocprofiler-systems/1.0.0
|
|
|
|
.. note::
|
|
|
|
You might also need to add the path to the ROCm libraries to ``LD_LIBRARY_PATH``,
|
|
for example, ``export LD_LIBRARY_PATH=/opt/rocm/lib:${LD_LIBRARY_PATH}``
|
|
|
|
Validating the environment configuration
|
|
========================================
|
|
|
|
If the following commands all run successfully with the expected output,
|
|
then you are ready to use ROCm Systems Profiler:
|
|
|
|
.. code-block:: shell
|
|
|
|
which rocprof-sys
|
|
which rocprof-sys-avail
|
|
which rocprof-sys-sample
|
|
rocprof-sys-instrument --help
|
|
rocprof-sys-avail --all
|
|
rocprof-sys-sample --help
|
|
|
|
If ROCm Systems Profiler was built with Python support, validate these additional commands:
|
|
|
|
.. code-block:: shell
|
|
|
|
which rocprof-sys-python
|
|
rocprof-sys-python --help
|