Skip to main content

Overview

CI Docs PyPI

A low-code Python-based open source deep learning library built on top of fastai, MONAI, TorchIO, and Imagedata.

fastMONAI simplifies the use of state-of-the-art deep learning techniques in 3D medical image analysis for solving classification, regression, and segmentation tasks. fastMONAI provides the users with functionalities to step through data loading, preprocessing, training, and result interpretations.

Note: This documentation is also available as interactive notebooks.

Requirements

  • Python: 3.10, 3.11, 3.12, or 3.13 (Python 3.12 recommended)
  • GPU: CUDA-compatible GPU recommended for training (CPU supported for inference)

Installation

We recommend using a conda environment to avoid dependency conflicts:

conda create -n fastmonai python=3.12

conda activate fastmonai

Quick Install (PyPI)

pip install fastMONAI

Development install (GitHub)

If you want to install an editable version of fastMONAI for development:

git clone https://github.com/MMIV-ML/fastMONAI
cd fastMONAI

# Create development environment
conda create -n fastmonai-dev python=3.12
conda activate fastmonai-dev

# Install in development mode
pip install -e '.[dev]'

Getting started

The best way to get started using fastMONAI is to read our paper and dive into our beginner-friendly video tutorial. For a deeper understanding and hands-on experience, our comprehensive instructional notebooks will walk you through model training for various tasks like classification, regression, and segmentation, running inference with a trained model, and patch-based training for large volumes that do not fit in memory. See the docs at https://fastmonai.no for more information.

Notebook 1-Click Notebook
11b_tutorial_classification.ipynb
shows how to construct a binary classification model based on MRI data.
Google Colab
11c_tutorial_regression.ipynb
shows how to construct a model to predict the age of a subject from MRI scans (“brain age”).
Google Colab
11d_tutorial_binary_segmentation.ipynb
shows how to do binary segmentation (extract the left atrium from monomodal cardiac MRI).
Google Colab
11e_tutorial_multiclass_segmentation.ipynb
shows how to perform segmentation from multimodal MRI (brain tumor segmentation).
Google Colab
11f_tutorial_inference.ipynb
shows how to run inference on new data with an exported learner.
Runs after 11d (inference on an exported model)
12a_tutorial_patch_training.ipynb
shows how to train a patch-based segmentation model on large 3D volumes with lazy loading (memory stays constant).
Google Colab
12b_tutorial_patch_cross_validation.ipynb
shows how to run k-fold cross-validation and train a final patch-based model.
Google Colab
12c_tutorial_patch_inference.ipynb
shows how to deploy a patch-based model with sliding-window inference on new scans.
Runs after 12b (inference on an exported model)

How to contribute

We welcome contributions! See CONTRIBUTING.md

Citing fastMONAI

If you are using fastMONAI in your research, please use the following citation:

@article{KALIYUGARASAN2023100583,
title = {fastMONAI: A low-code deep learning library for medical image analysis},
journal = {Software Impacts},
pages = {100583},
year = {2023},
issn = {2665-9638},
doi = {https://doi.org/10.1016/j.simpa.2023.100583},
url = {https://www.sciencedirect.com/science/article/pii/S2665963823001203},
author = {Satheshkumar Kaliyugarasan and Alexander S. Lundervold},
keywords = {Deep learning, Medical imaging, Radiology},
abstract = {We introduce fastMONAI, an open-source Python-based deep learning library for 3D medical imaging. Drawing upon the strengths of fastai, MONAI, and TorchIO, fastMONAI simplifies the use of advanced techniques for tasks like classification, regression, and segmentation. The library's design addresses domain-specific demands while promoting best practices, facilitating efficient model development. It offers newcomers an easier entry into the field while keeping the option to make advanced, lower-level customizations if needed. This paper describes the library's design, impact, limitations, and plans for future work.}
}

Metadata

Release files for fastMONAI 0.12.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fastMONAI 0.12.0
File Size Uploaded Provenance Actions
fastmonai-0.12.0.tar.gz 107.7 kB Without provenance Details for fastmonai-0.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fastMONAI 0.12.0
File Interpreter ABI Platform Actions
fastmonai-0.12.0-py3-none-any.whl Python 3 none any Details for fastmonai-0.12.0-py3-none-any.whl

Total release size: 216.0 kB

Release files / fastmonai-0.12.0.tar.gz

Download URL fastmonai-0.12.0.tar.gz
Size 107.7 kB
Tags Source
SHA-256 checksum
How to use checksums
3372a5676fb079b5cacca00e9403b75562a09e80ddda49311de4abad55e1076a
BLAKE2b-256 checksum
How to use checksums
db8d3438425830d8ce2ecd753ecfea2c4ba6a7c2a0691b21f9b3b1cd67f9a5fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / fastmonai-0.12.0-py3-none-any.whl

Download URL fastmonai-0.12.0-py3-none-any.whl
Size 108.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d8748cca07a78ebe785d696f3abbac754624448ee0a9825b4e5fd61263e22fa2
BLAKE2b-256 checksum
How to use checksums
0c06360ce92e32773e69946141a2127947e1581de4bf0dca50f9f52635e3c531
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Security for fastMONAI 0.12.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.12.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page