Skip to content

Commit 7c6fab0

Browse files
committed
Update Readme
Mention C instrumenters Fix typos Split lines consistently into sentences
1 parent a86203b commit 7c6fab0

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ To trace the full script, you need to run
4444
python -m scorep <script.py>
4545
```
4646

47-
The usual Score-P environment Variables will be respected. Please have a look at:
47+
The usual Score-P environment Variables will be respected.
48+
Please have a look at:
4849

4950
[www.vi-hps.org](http://www.vi-hps.org/projects/score-p/)
5051

@@ -62,20 +63,24 @@ python -m scorep --mpp=mpi --thread=pthread <script.py>
6263

6364
## Instrumenter
6465
The instrumenter ist the key part of the bindings.
65-
He registers with the Python tracing interface, and cares about the fowarding of events to Score-P.
66-
There are currently three different instrumenter types available as described in the following section [Instrumenter Types](#instrumenter-types) .
66+
It registers with the Python tracing interface, and cares about the fowarding of events to Score-P.
67+
There are currently five different instrumenter types available as described in the following section [Instrumenter Types](#instrumenter-types) .
6768
A user interface, to dynamically enable and disable the automatic instrumentation, using the python hooks, is also available and described under [Instrumenter User Interface](#instrumenter-user-interface)
6869

6970
### Instrumenter Types
70-
With version 2.0 of the python bindings, the term "instrumenter" is introduced. The instrumenter describes the class that maps the Python `trace` or `profile` events to Score-P. Please be aware, that `trace` and `profile` does not refer to the traditional Score-P terms of tracing and profiling, but to the Python functions [sys.settrace](https://docs.python.org/3/library/sys.html#sys.settrace) and [sys.setprofile](https://docs.python.org/3/library/sys.html#sys.setprofile).
71+
With version 2.0 of the python bindings, the term "instrumenter" is introduced.
72+
The instrumenter describes the class that maps the Python `trace` or `profile` events to Score-P.
73+
Please be aware, that `trace` and `profile` does not refer to the traditional Score-P terms of tracing and profiling, but to the Python functions [sys.settrace](https://docs.python.org/3/library/sys.html#sys.settrace) and [sys.setprofile](https://docs.python.org/3/library/sys.html#sys.setprofile).
7174

7275
The instrumenter that shall be used for tracing can be specified using `--instrumenter-type=<type>`.
73-
Currently there are the following tacers available:
76+
Currently there are the following instrumenters available:
7477
* `profile` (default) implements `call` and `return`
7578
* `trace` implements `call` and `return`
79+
* `cProfile` / `cTrace` are the same as the above but implemented in C++
7680
* `dummy` does nothing, can be used without `-m scorep` (as done by user instrumentation)
7781

7882
The `profile` instrumenter should have a smaller overhead than `trace`.
83+
Using the instrumenters implemented in C++ additionally reduces the overhead but those are only available in Python 3.
7984

8085
It is possible to disable the instrumenter passing `--noinstrumenter`.
8186
However, the [Instrumenter User Interface](#instrumenter-user-interface) may override this flag.
@@ -196,22 +201,23 @@ scorep.user.parameter_uint(name, val)
196201
scorep.user.parameter_string(name, string)
197202
```
198203

199-
where `name` defines the name of the parameter or region, while `val` or `string` represents the value that is passed to Score-P.
204+
where `name` defines the name of the parameter or region, while `val` or `string` represents the value that is passed to Score-P.
200205

201-
Disabeling the recording with Score-P is still also possilbe:
206+
Disabling the recording with Score-P is still also possible:
202207

203208
```
204209
scorep.user.enable_recording()
205210
scorep.user.disable_recording()
206211
```
207212

208-
However, please be aware that the runtime impact of disabeling Score-P is rather small, as the instrumenter is still active. For details about the instrumenter, please see [Instrumenter](#Instrumenter).
213+
However, please be aware that the runtime impact of disabling Score-P is rather small, as the instrumenter is still active.
214+
For details about the instrumenter, please see [Instrumenter](#Instrumenter).
209215

210216
## Overview about Flags
211217

212218
The following flags are special to the python bindings:
213219

214-
* `--noinstrumenter` disables the instrumentation of python code. Usefull for user instrumentation and to trace only specific code regions using `scorep.instrumenter.enable`.
220+
* `--noinstrumenter` disables the instrumentation of python code. Useful for user instrumentation and to trace only specific code regions using `scorep.instrumenter.enable`.
215221
* `--instrumenter-type=<type>` choose an instrumenter. See [Instrumenter](#Instrumenter).
216222
* `--keep-files` temporary files are kept.
217223

@@ -235,7 +241,8 @@ To disable compiler instrumentation, please specify:
235241
python -m scorep --nocompiler <script.py>
236242
```
237243

238-
For other thread schemes just specify `--thread=<something>`. E.g. :
244+
For other thread schemes just specify `--thread=<something>`.
245+
E.g. :
239246

240247
```
241248
python -m scorep --thread=omp <script.py>
@@ -246,7 +253,7 @@ Please be aware the `--user` is always passed to Score-P, as this is needed for
246253
# Compatibility
247254
## Working
248255
* python3
249-
* python2.7
256+
* python2.7, but not all features are supported
250257
* mpi using mpi4py
251258
* threaded applications
252259

0 commit comments

Comments
 (0)