Gopesh Bhardwaj
076f4d8427
* readthedocs updates
* Adding License
* correcting table of contents path
* Move doc requirements to sphinx dir
* Compile requirements.txt
* Update path to reqs
* Adding missing python module
* changing sphinx version
* changing docutils version
* enabling sphinx extensions
* trying sphinx-rtd-theme
* Remove unused doc configs
* Remove unused html theme options
* Add files to toc
* temp commit to test
* updating environment.yml for CI build
* Update doc requirements
To include rocprofiler-sdk in projects.yaml
* Set external_projects_current_project as rocprofiler-sdk
* Exclude external projects
* Fix warning for missing static path
* updating conf.py
* Removing reST syntax
* Use rocm-docs-core doxygen integration
* Remove RST syntax from Markdown files
* Generate doxyfile post checkout on RTD
* Use custom RTD env
* Specify mambaforge
* Put conda before post checkout cmd
* Add doxyfile for RTD
* Run cmake from conf.py
* Update environment.yml
* Use mambaforge
* Fix path to environment.yml
* Call build doxyfile
* Add Developer API title to Doxyfile
* Config version header
* Fix typo in conf.py
* Format fix for conf.py
* Increasing timeout for build-docs-from-source
* Remove README as mainpage for doxyfile
* Fix formatting in conf.py
---------
Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
[ROCm/rocprofiler-sdk commit: a60c4def00]
33 sor
712 B
Markdown
33 sor
712 B
Markdown
# Samples
|
|
|
|
## Running Samples
|
|
|
|
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
|