Ficheiros

T

Gopesh Bhardwaj 43eaa1d127 [Documentation] Quick reference guide for rocprofv3 (#953 )

* quick reference guide for rocprofv3

* Addressed feedback and updated with rocpd information

* rocpd docs update

* rocpd query option

* Addressing feedback

* Fixed misssing newline

* Addressing feedback

* Addressing feedback

* Addressing feedback

* Addressing feedback

* Adding process attachment

2025-10-10 09:36:28 +05:30

api-reference

[rocprofiler-sdk][rocprofiler-register] Initial Attachment Support (#316 )

2025-09-18 18:10:45 -05:00

conceptual

[rocprofv3] Use -P for collection period shorthand option (#356 )

2025-04-27 20:18:26 -05:00

data

Update the scratch memory docs with the new allocation_size field (#685 )

2025-08-28 17:37:06 +05:30

how-to

[Documentation] Quick reference guide for rocprofv3 (#953 )

2025-10-10 09:36:28 +05:30

install

Update installation.rst (#1034 )

2025-09-17 11:10:55 -04:00

sphinx

Updated source/docs/sphinx/requirements.txt (#310 )

2025-03-24 14:00:49 +05:30

_toc.yml.in

[Documentation] Quick reference guide for rocprofv3 (#953 )

2025-10-10 09:36:28 +05:30

.gitignore

readthedocs updates (#877 )

2024-06-22 00:10:54 +05:30

.nojekyll

Docs skeleton (#51 )

2023-09-12 12:34:36 -05:00

CMakeLists.txt

[docs] Improve readability of ROCprofiler-SDK API library documentation (#359 )

2025-05-14 11:17:51 +05:30

conf.py

Making ROCTx API doxygen generated document more readable (#385 )

2025-05-22 18:08:55 -05:00

environment.yml

Using miniconda docker (#366 )

2025-04-23 23:52:03 -05:00

generate-doxyfile.cmake

ROCTx Documentation (#29 )

2025-01-22 11:34:21 -06:00

index.rst

[Documentation] Quick reference guide for rocprofv3 (#953 )

2025-10-10 09:36:28 +05:30

license.rst

[ROCProfiler SDK] Updating README Building & Installing Instructions (#931 )

2025-09-11 12:08:49 +05:30

Makefile

Docs skeleton (#51 )

2023-09-12 12:34:36 -05:00

quick_guide.rst

[Documentation] Quick reference guide for rocprofv3 (#953 )

2025-10-10 09:36:28 +05:30

README.md

Docs skeleton (#51 )

2023-09-12 12:34:36 -05:00

rocprofiler-sdk-roctx.dox.in

Making ROCTx API doxygen generated document more readable (#385 )

2025-05-22 18:08:55 -05:00

rocprofiler-sdk.dox.in

Making ROCTx API doxygen generated document more readable (#385 )

2025-05-22 18:08:55 -05:00

rocprofv3_input_schema.json

Using semaphore to sync with all peer processes in finalization stage (#169 )

2025-08-25 08:57:41 -05:00

rocprofv3-schema.json

SWDEV-516846: Fix serialization services conflicts and ATT counter streaming (#230 )

2025-03-14 18:11:10 -07:00

README.md

ROCprofiler Documentation

Build Instructions

Install conda
- wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
- bash miniconda.sh -b -p /opt/conda
- export PATH=${PATH}:/opt/conda
Install conda environment
- source activate
- conda env create -n rocprofiler-docs -f environment.yml
- conda activate rocprofiler-docs
Build the docs
- ../scripts/update-docs.sh
- HTML docs will be located in _build/html

Developer Information

If you create a new page, add the name of the new markdown file (without extension) to the index.md file.