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>
[ROCm/rocprofiler-sdk commit: 5c42d7d82a]
This commit is contained in:
committed by
GitHub
orang tua
7ff6b6db7b
melakukan
4e9dc3417f
@@ -0,0 +1,56 @@
|
||||
## Running Samples and Tool
|
||||
|
||||
```eval_rst
|
||||
.. 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:
|
||||
|
||||
```bash
|
||||
/opt/rocm/share/rocprofiler-sdk/samples
|
||||
```
|
||||
|
||||
rocprofv3 tool is installed under:
|
||||
|
||||
```bash
|
||||
/opt/rocm/bin
|
||||
```
|
||||
|
||||
### Building Samples
|
||||
|
||||
From any directory, run:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
rocprofv3 --hsa-api ./MatrixTranspose
|
||||
```
|
||||
|
||||
See more tool options with
|
||||
|
||||
```bash
|
||||
rocprofv3 --help
|
||||
```
|
||||
@@ -14,4 +14,5 @@
|
||||
buffered_tracing
|
||||
intercept_table
|
||||
developer_api
|
||||
getting_started
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user