shap.datasets.nhanesi

shap.datasets.nhanesi(display: bool = False, n_points: int | None = None) → tuple[DataFrame, ndarray]

Return a nicely packaged version of NHANES I data with survival times as labels.

Used in survival analysis tasks.

Parameters:

displaybool, optional

If True, returns the features with a modified display. Default is False.

n_pointsint, optional

Number of data points to sample. Default is None (returns the entire dataset).

Returns:

Xpd.DataFrame

The feature data matrix. If display is True, a modified version of the features for display is returned as X instead.

ynp.ndarray

The target variables representing survival times.

Examples

Usage example:

features, survival_times = shap.datasets.nhanesi(display=True, n_points=100)