docstring for zero_thres

datasig-ac-uk · Oct 12, 2023 · 24ff19c · 24ff19c
1 parent 72f499f
commit 24ff19c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/signature_mahalanobis_knn/mahal_distance.py b/src/signature_mahalanobis_knn/mahal_distance.py
@@ -23,6 +23,9 @@ def __init__(
         svd_thres : float, optional
             Threshold to decide numerical rank of the data matrix,
             by default 1e-12.
+        zero_thres : float, optional
+            Threshold to decide whether the distance is zero,
+            by default 1e-15.
         """
         self.subspace_thres: float = subspace_thres
         self.svd_thres: float = svd_thres