Skip to content

Commit 0403fd7

Browse files
authored
Update README.md
1 parent a7789ea commit 0403fd7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Overview
3434

3535
Caliper is primarily a source-code instrumentation library. To use it, insert
3636
Caliper instrumentation markers around source-code regions of interest in the
37-
target program:
37+
target program, like the C++ function and region markers in the example below:
3838

3939
```C++
4040
#include <caliper/cali.h>
@@ -53,8 +53,8 @@ There are annotation APIs for C, C++, Fortran, and Python codes.
5353
To take performance measurements, Caliper provides built-in profiling recipes for
5454
a wide range of performance engineering use cases. Available functionality includes
5555
MPI function and message profiling, CUDA and HIP API as well as GPU activity
56-
(kernel executions and memory copies) profiling, call-path sampling, and much more.
57-
As a simple example, the `runtime-report` recipe prints the time spent in the
56+
profiling, loop profiling, call-path sampling, and much more.
57+
As a simple example, the ``runtime-report`` recipe prints the time spent in the
5858
annotated regions on screen:
5959

6060
$ CALI_CONFIG=runtime-report ./answer
@@ -65,7 +65,7 @@ annotated regions on screen:
6565

6666
Aside from simple text reports, Caliper can generate machine-readable output in JSON
6767
or its own custom .cali file format, which can be analyzed with the Caliper-provided
68-
`cali-query` tool and CalQL query language, or imported into Python analysis
68+
``cali-query`` tool and CalQL query language, or imported into Python analysis
6969
scripts with the [caliper-reader](python/caliper-reader/) Python module.
7070
In addition, Caliper can collect data for [Thicket](https://github.com/LLNL/thicket),
7171
a Python-based toolkit for Exploratory Data Analysis of parallel performance data.

0 commit comments

Comments
 (0)