Skip to main content

Survival analysis built on top of scikit-learn

Project description

License readthedocs.org Digital Object Identifier (DOI)

Linux Build Status macOS Build Status Windows Build Status on AppVeyor codecov Codacy Badge

scikit-survival

scikit-survival is a Python module for survival analysis built on top of scikit-learn. It allows doing survival analysis while utilizing the power of scikit-learn, e.g., for pre-processing or doing cross-validation.

About Survival Analysis

The objective in survival analysis (also referred to as time-to-event or reliability analysis) is to establish a connection between covariates and the time of an event. What makes survival analysis differ from traditional machine learning is the fact that parts of the training data can only be partially observed – they are censored.

For instance, in a clinical study, patients are often monitored for a particular time period, and events occurring in this particular period are recorded. If a patient experiences an event, the exact time of the event can be recorded – the patient’s record is uncensored. In contrast, right censored records refer to patients that remained event-free during the study period and it is unknown whether an event has or has not occurred after the study ended. Consequently, survival analysis demands for models that take this unique characteristic of such a dataset into account.

Requirements

  • Python 3.7 or later

  • ecos

  • joblib

  • numexpr

  • numpy 1.16 or later

  • osqp

  • pandas 0.25 or later

  • scikit-learn 1.0

  • scipy 1.0 or later

  • C/C++ compiler

Installation

The easiest way to install scikit-survival is to use Anaconda by running:

conda install -c sebp scikit-survival

Alternatively, you can install scikit-survival from source following this guide.

Examples

The user guide provides in-depth information on the key concepts of scikit-survival, an overview of available survival models, and hands-on examples in the form of Jupyter notebooks.

Help and Support

Documentation

Bug reports

  • If you encountered a problem, please submit a bug report.

Questions

  • If you have a question on how to use scikit-survival, please use GitHub Discussions.

  • For general theoretical or methodological questions on survival analysis, please use Cross Validated.

Contributing

New contributors are always welcome. Please have a look at the contributing guidelines on how to get started and to make sure your code complies with our guidelines.

References

Please cite the following paper if you are using scikit-survival.

S. Pölsterl, “scikit-survival: A Library for Time-to-Event Analysis Built on Top of scikit-learn,” Journal of Machine Learning Research, vol. 21, no. 212, pp. 1–6, 2020.

@article{sksurv,
  author  = {Sebastian P{\"o}lsterl},
  title   = {scikit-survival: A Library for Time-to-Event Analysis Built on Top of scikit-learn},
  journal = {Journal of Machine Learning Research},
  year    = {2020},
  volume  = {21},
  number  = {212},
  pages   = {1-6},
  url     = {http://jmlr.org/papers/v21/20-729.html}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scikit-survival-0.17.0.tar.gz (2.5 MB view details)

Uploaded Source

Built Distributions

scikit_survival-0.17.0-cp39-cp39-win_amd64.whl (2.5 MB view details)

Uploaded CPython 3.9 Windows x86-64

scikit_survival-0.17.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

scikit_survival-0.17.0-cp39-cp39-macosx_10_13_x86_64.whl (2.5 MB view details)

Uploaded CPython 3.9 macOS 10.13+ x86-64

scikit_survival-0.17.0-cp38-cp38-win_amd64.whl (2.5 MB view details)

Uploaded CPython 3.8 Windows x86-64

scikit_survival-0.17.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (5.0 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

scikit_survival-0.17.0-cp38-cp38-macosx_10_13_x86_64.whl (2.5 MB view details)

Uploaded CPython 3.8 macOS 10.13+ x86-64

scikit_survival-0.17.0-cp37-cp37m-win_amd64.whl (2.5 MB view details)

Uploaded CPython 3.7m Windows x86-64

scikit_survival-0.17.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.9 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

scikit_survival-0.17.0-cp37-cp37m-macosx_10_13_x86_64.whl (2.5 MB view details)

Uploaded CPython 3.7m macOS 10.13+ x86-64

File details

Details for the file scikit-survival-0.17.0.tar.gz.

File metadata

  • Download URL: scikit-survival-0.17.0.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for scikit-survival-0.17.0.tar.gz
Algorithm Hash digest
SHA256 ba49325f6a31e8bdccfb88337aa85218d209e88a6a704e9c41ef13bf749e0f46
MD5 9167333aa9f2af6222b95d7689b64571
BLAKE2b-256 09fddfd6631059329911a12608cb8b1273580a33123927a32544297201e244b9

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 a042a32a51dfd9ee1ad3824559e6b00192ffdff31f781bdac5e7373c629fe56d
MD5 04fa4533b7664fec921989803629c565
BLAKE2b-256 62bd3f99638257db693b4fc05cfb37a7b900c42fc04adae8491535943950b785

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8909035e67cc7905fc26c44002a42cbeb78fe4e2404a2f74d42f7d54b95bfb58
MD5 db37adfd45b38df7e96a9bdb0f52f7f3
BLAKE2b-256 bd3fea345d9bb7526b05611af91f1cbc4033c8634983a0a3a1742b9d7bf5a112

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp39-cp39-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp39-cp39-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 3c2b6f3f05023a1be88d2de1ad8b9cb851758c287e1ab399635b2d0d5abfc904
MD5 e3faa2ff9bdb096fb146a87218af8141
BLAKE2b-256 98e9c2bb06d98b82e04cbb7b9dbf7c5d490d9bfb4ede2789d2e3faa9b8b85c42

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp38-cp38-win_amd64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 fce13ea133bc1a817dd6ffd6a5290325d2ab721bdd376be5e315b6ce76a82ad0
MD5 4dbbd2bcac37ccbe3cd4f737815ae508
BLAKE2b-256 151dd8a7928862acf95cc46a14681a4ddb9c47aba58eb21cdb09db897faa7a7d

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2496aa04e8d7b5877de6e1be987101fe446bd2568422f1259a8023667bf9b9a1
MD5 de51a966404e856375d6cf27dfa3ee31
BLAKE2b-256 dfccae123bdebe9eaec0beb8c1ab6903e3a9c1d31a88931c1be123b7712d801f

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp38-cp38-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp38-cp38-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 56f0708d319bc3f1bf758e10d1ea9d7eab8ab599d2a897abcdb7746cefa1eea6
MD5 867dfe315534f3a2fcd8896fb184eb36
BLAKE2b-256 419309559b90835f400c34b1c3168b02b00f293fd31051318bf350f144587261

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp37-cp37m-win_amd64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 387574eeb929250a2633ec2d386f670a0b70366504291df95e09a65f5bf5023b
MD5 867049a726ce6149a277732fc23c8714
BLAKE2b-256 4ae06534b697c97a5a1795ca2970a3c41b564a48501c80caad08ba55affc9a34

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e8e4ebcf18814e6f8943909ac064083650d6b99f30e8af5dc3fc40d3d93cb802
MD5 ee681c336343436e230b3ef78789213c
BLAKE2b-256 33bc229c57fbf22c3ebf95bee6b25354910d5467e638b303dea08c38af86af99

See more details on using hashes here.

File details

Details for the file scikit_survival-0.17.0-cp37-cp37m-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for scikit_survival-0.17.0-cp37-cp37m-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 3b6ca69c878bde47641365ec12352bd5270a0d139492730d9f22ae51bcf72949
MD5 959f1b9696c0c29e6207c8d6963ff1d9
BLAKE2b-256 d07f7331a1664937ad328b7023ba313ff310d23dc6b39483bbd2dee3021d7649

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page