scikit-survival 0.24.0__cp310-cp310-macosx_11_0_arm64.whl → 0.25.0__cp310-cp310-macosx_11_0_arm64.whl

sksurv/meta/stacking.py

@@ -67,11 +67,11 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
     n_features_in_ : int
         Number of features seen during ``fit``.
 
-    feature_names_in_ : ndarray of shape (`n_features_in_`,)
+    feature_names_in_ : ndarray, shape = (`n_features_in_`,)
         Names of features seen during ``fit``. Defined only when `X`
         has feature names that are all strings.
 
-    unique_times_ : array of shape = (n_unique_times,)
+    unique_times_ : ndarray, shape = (n_unique_times,)
         Unique time points.
     """
 
@@ -199,6 +199,7 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
         return Xt
 
     def __len__(self):
+        """Return the number of base estimators."""
         return len(self.base_estimators)
 
     def fit(self, X, y=None, **fit_params):
@@ -209,9 +210,12 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
         X : array-like, shape = (n_samples, n_features)
             Training data.
 
-        y : array-like, optional
+        y : array-like, shape = (n_samples,), optional
             Target data if base estimators are supervised.
 
+        **fit_params : dict
+            Parameters passed to the ``fit`` method of each base estimator.
+
         Returns
         -------
         self
@@ -228,7 +232,7 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
     def predict(self, X):
         """Perform prediction.
 
-        Only available of the meta estimator has a predict method.
+        Only available if the meta estimator has a ``predict`` method.
 
         Parameters
         ----------
@@ -237,10 +241,10 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
 
         Returns
         -------
-        prediction : array, shape = (n_samples, n_dim)
+        prediction : ndarray, shape = (n_samples, n_dim)
             Prediction of meta estimator that combines
             predictions of base estimators. `n_dim` depends
-            on the return value of meta estimator's `predict`
+            on the return value of meta estimator's ``predict``
             method.
         """
         Xt = self._predict_estimators(X)
@@ -250,7 +254,7 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
     def predict_proba(self, X):
         """Perform prediction.
 
-        Only available if the meta estimator has a predict_proba method.
+        Only available if the meta estimator has a ``predict_proba`` method.
 
         Parameters
         ----------
@@ -272,7 +276,7 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
     def predict_log_proba(self, X):
         """Perform prediction.
 
-        Only available if the meta estimator has a predict_log_proba method.
+        Only available if the meta estimator has a ``predict_log_proba`` method.
 
         Parameters
         ----------
@@ -298,24 +302,33 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
     def predict_cumulative_hazard_function(self, X, return_array=False):
         """Perform prediction.
 
-        Only available if the meta estimator has a predict_cumulative_hazard_function method.
+        Only available if the meta estimator has a ``predict_cumulative_hazard_function`` method.
 
         Parameters
         ----------
         X : array-like, shape = (n_samples, n_features)
             Data with samples to predict.
 
-        return_array : boolean, default: False
-            If set, return an array with the cumulative hazard rate
-            for each `self.unique_times_`, otherwise an array of
-            :class:`sksurv.functions.StepFunction`.
+        return_array : bool, default: False
+            Whether to return a single array of cumulative hazard values
+            or a list of step functions.
+
+            If `False`, a list of :class:`sksurv.functions.StepFunction`
+            objects is returned.
+
+            If `True`, a 2d-array of shape `(n_samples, n_unique_times)` is
+            returned, where `n_unique_times` is the number of unique
+            event times in the training data. Each row represents the cumulative
+            hazard function of an individual evaluated at `unique_times_`.
 
         Returns
         -------
         cum_hazard : ndarray
-            If `return_array` is set, an array with the cumulative hazard rate
-            for each `self.unique_times_`, otherwise an array of length `n_samples`
-            of :class:`sksurv.functions.StepFunction` instances will be returned.
+            If `return_array` is `False`, an array of `n_samples`
+            :class:`sksurv.functions.StepFunction` instances is returned.
+
+            If `return_array` is `True`, a numeric array of shape
+            `(n_samples, n_unique_times_)` is returned.
         """
         Xt = self._predict_estimators(X)
         return self.final_estimator_.predict_cumulative_hazard_function(Xt, return_array)
@@ -324,25 +337,33 @@ class Stacking(MetaEstimatorMixin, SurvivalAnalysisMixin, _BaseComposition):
     def predict_survival_function(self, X, return_array=False):
         """Perform prediction.
 
-        Only available if the meta estimator has a predict_survival_function method.
+        Only available if the meta estimator has a ``predict_survival_function`` method.
 
         Parameters
         ----------
         X : array-like, shape = (n_samples, n_features)
             Data with samples to predict.
 
+        return_array : bool, default: False
+            Whether to return a single array of survival probabilities
+            or a list of step functions.
+
+            If `False`, a list of :class:`sksurv.functions.StepFunction`
+            objects is returned.
+
+            If `True`, a 2d-array of shape `(n_samples, n_unique_times)` is
+            returned, where `n_unique_times` is the number of unique
+            event times in the training data. Each row represents the survival
+            function of an individual evaluated at `unique_times_`.
+
         Returns
         -------
         survival : ndarray
-            If `return_array` is set, an array with the probability of
-            survival for each `self.unique_times_`, otherwise an array of
-            length `n_samples` of :class:`sksurv.functions.StepFunction`
-            instances will be returned.
-
-        return_array : boolean, default: False
-            If set, return an array with the probability
-            of survival for each `self.unique_times_`,
-            otherwise an array of :class:`sksurv.functions.StepFunction`.
+            If `return_array` is `False`, an array of `n_samples`
+            :class:`sksurv.functions.StepFunction` instances is returned.
+
+            If `return_array` is `True`, a numeric array of shape
+            `(n_samples, n_unique_times_)` is returned.
 
         """
         Xt = self._predict_estimators(X)