Skip to content

Commit c92a1b1

Browse files
matt-grahamsfmig
andcommitted
Correct typo and add further description
Co-authored-by: sfmig <[email protected]>
1 parent b4138fa commit c92a1b1

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

benchmarks/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Benchmarks for `s2fft`
22

3-
Scripts for benchmarking `ss2ft` with `timeit` (and optionally `memory_profiler`).
3+
Scripts for benchmarking `s2fft` with `timeit` (and optionally `memory_profiler`).
4+
5+
Measures time to compute transforms for grids of parameters settings, optionally
6+
outputting the results to a JSON file to allow comparing performance over versions
7+
and/or systems.
8+
If the [`memory_profiler` package](https://github.com/pythonprofilers/memory_profiler)
9+
is installed an estimate of the peak (main) memory usage of the benchmarked functions
10+
will also be recorded.
11+
412

513
## Description
614

0 commit comments

Comments
 (0)