Add missing endpoints for Monitors: (#156)

* Add missing endpoints for Monitors:

- Update & delete monitor endpoint
- Updated Streamlit to reflect new changes
- New endpoind tests
- Bug fixes in Streamlit
- Chnages in Model update endpoint

* Tests and documentation

Author: sinnec

.coverage

@@ -100,6 +100,27 @@ Creates a monitor for a specific metric.
 
     Some metrics like the data drift don't use a threshold so the feature that will be monitored should be inserted. In any case, both `feature` and `lower_threshold` can't be `None` at the same time.
 
+**_update_model_monitor_**_(model_monitor_id, name=None, status=None, severity=None, email=None, lower_threshold=None)_
+
+Updates a model monitor with a specific ID.
+
+| Parameter            | Type            | Description                                                                                                                    |
+| -------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| **model_monitor_id** | `str`           | The ID of the model monitor to update.                                                                                         |
+| **name**             | `str`           | The name of the monitor. Defaults to `None`.                                                                                   |
+| **status**           | `MonitorStatus` | The status of the monitor. Possible values for `MonitorStatus`: `active`, `inactive`. Defaults to `None`.                      |
+| **severity**         | `AlertSeverity` | The severity of the alert the monitor produces. Possible values for `AlertSeverity`: `low`, `mid`, `high`. Defaults to `None`. |
+| **email**            | `str`           | The email to which the alert will be sent. Defaults to `None`.                                                                 |
+| **lower_threshold**  | `float`         | The threshold below which an alert will be produced. Defaults to `None`.                                                       |
+
+**_delete_model_monitor_**_(model_monitor_id)_
+
+Deletes a model monitor with a specific ID.
+
+| Parameter            | Type  | Description                            |
+| -------------------- | ----- | -------------------------------------- |
+| **model_monitor_id** | `str` | The ID of the model monitor to update. |
+
 ## Metrics
 
 **_get_drifting_metrics_**_(model_id)_

docs/mkdocs/docs/sdk-docs.md

@@ -38,10 +38,6 @@
         "name": "Alerts",
         "description": "This set of endpoints handles a model's alerts.",
     },
