trying to finally fix linting

owkin · Aug 12, 2024 · 5c654cc · 5c654cc
1 parent 6a64e58
commit 5c654cc
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/fedeca/strategies/fed_kaplan.py b/fedeca/strategies/fed_kaplan.py
@@ -18,6 +18,14 @@
 
 
 class FedKaplan(ComputePlanBuilder):
+    """_summary_
+
+    Parameters
+    ----------
+    ComputePlanBuilder : _type_
+        _description_
+    """
+
     def __init__(
         self,
         duration_col,
@@ -55,7 +63,7 @@ def build_compute_plan(
         num_rounds: Optional[int],
         clean_models: Optional[bool] = True,
     ):
-        """_summary_
+        """Build the computation plan.
 
         Parameters
         ----------
@@ -111,7 +119,7 @@ def compute_events_statistics(
         datasamples,
         shared_state=None,
     ):
-        """_summary_
+        """Compute events statistics for a subset of data.
 
         Parameters
         ----------
@@ -178,7 +186,7 @@ def aggregate_events_statistics(
         self,
         shared_states,
     ):
-        """_summary_
+        """Aggregate events statistics.
 
         Parameters
         ----------

diff --git a/fedeca/tests/test_km.py b/fedeca/tests/test_km.py
@@ -1,10 +1,12 @@
+"""Tests for the survival utils related to Kaplan Meier."""
 import numpy as np
 from lifelines import KaplanMeierFitter
 
 from fedeca.utils.survival_utils import compute_events_statistics, km_curve
 
 
 def test_compute_events_statistics():
+    """Test the computation of events statistics."""
     times = np.array([0.0, 3.2, 3.2, 5.5, 5.5, 10.0])
     events = np.array([True, True, False, True, True, False])
     unique_times_gt = np.array([0.0, 3.2, 5.5, 10.0])
@@ -24,6 +26,7 @@ def test_compute_events_statistics():
 
 
 def test_km_curve():
+    """Test the computation of the Kaplan Meier curve."""
     rng = np.random.RandomState(42)
     num_samples = 100
     times = rng.randint(0, high=21, size=(num_samples,))