From c4ed564bd635d331e05e9fdda3af4e45671e7f69 Mon Sep 17 00:00:00 2001 From: foefl Date: Wed, 7 Jan 2026 14:42:42 +0100 Subject: [PATCH] add hint for value range of anomaly threshold, closes #28 --- README.md | 4 ++-- cli.py | 2 +- cli_mocked.py | 2 +- docs/manual.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4b72e64..69665e5 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ positional arguments: options: -h, --help show this help message and exit -t ANOMALY_THRESHOLD, --anomaly_threshold ANOMALY_THRESHOLD - optional anomaly threshold to set, default: 0.14, type: float + optional anomaly threshold to set, must be between 0 < value < 1, default: 0.14, type: float ``` Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter: @@ -61,7 +61,7 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b Diese Parameter sind obligatorisch und müssen bereitgestellt werden. Die Analyse ist stets für nur ein Bild zur selben Zeit durchführbar. Eine Übergabe mehrerer Dateien ist nicht möglich. Ausgaben, die nicht auf Fehler zurückzuführen sind, werden standardmäßig über ``STDOUT`` ausgegeben. -Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14. +Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Der Wert muss im Intervall ``(0, 1)`` liegen. Bei ``0`` würde nie und bei ``1`` immer eine Anomlie detektiert werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14. ### Fehlermeldungen diff --git a/cli.py b/cli.py index b4ccde3..30fffdf 100644 --- a/cli.py +++ b/cli.py @@ -39,7 +39,7 @@ def main() -> int: "-t", "--anomaly_threshold", help=( - f"optional anomaly threshold to set, default: " + f"optional anomaly threshold to set, must be between 0 < value < 1, default: " f"{constants.ANOMALY_THRESHOLD_DEFAULT}, type: float" ), default=constants.ANOMALY_THRESHOLD_DEFAULT, diff --git a/cli_mocked.py b/cli_mocked.py index 66574a8..7bb7021 100644 --- a/cli_mocked.py +++ b/cli_mocked.py @@ -42,7 +42,7 @@ def main() -> int: "-t", "--anomaly_threshold", help=( - f"optional anomaly threshold to set, default: " + f"optional anomaly threshold to set, must be between 0 < value < 1, default: " f"{constants.ANOMALY_THRESHOLD_DEFAULT}, type: float" ), default=constants.ANOMALY_THRESHOLD_DEFAULT, diff --git a/docs/manual.md b/docs/manual.md index e8f9e9c..aef7417 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -47,7 +47,7 @@ positional arguments: options: -h, --help show this help message and exit -t ANOMALY_THRESHOLD, --anomaly_threshold ANOMALY_THRESHOLD - optional anomaly threshold to set, default: 0.14, type: float + optional anomaly threshold to set, must be between 0 < value < 1, default: 0.14, type: float ``` Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter: @@ -58,7 +58,7 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b Diese Parameter sind obligatorisch und müssen bereitgestellt werden. Die Analyse ist stets für nur ein Bild zur selben Zeit durchführbar. Eine Übergabe mehrerer Dateien ist nicht möglich. Ausgaben, die nicht auf Fehler zurückzuführen sind, werden standardmäßig über ``STDOUT`` ausgegeben. -Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14. +Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Der Wert muss im Intervall ``(0, 1)`` liegen. Bei ``0`` würde nie und bei ``1`` immer eine Anomlie detektiert werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14. ### Fehlermeldungen