fix: add docstrings

Signed-off-by: s0nicboOm <[email protected]>
numaproj · Nov 14, 2023 · 53f64f5 · 53f64f5
1 parent 2f40238
commit 53f64f5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/numalogic/config/_config.py b/numalogic/config/_config.py
@@ -85,6 +85,8 @@ class LightningTrainerConf:
 
 @dataclass
 class TrainerConf:
+    """Schema for defining the trainer config."""
+
     train_hours: int = 24 * 8  # 8 days worth of data
     min_train_size: int = 2000
     retrain_freq_hr: int = 24

diff --git a/numalogic/udfs/tools.py b/numalogic/udfs/tools.py
@@ -18,7 +18,7 @@
 
 
 class _DedupMetadata(NamedTuple):
-    """namedtuple for Dedup Metadata."""
+    """Data Structure for Dedup Metadata."""
 
     msg_read_ts: Optional[str]
     msg_train_ts: Optional[str]