Skip to content

Commit d8fd05c

Browse files
updated benchmarks/README.md
1 parent 3bdbe40 commit d8fd05c

File tree

1 file changed

+3
-25
lines changed

1 file changed

+3
-25
lines changed

benchmarks/README.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,5 @@
1-
To run the benchmarks, simply do:
1+
To run the benchmarks, simply do this from the root directory of the repository:
22

33
```sh
4-
julia --project -e 'using DynamicPPLBenchmarks; weave_benchmarks();'
5-
```
6-
7-
```julia
8-
julia> @doc weave_benchmarks
9-
weave_benchmarks(input="benchmarks.jmd"; kwargs...)
10-
11-
Weave benchmarks present in benchmarks.jmd into a single file.
12-
13-
Keyword arguments
14-
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
15-
16-
• benchmarkbody: JMD-file to be rendered for each model.
17-
18-
• include_commit_id=false: specify whether to include commit-id in the default name.
19-
20-
• name: the name of directory in results/ to use as output directory.
21-
22-
• name_old=nothing: if specified, comparisons of current run vs. the run pinted to by name_old will be included in the generated document.
23-
24-
• include_typed_code=false: if true, output of code_typed for the evaluator of the model will be included in the weaved document.
25-
26-
• Rest of the passed kwargs will be passed on to Weave.weave.
27-
```
4+
julia --project=benchmarks benchmarks/benchmarks.jl
5+
```

0 commit comments

Comments
 (0)