Update README.md

[ROCm/roctracer commit: 2ee7893e6d]
Cette révision appartient à :
eshcherb
2019-11-22 17:49:37 -06:00
révisé par GitHub
Parent fa38e9e052
révision 743e9bd83f
+28 -6
Voir le fichier
@@ -1,27 +1,36 @@
# ROC-tracer
```
ROC-tracer library, Runtimes Generic Callback/Activity APIs.
ROC-tracer library: Runtimes Generic Callback/Activity APIs.
The goal of the implementation is to provide a generic independent from
specific runtime profiler to trace API and asyncronous activity.
The API provides functionality for registering the runtimes API callbacks and
asyncronous activity records pool support.
ROC-TX librray: code annotation evemts API
Includes basic API: roctxMark, roctxRangePush, roctxRangePop.
```
## The library source tree
```
- inc/roctracer.h - Library public API
- inc/roctracer.h - rocTacer library public API header
- inc/roctx.h - rocTX library puiblic API header
- src - Library sources
- core - Library API sources
- util - Library utils sources
- core - rocTracer library API sources
- roctx - rocTX library API sources
- util - library utils sources
- test - test suit
- MatrixTranspose - test based on HIP MatrixTranspose sample
```
## Documentation
```
- API description: inc/roctracer.h
- Code example: test/MatrixTranspose_test/MatrixTranspose.cpp
- API description/headers:
- inc/roctracer.h
- inc/roctx.h
- Code examples:
- test/MatrixTranspose_test/MatrixTranspose.cpp
- test/MatrixTranspose/MatrixTranspose.cpp
```
## To build and run test
@@ -53,3 +62,16 @@ asyncronous activity records pool support.
or
make package && dpkg -i *.deb
```
## Usage
```
rocTracer API:
To use the rocTracer API you need the API header and to link your application with roctracer .so librray:
- the API header: /opt/rocm/roctracer/include/roctracer.h
- the .so library: /opt/rocm/lib/libroctracer64.so
rocTX API:
To use the rocTX API you need the API header and to link your application with rictx .so librray:
- the API header: /opt/rocm/roctracer/include/roctx.h
- the .so library: /opt/rocm/lib/libroctx64.so