Skip to main content

Framework for healthcare ML implementation

Project description

cyclops Logo


PyPI code checks integration tests docs codecov license

cyclops is a framework for facilitating research and deployment of ML models in the health (or clinical) setting. It provides a few high-level APIs namely:

  • query - Querying EHR databases (such as MIMIC-IV)
  • process - Process static and temporal EHR data
  • evaluate - Evaluate models on clinical prediction tasks
  • monitor - Detect data drift relevant for clinical use cases

cyclops also provides a library of use-cases on clinical datasets. The implemented use cases include:

  • Mortality decompensation prediction

🐣 Getting Started

Installing cyclops using pip

python3 -m pip install pycyclops

🧑🏿‍💻 Developing

The development environment has been tested on python = 3.9.

The python virtual environment can be set up using poetry. Hence, make sure it is installed and then run:

poetry install
source $(poetry env info --path)/bin/activate

📚 Documentation

📓 Notebooks

To use jupyter notebooks, the python virtual environment can be installed and used inside an IPython kernel. After activating the virtual environment, run:

python3 -m ipykernel install --user --name <name_of_kernel>

Now, you can navigate to the notebook's Kernel tab and set it as <name_of_kernel>.

Tutorial notebooks in tutorials can be useful to view the functionality of the framework.

🎓 Citation

Reference to cite when you use CyclOps in a project or a research paper:

@article {Krishnan2022.12.02.22283021,
	author = {Krishnan, Amrit and Subasri, Vallijah and McKeen, Kaden and Kore, Ali and Ogidi, Franklin and Alinoori, Mahshid and Lalani, Nadim and Dhalla, Azra and Verma, Amol and Razak, Fahad and Pandya, Deval and Dolatabadi, Elham},
	title = {CyclOps: Cyclical development towards operationalizing ML models for health},
	elocation-id = {2022.12.02.22283021},
	year = {2022},
	doi = {10.1101/2022.12.02.22283021},
	publisher = {Cold Spring Harbor Laboratory Press},
	URL = {https://www.medrxiv.org/content/early/2022/12/08/2022.12.02.22283021},
	journal = {medRxiv}
}

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

pycyclops-0.1.10.tar.gz (189.6 kB view hashes)

Uploaded Source

Built Distribution

pycyclops-0.1.10-py3-none-any.whl (250.1 kB view hashes)

Uploaded Python 3

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