add docstring

ibm-granite · Jul 10, 2024 · 5e0ff94 · 5e0ff94
1 parent 51beee7
commit 5e0ff94
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/tsfm_public/toolkit/time_series_preprocessor.py b/tsfm_public/toolkit/time_series_preprocessor.py
@@ -233,7 +233,12 @@ def _validate_columns(self):
 
     def _get_timedelta_map(
         self,
-    ):
+    ) -> Dict[str, str]:
+        """Get a mapping that relates timedeltas to frequencies in the frequency map.
+
+        Returns:
+            Dict[str, str]: Dictionary of mappings from timedelta strings to frequency token names.
+        """
         td_map = {}
         for k, v in self.frequency_mapping.items():
             if k == "oov":