We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent b4138fa commit c92a1b1Copy full SHA for c92a1b1
benchmarks/README.md
@@ -1,6 +1,14 @@
1
# Benchmarks for `s2fft`
2
3
-Scripts for benchmarking `ss2ft` with `timeit` (and optionally `memory_profiler`).
+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
12
13
## Description
14
0 commit comments