Add report generation methods to TimerProtocol interface (#1012)

Summary: Pull Request resolved: #1012

Reviewed By: JKSenthil

Differential Revision: D77345642

fbshipit-source-id: f1f9c24c6876c61154d2fd8794a7f8a793fc14d3

Author: diego-urgell

torchtnt/utils/timer.py

@@ -114,6 +114,12 @@ def reset(self) -> None:
         """
         ...
 
+    def _make_report(self) -> TimerReport:
+        """
+        Creates a report of timing data.
+        """
+        ...
+
 
 class Timer(TimerProtocol):
     def __init__(
@@ -176,6 +182,31 @@ def reset(self) -> None:
         """
         self.recorded_durations = defaultdict(list)
 
+    def _make_report(self: TimerProtocol) -> TimerReport:
+        total_time = 0.0
+        for _, durations in self.recorded_durations.items():
+            array_value = np.array(durations)
+            array_sum = np.sum(array_value)
+            total_time += array_sum
+
+        action_stats = [
+            TimedActionStats(
+                action_name=a,
+                mean_duration=np.mean(d),
+                num_calls=len(d),
+                total_duration=np.sum(d),
+                percentage_of_total_time=100.0 * np.sum(d) / total_time,
+            )
+            for a, d in self.recorded_durations.items()
+        ]
+        action_stats.sort(reverse=True)
+        total_calls = sum(x.num_calls for x in action_stats)
+        return TimerReport(
+            timed_action_stats=action_stats,
+            total_calls=total_calls,
+            total_duration=total_time,
+        )
+
 
 class BoundedTimer(Timer):
     """
@@ -215,32 +246,6 @@ def _apply_bounds(self, action_name: str) -> None:
             )
 
 
-def _make_report(self: TimerProtocol) -> TimerReport:
-    total_time = 0.0
-    for _, durations in self.recorded_durations.items():
-        array_value = np.array(durations)
-        array_sum = np.sum(array_value)
-        total_time += array_sum
-
-    action_stats = [
-        TimedActionStats(
-            action_name=a,
-            mean_duration=np.mean(d),
-            num_calls=len(d),
-            total_duration=np.sum(d),
-            percentage_of_total_time=100.0 * np.sum(d) / total_time,
-        )
-        for a, d in self.recorded_durations.items()
-    ]
-    action_stats.sort(reverse=True)
-    total_calls = sum(x.num_calls for x in action_stats)
-    return TimerReport(
-        timed_action_stats=action_stats,
-        total_calls=total_calls,
-        total_duration=total_time,
-    )
-
-
 def get_timer_summary(timer: TimerProtocol) -> str:
     """Given a timer, generate a summary of all the recorded actions.
 
@@ -251,7 +256,7 @@ def get_timer_summary(timer: TimerProtocol) -> str:
         ValueError
             If the input Timer has no recorded actions
     """
-    report: TimerReport = _make_report(timer)
+    report: TimerReport = timer._make_report()
 
     sep: str = os.linesep
     output_string = f"Timer Report{sep}"
@@ -279,7 +284,6 @@ def log_row(action: str, mean: str, num_calls: str, total: str, per: str) -> str
     output_string_len = len(header_string.expandtabs()) - 1
     sep_lines = f"{sep}{'-' * output_string_len}"
     output_string += sep_lines + header_string + sep_lines
-
     output_string += log_row(
         "Total", "-", f"{report.total_calls:}", f"{report.total_duration:.5}", "100 %"
     )