updated docs

cantinilab · Aug 27, 2023 · cfcb94c · cfcb94c
1 parent eded401
commit cfcb94c
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/source/score.rst b/docs/source/score.rst
@@ -0,0 +1,7 @@
+mowgli.score
+----------------
+
+.. automodule:: mowgli.score
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/mowgli/score.py b/mowgli/score.py
@@ -41,6 +41,24 @@ def embedding_leiden_across_resolutions(
     n_neighbors: int,
     resolutions: Iterable[float] = np.arange(0.1, 2.1, 0.1),
 ):
+    """Compute the ARI and NMI for Leiden clustering on an embedding,
+    for various resolutions.
+
+    Args:
+        embedding (np.ndarray):
+            The embedding, shape (n_obs, n_latent)
+        labels (np.ndarray):
+            The labels, shape (n_obs,)
+        n_neighbors (int):
+            The number of neighbors to use for the kNN graph.
+        resolutions (Iterable[float], optional):
+            The resolutions to use for Leiden clustering. Defaults to
+            np.arange(0.1, 2.1, 0.1).
+
+    Returns:
+        Tuple[Iterable[float], Iterable[float], Iterable[float]]:
+            The resolutions, ARIs and NMIs.
+    """
     # Create an AnnData object with the joint embedding.
     joint_embedding = ad.AnnData(embedding)