From fbfce4225655d9e3dedc17785196377c7947c194 Mon Sep 17 00:00:00 2001 From: Roy Sadaka Date: Thu, 15 Sep 2022 10:40:52 +0300 Subject: [PATCH] added documentation for threshold_checker in CallbackMonitor --- lpd/callbacks/callback_monitor.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lpd/callbacks/callback_monitor.py b/lpd/callbacks/callback_monitor.py index dd16629..82e8630 100644 --- a/lpd/callbacks/callback_monitor.py +++ b/lpd/callbacks/callback_monitor.py @@ -17,13 +17,14 @@ class CallbackMonitor: stats_type - e.g lpd.enums.StatsType.VAL monitor_mode - e.g. lpd.enums.MonitorMode.MIN, min wothh check if the metric decreased, MAX will check for increase metric_name - in case of monitor_mode=lpd.enums.MonitorMode.METRIC, provide metric_name, otherwise, leave it None + threshold_checker - to check if the criteria was met, if None, AbsoluteThresholdChecker with threshold=0.0 will be used """ def __init__(self, monitor_type: MonitorType, stats_type: StatsType, monitor_mode: MonitorMode, patience: int=None, metric_name: Optional[str]=None, - threshold_checker: Optional[ThresholdChecker] = None): + threshold_checker: Optional[ThresholdChecker]=None): self.patience = inf if patience is None or patience < 0 else patience self.patience_countdown = self.patience self.monitor_type = monitor_type