Mercurial > repos > public > sbplib_julia

changeset 1193:04dda6aa9673 tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some things to README.md
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 27 Jan 2023 22:06:12 +0100
parents 339cb6eacb0c
children 007d90b354af
files README.md
diffstat 1 files changed, 2 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Fri Jan 27 22:02:43 2023 +0100
+++ b/README.md	Fri Jan 27 22:06:12 2023 +0100
@@ -29,12 +29,12 @@
 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder.
 
 ## Running benchmarks
-Benchmarks are defined in `benchmark/` use the tools for benchmark suites in BenchmarkTools.jl
+Benchmarks are defined in `benchmark/` and use the tools for benchmark suites in BenchmarkTools.jl
 The format is compatible with PkgBenchmark.jl which helps with running the suite, comparing results and presenting the results in a readable way.
 
 `benchmark/` contains a julia environment with the necessary packages for working with the benchmarks.
 
-`activate benchmark`
+There are custom functions included for running the benchmarks in this Mercurial repository. To use this first activate the environment in `benchmark/` then include the file `benchmark_utils.jl`.
 
 ```julia
 using PkgBenchmark