Add docstring to callbacks, add callbacs to api reference

ClaudioSalvatoreArcidiacono · Jul 31, 2024 · 3bb1d1f · 3bb1d1f
1 parent ed822f8
commit 3bb1d1f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/reference/callbacks.md b/docs/reference/callbacks.md
@@ -0,0 +1 @@
+::: felimination.callbacks
diff --git a/felimination/callbacks.py b/felimination/callbacks.py
@@ -1,5 +1,14 @@
+"""Callbacks for feature selection algorithms."""
+
+
 def plot_progress_callback(selector, *args, **kwargs):
-    """Plot the feature selection progress."""
+    """Plot the feature selection progress during the algorithm execution.
+
+    Parameters
+    ----------
+    selector : object
+        The feature selector object.
+    """
     from IPython import display
     from matplotlib import pyplot as plt