Merge pull request #108 from andrewm4894/clean-up-change-plot-labels

Clean up change plot labels

Author: andrewm4894

anomstack/alerts/email.py

@@ -24,6 +24,7 @@ def send_email_with_plot(
     attachment_name,
     threshold=0.8,
     score_col="metric_score_smooth",
+    score_title="anomaly_score"
 ) -> None:
     """
     Sends an email with a plot attached.
@@ -38,6 +39,8 @@ def send_email_with_plot(
             Defaults to 0.8.
         score_col (str, optional): The name of the column containing the
             anomaly scores. Defaults to 'metric_score_smooth'.
+        score_title (str, optional): The title of the score plot. Defaults to
+            'anomaly_score'.
 
     Returns:
         None
@@ -54,7 +57,9 @@ def send_email_with_plot(
     with tempfile.NamedTemporaryFile(
         prefix=attachment_name, suffix=".png", delete=False
     ) as temp:
-        fig = make_alert_plot(df, metric_name, threshold, score_col)
+        fig = make_alert_plot(
+            df, metric_name, threshold, score_col, score_title
+        )
         fig.savefig(temp.name)
 
         msg = MIMEMultipart()

anomstack/alerts/send.py

@@ -20,6 +20,7 @@ def send_alert(
     tags=None,
     score_col: str = "metric_score_smooth",
     metric_timestamp=None,
+    score_title="anomaly_score",
 ) -> pd.DataFrame:
     """
     Sends an alert using the specified alert methods.
@@ -57,6 +58,7 @@ def send_alert(
             threshold=threshold,
             score_col=score_col,
             metric_timestamp=metric_timestamp,
+            score_title=score_title,
         )
     if "email" in alert_methods:
         send_email_with_plot(
@@ -67,6 +69,7 @@ def send_alert(
             attachment_name=metric_name,
             threshold=threshold,
             score_col=score_col,
+            score_title=score_title,
         )
 
     return df

anomstack/alerts/slack.py

@@ -136,6 +136,7 @@ def send_alert_slack_with_plot(
     score_col="metric_score_smooth",
     channel_name=None,
     metric_timestamp=None,
+    score_title="anomaly_score",
 ) -> None:
     """
     Sends an alert to Slack with a plot attached.
@@ -149,7 +150,9 @@ def send_alert_slack_with_plot(
         suffix=".png",
         delete=False
     ) as temp:
-        fig = make_alert_plot(df, metric_name, threshold, score_col)
+        fig = make_alert_plot(
+            df, metric_name, threshold, score_col, score_title
+        )
         fig.savefig(temp.name)
         plt.close(fig)
 

anomstack/jobs/change.py

@@ -154,6 +154,7 @@ def alert(df_change_alerts) -> pd.DataFrame:
                         alert_methods=alert_methods,
                         tags=tags,
                         score_col="metric_score",
+                        score_title="change_score",
                     )
 
             return df_change_alerts

anomstack/jobs/score.py

@@ -149,7 +149,8 @@ def score(df) -> pd.DataFrame:
                     scores = pd.DataFrame(scores).min(axis=1).values
                 else:
                     raise ValueError(
-                        f"model_combination_method {model_combination_method} not supported."
+                        f"model_combination_method {model_combination_method} "
+                        f"not supported."
                     )
 
                 # create initial df_score

anomstack/plots/plot.py

@@ -15,6 +15,7 @@ def make_alert_plot(
     metric_name: str,
     threshold: float = 0.8,
     score_col: str = "metric_score_smooth",
+    score_title: str = "anomaly_score",
 ) -> Figure:
     """
     Creates a plot with two subplots: one for the metric values and another
@@ -27,6 +28,8 @@ def make_alert_plot(
             Defaults to 0.8.
         score_col (str, optional): The name of the column containing the
             anomaly scores. Defaults to 'metric_score_smooth'.
+        score_title (str, optional): The label for the y-axis of the score
+            plot.
 
     Returns:
         plt: The matplotlib figure object.
@@ -51,7 +54,7 @@ def make_alert_plot(
     ax1.legend(loc="upper left")
 
     ax2 = df_plot[score_col].plot(
-        title="Score",
+        title=score_title,
         ax=axes[1],
         rot=45,
         linestyle="--",
@@ -74,7 +77,7 @@ def make_alert_plot(
         [f'{item.strftime("%Y-%m-%d %H:%M")}' for item in df_plot.index.tolist()],
         rotation=45,
     )
-    ax2.set_ylabel("Score")
+    ax2.set_ylabel(score_title)
     if df_plot[score_col].max() <= 1:
         ax2.set_ylim(0, 1)
     else: