Skip to content

Commit 53f122d

Browse files
committed
Document Python benchmark recipes
1 parent c3cb40e commit 53f122d

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

tools/make/lib/benchmark/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,42 @@ The recipe recognizes the following environment variables:
218218

219219
This recipe is useful when wanting to run a list of Julia benchmark files generated by some other command (e.g., a filtered list of changed Julia benchmark files obtained via `git diff`).
220220

221+
* * *
222+
223+
### Python
224+
225+
#### benchmark-python
226+
227+
Runs Python benchmarks.
228+
229+
<!-- run-disable -->
230+
231+
```bash
232+
$ make benchmark-python
233+
```
234+
235+
The recipe recognizes the following environment variables:
236+
237+
- **BENCHMARKS_FILTER**: filepath pattern; e.g., `.*/blas/base/dasum/.*`.
238+
239+
This recipe is useful when wanting to glob for Python benchmark files (e.g., run all Python benchmarks for a particular package).
240+
241+
#### benchmark-python-files
242+
243+
Runs a specified list of Python benchmark files.
244+
245+
<!-- run-disable -->
246+
247+
```bash
248+
$ make benchmark-python-files FILES='/foo/benchmark.py /bar/benchmark.py'
249+
```
250+
251+
The recipe recognizes the following environment variables:
252+
253+
- **FILES**: list of Python benchmark files.
254+
255+
This recipe is useful when wanting to run a list of Python benchmark files generated by some other command (e.g., a filtered list of changed Python benchmark files obtained via `git diff`).
256+
221257
</section>
222258

223259
<!-- /.usage -->

0 commit comments

Comments
 (0)