cleanup inline comments, address pr comments.

Author: vchamarthi

benchmarks/benchmarks/_utils.py

@@ -9,7 +9,7 @@ def _make_input(rng, shape, dtype):
     """Return an array of *shape* and *dtype*.
 
     Complex dtypes get non-zero imaginary parts for a realistic signal.
-    *shape* may be an int (1-D) or a tuple.
+    `shape` may be an int (1-D) or a tuple.
     """
     dt = np.dtype(dtype)
     s = (shape,) if isinstance(shape, int) else shape
@@ -22,7 +22,7 @@ class BenchC2C:
     """Base setup for complex-to-complex benchmarks.
 
     Subclasses define params, param_names, and time_* / peakmem_* methods.
-    Extra positional params (e.g. module) are accepted and ignored.
+    Other positional params are ignored.
     """
 
     def setup(self, shape, dtype, *_):

benchmarks/benchmarks/bench_fft1d.py

@@ -21,10 +21,7 @@ class BenchFFT1D(BenchC2C):
 
     def setup(self, n, dtype):
         super().setup(n, dtype)
-        # Prime the MKL DFTI descriptor cache so the first measured
-        # iteration doesn't pay the one-time descriptor-creation cost.
-        # ASV's warmup_time (default 0.1s) would normally cover this,
-        # but doing it explicitly removes the dependency on that default.
+        # prime MKL DFTI descriptor cache
         mkl_fft.fft(self.x)
         mkl_fft.ifft(self.x)
 
@@ -48,7 +45,6 @@ class BenchRFFT1D(BenchR2C):
 
     def setup(self, n, dtype):
         super().setup(n, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT1D.setup).
         mkl_fft.rfft(self.x_real)
         mkl_fft.irfft(self.x_complex, n=n)
 
@@ -76,7 +72,6 @@ class BenchFFT1DNonPow2(BenchC2C):
 
     def setup(self, n, dtype):
         super().setup(n, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT1D.setup).
         mkl_fft.fft(self.x)
         mkl_fft.ifft(self.x)
 
@@ -100,7 +95,6 @@ class BenchRFFT1DNonPow2(BenchR2C):
 
     def setup(self, n, dtype):
         super().setup(n, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT1D.setup).
         mkl_fft.rfft(self.x_real)
         mkl_fft.irfft(self.x_complex, n=n)
 

benchmarks/benchmarks/bench_fftnd.py

@@ -28,10 +28,7 @@ class BenchFFT2D(BenchC2C):
 
     def setup(self, shape, dtype):
         super().setup(shape, dtype)
-        # Prime the MKL DFTI descriptor cache so the first measured
-        # iteration doesn't pay the one-time descriptor-creation cost.
-        # ASV's warmup_time (default 0.1s) would normally cover this,
-        # but doing it explicitly removes the dependency on that default.
+        # Prime MKL DFTI descriptor cache
         mkl_fft.fft2(self.x)
         mkl_fft.ifft2(self.x)
 
@@ -55,7 +52,6 @@ class BenchRFFT2D(BenchR2C):
 
     def setup(self, shape, dtype):
         super().setup(shape, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT2D.setup).
         mkl_fft.rfft2(self.x_real)
         mkl_fft.irfft2(self.x_complex, s=shape)
 
@@ -88,7 +84,6 @@ class BenchFFT2DNonPow2(BenchC2C):
 
     def setup(self, shape, dtype):
         super().setup(shape, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT2D.setup).
         mkl_fft.fft2(self.x)
         mkl_fft.ifft2(self.x)
 
@@ -115,7 +110,6 @@ class BenchFFTnD(BenchC2C):
 
     def setup(self, shape, dtype):
         super().setup(shape, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT2D.setup).
         mkl_fft.fftn(self.x)
         mkl_fft.ifftn(self.x)
 
@@ -139,7 +133,6 @@ class BenchRFFTnD(BenchR2C):
 
     def setup(self, shape, dtype):
         super().setup(shape, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT2D.setup).
         mkl_fft.rfftn(self.x_real)
         mkl_fft.irfftn(self.x_complex, s=shape)
 
@@ -171,7 +164,6 @@ class BenchFFTnDNonPow2(BenchC2C):
 
     def setup(self, shape, dtype):
         super().setup(shape, dtype)
-        # Prime the DFTI descriptor cache (see BenchFFT2D.setup).
         mkl_fft.fftn(self.x)
         mkl_fft.ifftn(self.x)
 

benchmarks/benchmarks/bench_interfaces.py

@@ -49,10 +49,7 @@ def setup(self, n, dtype, module):
         mod = _MODULE_MAP[module]
         self.fft = mod.fft
         self.ifft = mod.ifft
-        # Prime the MKL DFTI descriptor cache so the first measured
-        # iteration doesn't pay the one-time descriptor-creation cost.
-        # ASV's warmup_time (default 0.1s) would normally cover this,
-        # but doing it explicitly removes the dependency on that default.
+        # Prime MKL DFTI descriptor cache
         self.fft(self.x)
         self.ifft(self.x)
 
@@ -79,7 +76,6 @@ def setup(self, n, dtype, module):
         mod = _MODULE_MAP[module]
         self.rfft = mod.rfft
         self.irfft = mod.irfft
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.rfft(self.x_real)
         self.irfft(self.x_complex, n=n)
 
@@ -112,7 +108,6 @@ def setup(self, n, dtype, module):
         mod = _MODULE_MAP[module]
         self.hfft = mod.hfft
         self.ihfft = mod.ihfft
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.hfft(self.x_complex, n=n)
         self.ihfft(self.x_real)
 
@@ -139,7 +134,6 @@ def setup(self, shape, dtype, module):
         mod = _MODULE_MAP[module]
         self.fft2 = mod.fft2
         self.ifft2 = mod.ifft2
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.fft2(self.x)
         self.ifft2(self.x)
 
@@ -166,7 +160,6 @@ def setup(self, shape, dtype, module):
         mod = _MODULE_MAP[module]
         self.rfft2 = mod.rfft2
         self.irfft2 = mod.irfft2
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.rfft2(self.x_real)
         self.irfft2(self.x_complex, s=shape)
 
@@ -198,7 +191,6 @@ def setup(self, shape, dtype, module):
         mod = _MODULE_MAP[module]
         self.hfft2 = mod.hfft2
         self.ihfft2 = mod.ihfft2
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.hfft2(self.x_complex, s=shape)
         self.ihfft2(self.x_real)
 
@@ -225,7 +217,6 @@ def setup(self, shape, dtype, module):
         mod = _MODULE_MAP[module]
         self.fftn = mod.fftn
         self.ifftn = mod.ifftn
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.fftn(self.x)
         self.ifftn(self.x)
 
@@ -252,7 +243,6 @@ def setup(self, shape, dtype, module):
         mod = _MODULE_MAP[module]
         self.rfftn = mod.rfftn
         self.irfftn = mod.irfftn
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.rfftn(self.x_real)
         self.irfftn(self.x_complex, s=shape)
 
@@ -284,7 +274,6 @@ def setup(self, shape, dtype, module):
         mod = _MODULE_MAP[module]
         self.hfftn = mod.hfftn
         self.ihfftn = mod.ihfftn
-        # Prime the DFTI descriptor cache (see BenchC2C1D.setup).
         self.hfftn(self.x_complex, s=shape)
         self.ihfftn(self.x_real)