Skip to content

Commit

Permalink
DOCS: Improve description of estimate parameter
Browse files Browse the repository at this point in the history
Fixes #414 and #416
  • Loading branch information
sebp committed Dec 30, 2023
1 parent ef6e9c3 commit 8d7b855
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions sksurv/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -545,9 +545,12 @@ def brier_score(survival_train, survival_test, estimate, times):
second field.
estimate : array-like, shape = (n_samples, n_times)
Estimated risk of experiencing an event for test data at `times`.
The i-th column must contain the estimated probability of
remaining event-free up to the i-th time point.
Estimated probability of remaining event-free at time points
specified by `times`. The value of ``estimate[i]`` must correspond to
the estimated probability of remaining event-free up to the time point
``times[i]``. Typically, estimated probabilities are obtained via the
survival function returned by an estimator's
``predict_survival_function`` method.
times : array-like, shape = (n_times,)
The time points for which to estimate the Brier score.
Expand Down Expand Up @@ -664,9 +667,12 @@ def integrated_brier_score(survival_train, survival_test, estimate, times):
second field.
estimate : array-like, shape = (n_samples, n_times)
Estimated risk of experiencing an event for test data at `times`.
The i-th column must contain the estimated probability of
remaining event-free up to the i-th time point.
Estimated probability of remaining event-free at time points
specified by `times`. The value of ``estimate[i]`` must correspond to
the estimated probability of remaining event-free up to the time point
``times[i]``. Typically, estimated probabilities are obtained via the
survival function returned by an estimator's
``predict_survival_function`` method.
times : array-like, shape = (n_times,)
The time points for which to estimate the Brier score.
Expand Down

0 comments on commit 8d7b855

Please sign in to comment.