Mercurial > repos > public > sbplib_julia

comparison README.md @ 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 12b525cd3da6
children 007d90b354af
comparison
equal deleted inserted replaced
1192:339cb6eacb0c 1193:04dda6aa9673
27 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"]) 27 Pkg.test(test_args=["*/lazy_tensor_operations_test.jl", "Grids/*"])
28 ``` 28 ```
29 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder. 29 will run any file named `lazy_tensor_operations_test.jl` and all the files in the `Grids` folder.
30 30
31 ## Running benchmarks 31 ## Running benchmarks
32 Benchmarks are defined in `benchmark/` use the tools for benchmark suites in BenchmarkTools.jl 32 Benchmarks are defined in `benchmark/` and use the tools for benchmark suites in BenchmarkTools.jl
33 The format is compatible with PkgBenchmark.jl which helps with running the suite, comparing results and presenting the results in a readable way. 33 The format is compatible with PkgBenchmark.jl which helps with running the suite, comparing results and presenting the results in a readable way.
34 34
35 `benchmark/` contains a julia environment with the necessary packages for working with the benchmarks. 35 `benchmark/` contains a julia environment with the necessary packages for working with the benchmarks.
36 36
37 `activate benchmark` 37 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`.
38 38
39 ```julia 39 ```julia
40 using PkgBenchmark 40 using PkgBenchmark
41 import Sbplib 41 import Sbplib
42 r = benchmarkpkg(Sbplib) 42 r = benchmarkpkg(Sbplib)