libuplift.datasets.colon#
The colon datasets from R survival package.
Functions#
|
Load the colon dataset from R survival package (uplift survival). |
Module Contents#
- libuplift.datasets.colon.fetch_colon(data_home=None, download_if_missing=True, random_state=None, shuffle=False, categ_as_strings=False, return_X_y=False, as_frame=False)[source]#
Load the colon dataset from R survival package (uplift survival).
Download it if necessary.
- Parameters:
- data_homestring, optional
Specify another download and cache folder for the datasets. By default all scikit-learn data is stored in ‘~/scikit_learn_data’ subfolders.
- download_if_missingboolean, default=True
If False, raise a IOError if the data is not locally available instead of trying to download the data from the source site.
- random_stateint, RandomState instance or None (default)
Determines random number generation for dataset shuffling. Pass an int for reproducible output across multiple function calls.
- shufflebool, default=False
Whether to shuffle dataset.
- categ_as_stringsbool, default=False
Whether to return categorical variables as strings.
- return_X_yboolean, default=False.
If True, returns
(data.data, data.target)instead of a Bunch object.- as_frameboolean, default=False
If True features are returned as pandas DataFrame. If False features are returned as object or float array. Float array is returned if all features are floats.
- Returns:
- datasetdict-like object with the following attributes:
- dataset.datanumpy array
Each row corresponds to the features in the dataset.
- dataset.target_recurrence_timenumpy array
Survival or censoring time.
- dataset.target_recurrence_statusnumpy array
Censoring. Each value is 0 (censored) or 1 (event).
- dataset.target_death_timenumpy array
Survival or censoring time.
- dataset.target_death_statusnumpy array
Censoring. Each value is 0 (censored) or 1 (event).
- dataset.DESCRstring
Description of the dataset.
- (data, target_time, target_status)tuple if
return_X_yis True