Skip to content

Commit c3cb40e

Browse files
committed
Document Julia benchmark recipes
1 parent 6c84b99 commit c3cb40e

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
@@ -182,6 +182,42 @@ The recipe recognizes the following environment variables:
182182

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

185+
* * *
186+
187+
### Julia
188+
189+
#### benchmark-julia
190+
191+
Runs Julia benchmarks.
192+
193+
<!-- run-disable -->
194+
195+
```bash
196+
$ make benchmark-julia
197+
```
198+
199+
The recipe recognizes the following environment variables:
200+
201+
- **BENCHMARKS_FILTER**: filepath pattern; e.g., `.*/blas/base/dasum/.*`.
202+
203+
This recipe is useful when wanting to glob for Julia benchmark files (e.g., run all Julia benchmarks for a particular package).
204+
205+
#### benchmark-julia-files
206+
207+
Runs a specified list of Julia benchmark files.
208+
209+
<!-- run-disable -->
210+
211+
```bash
212+
$ make benchmark-julia-files FILES='/foo/benchmark.jl /bar/benchmark.jl'
213+
```
214+
215+
The recipe recognizes the following environment variables:
216+
217+
- **FILES**: list of Julia benchmark files.
218+
219+
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`).
220+
185221
</section>
186222

187223
<!-- /.usage -->

0 commit comments

Comments
 (0)