rename debug to return_indices

datasig-ac-uk · Nov 24, 2023 · 56fff8f · 56fff8f
1 parent c944883
commit 56fff8f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/paper-examples/example2.ipynb b/paper-examples/example2.ipynb
@@ -105,10 +105,10 @@
     "print(f\"fit_time: {fit_time}\")\n",
     "\n",
     "inlier_dists, inlier_ix = signature_maha_knn.conformance(\n",
-    "    data.test_inlier, n_neighbors=n_neighbours, debug=True\n",
+    "    data.test_inlier, n_neighbors=n_neighbours, return_indices=True\n",
     ")\n",
     "outlier_dists, outlier_ix = signature_maha_knn.conformance(\n",
-    "    data.test_outlier, n_neighbors=n_neighbours, debug=True\n",
+    "    data.test_outlier, n_neighbors=n_neighbours, return_indices=True\n",
     ")"
    ]
   },

diff --git a/src/signature_mahalanobis_knn/sig_mahal_knn.py b/src/signature_mahalanobis_knn/sig_mahal_knn.py
@@ -177,7 +177,7 @@ def conformance(
         X_test: np.ndarray | None = None,
         signatures_test: np.ndarray | None = None,
         n_neighbors: int = 20,
-        debug=False,
+        return_indices: bool = False,
     ) -> np.ndarray:
         """
         Compute the conformance scores for the data points either passed in
@@ -199,6 +199,9 @@ def conformance(
         signatures_test : np.ndarray | None, optional
             Signatures of the data points, by default None.
             Two dimensional array of shape (n_samples, sig_dim).
+        return_indices : bool, optional
+            Whether to return the indices of the nearest neighbors,
+            by default False.
 
         Returns
         -------
@@ -269,7 +272,7 @@ def conformance(
         candidate_distances[rho > self.mahal_distance.subspace_thres] = np.inf
 
         # compute the minimum of the candidate distances for each data point
-        if debug:
+        if return_indices:
             return np.min(candidate_distances, axis=-1), train_indices
 
         return np.min(candidate_distances, axis=-1)