-    {
-        "name": "Users",
-        "description": "This is a helper endpoint to create and delete an admin user in tests.",
-    },
     {
         "name": "Cron Tasks",
         "description": "This is a helper endpoint to trigger cron tasks for tests.",

whitebox/api/v1/docs.py

@@ -1,11 +1,17 @@
 from typing import List, Union
 from whitebox.middleware.auth import authenticate_user
-from whitebox.schemas.modelMonitor import ModelMonitor, ModelMonitorCreateDto
+from whitebox.schemas.modelMonitor import (
+    ModelMonitor,
+    ModelMonitorCreateDto,
+    ModelMonitorUpdateDto,
+    MonitorMetrics,
+)
 from fastapi import APIRouter, Depends, status
 from whitebox import crud
 from sqlalchemy.orm import Session
 from whitebox.core.db import get_db
 from whitebox.schemas.user import User
+from whitebox.schemas.utils import StatusCode
 from whitebox.utils.errors import add_error_responses, errors
 
 
@@ -27,6 +33,39 @@ async def create_model_monitor(
 ) -> ModelMonitor:
     """Inserts a model monitor into the database."""
 
+    model = crud.models.get(db, body.model_id)
+    if not model:
+        return errors.not_found("Model not found!")
+
+    if body.metric in [MonitorMetrics.concept_drift, MonitorMetrics.data_drift]:
+        if body.metric == MonitorMetrics.concept_drift:
+            body.feature = model.target_column
+        else:
+            if not body.feature:
+                return errors.bad_request(f"Please set a feature for the monitor!")
+            # TODO This should get the feature columns from model.features when this field is
+            # automatically updated from the training dataset.
+            dataset_row = crud.dataset_rows.get_first_by_filter(db, model_id=model.id)
+            if not dataset_row:
+                return errors.not_found(
+                    f"No training dataset found for model: {model.id}!\
+                    Insert the taining dataset and then create a monitor!"
+                )
+            features = dataset_row.processed
+            if body.feature not in features:
+                return errors.bad_request(
+                    f"Monitored featured must be in the dataset's features!"
+                )
+            if body.feature == model.target_column:
+                return errors.bad_request(
+                    f"Monitored featured cannot be the target column in data drift!"
+                )
+        body.lower_threshold = None
+    else:
+        if body.lower_threshold is None:
+            return errors.bad_request(f"Please set a lower threshold for the monitor!")
+        body.feature = None
+
     new_model_monitor = crud.model_monitors.create(db=db, obj_in=body)
     return new_model_monitor
 
@@ -60,3 +99,59 @@ async def get_all_models_model_monitors(
             return errors.not_found("Model not found")
     else:
         return crud.model_monitors.get_all(db=db)
+
+
+@model_monitors_router.put(
+    "/model-monitors/{model_monitor_id}",
+    tags=["Model Monitors"],
+    response_model=ModelMonitor,
+    summary="Update model monitor",
+    status_code=status.HTTP_200_OK,
+    responses=add_error_responses([400, 401, 404]),
+)
+async def update_model_monitor(
+    model_monitor_id: str,
+    body: ModelMonitorUpdateDto,
+    db: Session = Depends(get_db),
+    authenticated_user: User = Depends(authenticate_user),
+) -> ModelMonitor:
+    """Updates record of the model monitor with the specified id."""
+
+    # Remove all unset properties (with None values) from the update object
+    filtered_body = {k: v for k, v in dict(body).items() if v is not None}
+
+    model_monitor = crud.model_monitors.get(db=db, _id=model_monitor_id)
+
+    if not model_monitor:
+        return errors.not_found("Model monitor not found!")
+
+    if model_monitor.metric in [
+        MonitorMetrics.concept_drift,
+        MonitorMetrics.data_drift,
+    ]:
+        filtered_body["lower_threshold"] = None
+
+    return crud.model_monitors.update(db=db, db_obj=model_monitor, obj_in=filtered_body)
+
+
+@model_monitors_router.delete(
+    "/model-monitors/{model_monitor_id}",
+    tags=["Model Monitors"],
+    response_model=StatusCode,
+    summary="Delete model monitor",
+    status_code=status.HTTP_200_OK,
+    responses=add_error_responses([401, 404]),
+)
+async def delete_model_monitor(
+    model_monitor_id: str,
+    db: Session = Depends(get_db),
+    authenticated_user: User = Depends(authenticate_user),
+) -> StatusCode:
+    """Deletes the model monitor with the specified id from the database."""
+
+    model_monitor = crud.model_monitors.get(db=db, _id=model_monitor_id)
+    if not model_monitor:
+        return errors.not_found("Model monitor not found")
+
+    crud.model_monitors.remove(db=db, _id=model_monitor_id)
+    return {"status_code": status.HTTP_200_OK}

whitebox/api/v1/model_monitors.py

@@ -106,19 +106,22 @@ async def update_model(
 ) -> Model:
     """Updates record of the model with the specified id"""
 
+    # Remove all unset properties (with None values) from the update object
+    filtered_body = {k: v for k, v in dict(body).items() if v is not None}
+
     model = crud.models.get(db=db, _id=model_id)
 
     if not model:
         return errors.not_found("Model not found")
 
-    return crud.models.update(db=db, db_obj=model, obj_in=body)
+    return crud.models.update(db=db, db_obj=model, obj_in=filtered_body)
 
 
 @models_router.delete(
     "/models/{model_id}",
     tags=["Models"],
     response_model=StatusCode,
-    summary="Delete user",
+    summary="Delete model",
     status_code=status.HTTP_200_OK,
     responses=add_error_responses([401, 404]),
 )

whitebox/api/v1/models.py

@@ -30,4 +30,3 @@ class ModelCreateDto(ModelBase):
 class ModelUpdateDto(BaseModel):
     name: Optional[str]
     description: Optional[str]
-    type: Optional[ModelType]

whitebox/schemas/model.py

@@ -47,3 +47,11 @@ class ModelMonitor(ModelMonitorBase, ItemBase):
 
 class ModelMonitorCreateDto(ModelMonitorBase):
     pass
+
+
+class ModelMonitorUpdateDto(BaseModel):
+    name: Optional[str]
+    status: Optional[MonitorStatus]
+    severity: Optional[AlertSeverity]
+    email: Optional[str]
+    lower_threshold: Optional[float]