sksurv.nonparametric.SurvivalFunctionEstimator#
- class sksurv.nonparametric.SurvivalFunctionEstimator(conf_level=0.95, conf_type=None)[source]#
Kaplan–Meier estimate of the survival function.
- Parameters:
conf_level (float, optional, default: 0.95) – The level for a two-sided confidence interval on the survival curves.
conf_type (None or {'log-log'}, optional, default: None.) – The type of confidence intervals to estimate. If None, no confidence intervals are estimated. If “log-log”, estimate confidence intervals using the log hazard or \(log(-log(S(t)))\).
See also
sksurv.nonparametric.kaplan_meier_estimator
Functional API of the Kaplan-Meier estimator.
Methods
__init__
([conf_level, conf_type])fit
(y)Estimate survival distribution from training data.
Get metadata routing of this object.
get_params
([deep])Get parameters for this estimator.
predict_proba
(time[, return_conf_int])Return probability of an event after given time point.
set_params
(**params)Set the parameters of this estimator.
set_predict_proba_request
(*[, ...])Request metadata passed to the
predict_proba
method.- fit(y)[source]#
Estimate survival distribution from training data.
- Parameters:
y (structured array, shape = (n_samples,)) – A structured array containing the binary event indicator as first field, and time of event or time of censoring as second field.
- Return type:
self
- get_metadata_routing()#
Get metadata routing of this object.
Please check User Guide on how the routing mechanism works.
- Returns:
routing – A
MetadataRequest
encapsulating routing information.- Return type:
MetadataRequest
- get_params(deep=True)#
Get parameters for this estimator.
- Parameters:
deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
params – Parameter names mapped to their values.
- Return type:
dict
- predict_proba(time, return_conf_int=False)[source]#
Return probability of an event after given time point.
\(\hat{S}(t) = P(T > t)\)
- Parameters:
time (array, shape = (n_samples,)) – Time to estimate probability at.
return_conf_int (bool, optional, default: False) – Whether to return the pointwise confidence interval of the survival function. Only available if
fit()
has been called with the conf_type parameter set.
- Returns:
prob (array, shape = (n_samples,)) – Probability of an event at the passed time points.
conf_int (array, shape = (2, n_samples)) – Pointwise confidence interval at the passed time points. Only provided if return_conf_int is True.
- set_params(**params)#
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline
). The latter have parameters of the form<component>__<parameter>
so that it’s possible to update each component of a nested object.- Parameters:
**params (dict) – Estimator parameters.
- Returns:
self – Estimator instance.
- Return type:
estimator instance
- set_predict_proba_request(*, return_conf_int: bool | None | str = '$UNCHANGED$', time: bool | None | str = '$UNCHANGED$') SurvivalFunctionEstimator #
Request metadata passed to the
predict_proba
method.Note that this method is only relevant if
enable_metadata_routing=True
(seesklearn.set_config()
). Please see User Guide on how the routing mechanism works.The options for each parameter are:
True
: metadata is requested, and passed topredict_proba
if provided. The request is ignored if metadata is not provided.False
: metadata is not requested and the meta-estimator will not pass it topredict_proba
.None
: metadata is not requested, and the meta-estimator will raise an error if the user provides it.str
: metadata should be passed to the meta-estimator with this given alias instead of the original name.
The default (
sklearn.utils.metadata_routing.UNCHANGED
) retains the existing request. This allows you to change the request for some parameters and not others.Added in version 1.3.
Note
This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a
Pipeline
. Otherwise it has no effect.- Parameters:
return_conf_int (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for
return_conf_int
parameter inpredict_proba
.time (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for
time
parameter inpredict_proba
.
- Returns:
self – The updated object.
- Return type:
object