From cdd004f7e053f4887feb8dda67e1a731c00fb835 Mon Sep 17 00:00:00 2001
From: ANDREY Paul <paul.andrey@inria.fr>
Date: Tue, 14 Feb 2023 10:17:24 +0000
Subject: [PATCH] Fix the main docstring of 'BinaryRocAUC'.
---
declearn/metrics/_roc_auc.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/declearn/metrics/_roc_auc.py b/declearn/metrics/_roc_auc.py
index a8a97dcc..4ed37a85 100644
--- a/declearn/metrics/_roc_auc.py
+++ b/declearn/metrics/_roc_auc.py
@@ -53,7 +53,9 @@ class BinaryRocAUC(Metric):
Note that this class supports aggregating states from another
BinaryRocAUC instance with different hyper-parameters into it,
- unless its
+ unless its `bound` parameter is set - in which case thresholds
+ are not authorized to be dynamically updated, either at samples
+ processing or states-aggregating steps.
"""
name: ClassVar[str] = "binary-roc"
--
GitLab