DeepchecksClient.add_monitor#

DeepchecksClient.add_monitor(model_name: str, check_name: str, frequency: int, aggregation_window: Optional[int] = None, lookback: Optional[int] = None, name: Optional[str] = None, description: Optional[str] = None, add_to_dashboard: bool = True, kwargs_for_check: Optional[Dict[str, Any]] = None) int#

Create a new monitor to be displayed in the dashboard.

A monitor runs a selected check on data over time and displays the check’s result values.

Parameters
model_name: str

name of the model to which the monitor will be added

check_name: str

The check to monitor. The alert will monitor the value produced by the check’s reduce function.

frequency: int

How often the minitor would be calculated, provided in seconds.

aggregation_window: int, default: None

The aggregation window of each calculation of the monitor. If None, the aggregation window will be the same as the frequency. TODO: better explanation

lookback: int, default: None

Determines the time range for which the monitor is run, provided in seconds. If None, the lookback will be inferred based on the frequency.

name: str, default: None

The name to assign to the monitor.

description: str, default: None

The description to assigned to the monitor.

add_to_dashboard: bool, default: True

Whether to add the monitor to the dashboard screen.

kwargs_for_check: t.Dict, default = None

Additional kwargs to pass on to check.

Returns
int

created monitor id