A package for clinical AI pipeline development
Project description
medpipe
Table of content
Overview
The medpipe package is a layer to help create AI models for clinical applications from tabular data. It covers data loading and preprocessing, model creation and training, recalibration, and visualisation.
Installation
To install medpipe use pip:
$ pip install medpipe
or clone the GitHub repository and install the package with pip:
$ git clone git@github.com:Surgical-Recovery-and-Safety-Lab/medpipe.git
$ cd medpipe
$ pip install .
NOTE: It is recommended to use a virtual environment (venv) to install this package.
Ensure that the installation was succesfull and that all tests pass by running the following command in the medpipe directory:
$ pytest
Usage
This package was tested on a Linux distribution (Ubuntu 24.04) with Python v3.12.3. The sckit-learn was used as the base of most of the code.
A Pipeline contains the preprocessing operations, a model for each prediction label, and a recalibration model (if specified) for each label. Thus, with only a few lines of code, several models can be created from the same data and fitted.
Preprocessing operations
Currently four preprocessing operations are available:
- standarise, this operation standardises the input features by removing the mean and scaling to unit variance;
- ordinal encoding, this operation converts non-numerical categorical input features into ordinal ones;
- power transform, this operation applies a power transform to make the data more Gaussian-like;
- binning, this operation converts a continuous input feature into bins and caps the value.
Models
There is only one classifier available at the moment: the histogram boosted gradient classifier.
NOTE: Adding a new model only requires editing the create_model function in models/core. To work, it must have a fit and predict method.
Recalibration
Two recalibration models are available: logistic regression, and isotonic regression.
Metrics
The available metrics are divided into the score metrics and prediction metrics. The list of available metrics is the following:
| Metric | Type | Description |
|---|---|---|
| Accuracy | Prediction | Proportion of all classifications that were correct. |
| Recall | Prediction | Proportion of all actual positives that were classified correctly (true positive rate). |
| Precision | Prediction | Proportion of all the positive classifications that are actually positive. |
| F1 score | Prediction | Harmonic mean of precision and recall. |
| AUROC | Score | Area under the ROC curve. |
| AP | Score | Area under the precision-recall curve. |
| Log loss | Score | Logarithmic loss. |
Plots
Three types of plots are available: bar graphs for the metrics, predicted probability distributions, and calibration curves.
The following graphs are from one pipeline with two models, one to predict complications and the other to predict 90-day mortality. The predictor and calibrator results are plotted on the same graphs to compare the effect of recalibration.
Plots of the AUROC and log loss metric values with confidence intervals for each outcome:
| Any complication | 90-day mortality |
|---|---|
Predicted probability distributions for each outcome:
| Any complication | 90-day mortality |
|---|---|
Calibration curves for each outcome:
| Any complication | 90-day mortality |
|---|---|
Example
Here is a short example that shows how to load data, train the models, and plot the calibration curves:
from medpipe import (
Pipeline
read_toml_configuration,
load_data_from_csv,
get_positive_proba,
extract_labels,
plot_reliability_diagrams,
)
# Load configuration and data
config = read_toml_configuration("config_file.toml")
data = load_data_from_csv("data.csv")
# Create pipeline
pipeline = Pipeline(general_config)
# Split data into sets and train model
X_train, X_test = pipeline.get_test_data(data)
pipeline.run(X_train)
# Plot calibration curve
X_test, y_test = extract_labels(X_test, pipeline.label_list)
y_pred_proba = pipeline.predict_proba(X_test)
plot_reliability_diagrams(y_test, get_positive_proba(y_pred_proba, display_kwargs={"n_bins": 10, "strategy": "quantile"})
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file medpipe-0.2.0.dev0.tar.gz.
File metadata
- Download URL: medpipe-0.2.0.dev0.tar.gz
- Upload date:
- Size: 52.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d96d5c9671d54741fe63008a63ee3689dc45703a59dead8e63977ae79ff3c56
|
|
| MD5 |
18aabcf9a6f9fbd4bea0b8b125e01398
|
|
| BLAKE2b-256 |
634e50e4702e3fcdd9b90e770f93167d409a8cd8806f3a9674e33fb000e16d4c
|
File details
Details for the file medpipe-0.2.0.dev0-py3-none-any.whl.
File metadata
- Download URL: medpipe-0.2.0.dev0-py3-none-any.whl
- Upload date:
- Size: 48.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f0c4360faecc799e16e27baf0c110cb3dbdb09f826e6ed048d0d44a876d6fd42
|
|
| MD5 |
98832be1db8293645ed8fd23fe031d9e
|
|
| BLAKE2b-256 |
14fdc50dc00c0439037321a812e329ab5f522894459ef2a8c62ecf4031d51e29
|