Moving observers in their own space.

isazi · isazi · commit 8dccb8eeada5 · 2022-11-08T15:11:50.000+01:00
diff --git a/examples/cuda/vector_add_observers.py b/examples/cuda/vector_add_observers.py
@@ -6,7 +6,7 @@
 
 import numpy
 from kernel_tuner import tune_kernel
-from kernel_tuner.nvml import NVMLObserver
+from kernel_tuner.observers.nvml import NVMLObserver
 
 def tune():
 
diff --git a/examples/opencl/vector_add_observers.py b/examples/opencl/vector_add_observers.py
@@ -6,7 +6,7 @@
 
 import numpy
 from kernel_tuner import tune_kernel
-from kernel_tuner.nvml import NVMLObserver
+from kernel_tuner.observers.nvml import NVMLObserver
 
 def tune():
 
diff --git a/kernel_tuner/backends/c.py b/kernel_tuner/backends/c.py
@@ -13,7 +13,7 @@
 import numpy.ctypeslib
 
 from kernel_tuner.backends.backend import CompilerBackend
-from kernel_tuner.observers import BenchmarkObserver
+from kernel_tuner.observers.observer import BenchmarkObserver
 from kernel_tuner.util import get_temp_filename, delete_temp_file, write_file, SkippableFailure
 
 dtype_map = {"int8": C.c_int8,
@@ -32,8 +32,9 @@
 # of the argument data. For an ndarray, the ctypes object is a wrapper for the ndarray's data.
 Argument = namedtuple("Argument", ["numpy", "ctypes"])
 
+
 class CRuntimeObserver(BenchmarkObserver):
-    """ Observer that collects results returned by benchmarking function """
+    """ Observer that collects results returned by benchmarking function in the C backend """
 
     def __init__(self, dev):
         self.dev = dev
diff --git a/kernel_tuner/backends/cupy.py b/kernel_tuner/backends/cupy.py
@@ -7,7 +7,7 @@
 import numpy as np
 
 from kernel_tuner.backends.backend import GPUBackend
-from kernel_tuner.observers import BenchmarkObserver
+from kernel_tuner.observers.observer import BenchmarkObserver
 
 #embedded in try block to be able to generate documentation
 #and run tests without cupy installed
@@ -18,7 +18,7 @@
 
 
 class CupyRuntimeObserver(BenchmarkObserver):
-    """ Observer that measures time using CUDA events during benchmarking """
+    """ Observer that measures time using CUDA events during benchmarking in the CuPy backend """
     def __init__(self, dev):
         self.dev = dev
         self.stream = dev.stream
diff --git a/kernel_tuner/backends/nvcuda.py b/kernel_tuner/backends/nvcuda.py
@@ -2,7 +2,7 @@
 import numpy as np
 
 from kernel_tuner.backends.backend import GPUBackend
-from kernel_tuner.observers import BenchmarkObserver
+from kernel_tuner.observers.observer import BenchmarkObserver
 from kernel_tuner.util import SkippableFailure
 
 #embedded in try block to be able to generate documentation
diff --git a/kernel_tuner/backends/opencl.py b/kernel_tuner/backends/opencl.py
@@ -4,7 +4,7 @@
 import numpy as np
 
 from kernel_tuner.backends.backend import GPUBackend
-from kernel_tuner.observers import BenchmarkObserver
+from kernel_tuner.observers.observer import BenchmarkObserver
 
 #embedded in try block to be able to generate documentation
 try:
diff --git a/kernel_tuner/backends/pycuda.py b/kernel_tuner/backends/pycuda.py
@@ -6,8 +6,8 @@
 import numpy as np
 
 from kernel_tuner.backends.backend import GPUBackend
-from kernel_tuner.observers import BenchmarkObserver
-from kernel_tuner.nvml import nvml
+from kernel_tuner.observers.observer import BenchmarkObserver
+from kernel_tuner.observers.nvml import nvml
 from kernel_tuner.util import TorchPlaceHolder, SkippableFailure
 
 #embedded in try block to be able to generate documentation
diff --git a/kernel_tuner/core.py b/kernel_tuner/core.py
@@ -11,13 +11,13 @@
 except ImportError:
     cp = np
 
+from kernel_tuner.observers.nvml import NVMLObserver
+from kernel_tuner.observers.observer import ContinuousObserver
 from kernel_tuner.backends.cupy import CupyFunctions
 from kernel_tuner.backends.pycuda import PyCudaFunctions
 from kernel_tuner.backends.nvcuda import CudaFunctions
 from kernel_tuner.backends.opencl import OpenCLFunctions
 from kernel_tuner.backends.c import CFunctions
-from kernel_tuner.nvml import NVMLObserver
-from kernel_tuner.observers import ContinuousObserver
 from kernel_tuner.backends.opencl import OpenCLFunctions
 import kernel_tuner.util as util
 
diff --git a/kernel_tuner/observers/__init__.py b/kernel_tuner/observers/__init__.py
diff --git a/kernel_tuner/observers/nvml.py b/kernel_tuner/observers/nvml.py
@@ -3,7 +3,7 @@
 import re
 import numpy as np
 
-from kernel_tuner.observers import BenchmarkObserver, ContinuousObserver
+from kernel_tuner.observers.observer import BenchmarkObserver, ContinuousObserver
 
 try:
     import pynvml
diff --git a/kernel_tuner/observers/observer.py b/kernel_tuner/observers/observer.py
@@ -0,0 +1,41 @@
+from abc import ABC, abstractmethod
+
+
+class BenchmarkObserver(ABC):
+    """Base class for Benchmark Observers"""
+
+    def register_device(self, dev):
+        """Sets self.dev, for inspection by the observer at various points during benchmarking"""
+        self.dev = dev
+
+    def before_start(self):
+        """before start is called every iteration before the kernel starts"""
+        pass
+
+    def after_start(self):
+        """after start is called every iteration directly after the kernel was launched"""
+        pass
+
+    def during(self):
+        """during is called as often as possible while the kernel is running"""
+        pass
+
+    def after_finish(self):
+        """after finish is called once every iteration after the kernel has finished execution"""
+        pass
+
+    @abstractmethod
+    def get_results(self):
+        """ get_results should return a dict with results that adds to the benchmarking data
+
+            get_results is called only once per benchmarking of a single kernel configuration and
+            generally returns averaged values over multiple iterations.
+        """
+        pass
+
+
+class IterationObserver(BenchmarkObserver):
+    pass
+
+class ContinuousObserver(BenchmarkObserver):
+    pass
diff --git a/kernel_tuner/observers/powersensor.py b/kernel_tuner/observers/powersensor.py
@@ -1,53 +1,13 @@
-from abc import ABC, abstractmethod
-
 import numpy as np
 
+from kernel_tuner.observers.observer import BenchmarkObserver
+
 #check if power_sensor is installed
 try:
     import power_sensor
 except ImportError:
     power_sensor = None
 
-class BenchmarkObserver(ABC):
-    """Base class for Benchmark Observers"""
-
-    def register_device(self, dev):
-        """Sets self.dev, for inspection by the observer at various points during benchmarking"""
-        self.dev = dev
-
-    def before_start(self):
-        """before start is called every iteration before the kernel starts"""
-        pass
-
-    def after_start(self):
-        """after start is called every iteration directly after the kernel was launched"""
-        pass
-
-    def during(self):
-        """during is called as often as possible while the kernel is running"""
-        pass
-
-    def after_finish(self):
-        """after finish is called once every iteration after the kernel has finished execution"""
-        pass
-
-    @abstractmethod
-    def get_results(self):
-        """ get_results should return a dict with results that adds to the benchmarking data
-
-            get_results is called only once per benchmarking of a single kernel configuration and
-            generally returns averaged values over multiple iterations.
-        """
-        pass
-
-
-class IterationObserver(BenchmarkObserver):
-    pass
-
-class ContinuousObserver(BenchmarkObserver):
-    pass
-
-
 
 class PowerSensorObserver(BenchmarkObserver):
     """ Observer that an external PowerSensor2 device to accurately measure power
diff --git a/kernel_tuner/util.py b/kernel_tuner/util.py
@@ -19,7 +19,7 @@
 except ImportError:
     cp = np
 
-from kernel_tuner.nvml import NVMLObserver
+from kernel_tuner.observers.nvml import NVMLObserver
 
 # number of special values to insert when a configuration cannot be measured
 
diff --git a/test/test_observers.py b/test/test_observers.py
@@ -2,8 +2,8 @@
 import pytest
 
 import kernel_tuner
-from kernel_tuner.nvml import NVMLObserver
-from kernel_tuner.observers import BenchmarkObserver
+from kernel_tuner.observers.nvml import NVMLObserver
+from kernel_tuner.observers.observer import BenchmarkObserver
 
 from .context import skip_if_no_pycuda
 from .test_runners import env
