Add some docstrings. Effectively ignore __init__

juanmc2005 · Nov 13, 2023 · b2547d6 · b2547d6
1 parent 4d054d2
commit b2547d6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,7 +24,6 @@
 ]
 
 autoapi_dirs = ["../src/diart"]
-autoapi_ignore = ["*__init__"]
 autoapi_options = [
     "members",
     "undoc-members",
@@ -57,7 +56,11 @@
 
 
 def skip_submodules(app, what, name, obj, skip, options):
-    return name.startswith("diart.console") or name.startswith("diart.argdoc")
+    return (
+        name.endswith("__init__")
+        or name.startswith("diart.console")
+        or name.startswith("diart.argdoc")
+    )
 
 
 def setup(sphinx):

diff --git a/src/diart/blocks/embedding.py b/src/diart/blocks/embedding.py
@@ -69,7 +69,13 @@ def __call__(
 
 
 class OverlappedSpeechPenalty:
-    """
+    """Applies a penalty on overlapping speech and low-confidence regions to speaker segmentation scores.
+
+    .. note::
+        For more information, see `"Overlap-Aware Low-Latency Online Speaker Diarization
+        based on End-to-End Local Segmentation" <https://github.com/juanmc2005/diart/blob/main/paper.pdf>`_
+        (Section 2.2.1 Segmentation-driven speaker embedding). This block implements Equation 2.
+
     Parameters
     ----------
     gamma: float, optional