From b05eb8a2bc241cbc8e6bbbb439cd046527ee1bd2 Mon Sep 17 00:00:00 2001 From: he weilin Date: Tue, 31 Dec 2024 09:06:50 +0800 Subject: [PATCH] Update the docstring --- darts/ad/anomaly_model/anomaly_model.py | 2 ++ darts/ad/anomaly_model/forecasting_am.py | 2 ++ darts/ad/scorers/scorers.py | 2 ++ 3 files changed, 6 insertions(+) diff --git a/darts/ad/anomaly_model/anomaly_model.py b/darts/ad/anomaly_model/anomaly_model.py index 49ebe63ba9..d75ad18ab0 100644 --- 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 index 348e025e9f..7fee356cb6 100644 --- 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 index d797c93212..66f01b6692 100644 --- 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(