Update the docstring

unit8co · Dec 31, 2024 · b05eb8a · b05eb8a
1 parent a62f9f3
commit b05eb8a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/darts/ad/anomaly_model/anomaly_model.py b/darts/ad/anomaly_model/anomaly_model.py
@@ -284,6 +284,8 @@ def show_anomalies(
             Default: "AUC_ROC".
         score_kwargs
             parameters for the `score()` method.
+        multivariate_plot
+            If True, it will separately plot each component in multivariate series.
         """
         series = _check_input(series, name="series", num_series_expected=1)[0]
         predict_kwargs = predict_kwargs if predict_kwargs is not None else {}

diff --git a/darts/ad/anomaly_model/forecasting_am.py b/darts/ad/anomaly_model/forecasting_am.py
@@ -507,6 +507,8 @@ def show_anomalies(
             Optionally, the name of the metric function to use. Must be one of "AUC_ROC" (Area Under the
             Receiver Operating Characteristic Curve) and "AUC_PR" (Average Precision from scores).
             Default: "AUC_ROC".
+        multivariate_plot
+            If True, it will separately plot each component in multivariate series.
         score_kwargs
             parameters for the `score()` method.
         """

diff --git a/darts/ad/scorers/scorers.py b/darts/ad/scorers/scorers.py
@@ -209,6 +209,8 @@ def show_anomalies_from_prediction(
             Optionally, the name of the metric function to use. Must be one of "AUC_ROC" (Area Under the
             Receiver Operating Characteristic Curve) and "AUC_PR" (Average Precision from scores).
             Default: "AUC_ROC".
+        multivariate_plot
+            If True, it will separately plot each component in multivariate series.
         """
         series = _check_input(series, name="series", num_series_expected=1)[0]
         pred_series = _check_input(