Files
rocm-systems/source/docs/getting_started.md
T
Gopesh Bhardwaj 5c42d7d82a Getting Started docs for samples and tools (#261)
* getting started for amples and tools

* Adding getting started to documentation

* Addressing review comments

* minor update

* renaming rocprofv2 to rocprofv3 in doc

* Apply suggestions from code review

---------

Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com>
2023-12-04 16:22:18 -06:00

1.1 KiB

Running Samples and Tool

.. toctree::
   :glob:
   :maxdepth: 4

Samples and tool can be run in order to see the profiler in action. This section covers on how to build these samples and run the tool. Once the rocm build is installed, samples are installed under:

/opt/rocm/share/rocprofiler-sdk/samples

rocprofv3 tool is installed under:

/opt/rocm/bin

Building Samples

From any directory, run:

cmake -B build-rocprofiler-sdk-samples /opt/rocm/share/rocprofiler-sdk/samples -DCMAKE_PREFIX_PATH=/opt/rocm
cmake --build build-rocprofiler-sdk-samples --target all --parallel 8


### Running samples

To run the built samples, cd into the `build-rocprofiler-sdk-samples` directory and run:

```bash
ctest -V

### Running Tool
#### Build an HIP application:

```bash
cmake -B <build-directory> <source-directory> -DCMAKE_PREFIX_PATH=/opt/rocm
cmake --build <build-directory> --target all --parallel <N>

Run the Tool:

rocprofv3 --hsa-api ./MatrixTranspose

See more tool options with

rocprofv3 --help