Skip to main content

Automated identification of micronuclei for chromosomal instability (CIN) quantification.

Project description

micronuclAI

PyPI PyPI - Python Version PyPI - License PyPI - Downloads

Automated assessment of Chromosomal Instability through quantification of micronuclei (MN) and Nuclear Buds (NBUDs).

screenshot

micronuclAI is an automated pipeline for reliable quantification of micronuclei of varying size, morphology and location from nuclei-stained images. The pipeline can be divided into 3 steps: 1) segmentation, 2) nuclei isolation, and 3) quantification. In brief, single-cell crops are extracted from high-resolution microscopy images with the help of segmentation masks, which are then used to train a convolutional neural network (CNN) to output the number of MN associated with each cell.

Getting Started

Stream-lit App

A webapp implementation of micronuclAI is available through streamlit under:

GitHub:
https://github.com/SchapiroLabor/micronuclAI_streamlit

Streamlit:
https://micronuclai.streamlit.app

screenshot

Inference of micronuclei can be achieved in small to medium-sized example images that can be uploaded to the streamlit app. Image data is processed within a virtual machine (VM) on Heicloud, a local Cloud infrastructure provided by University Computing Center Heidelberg, and images are immediately deleted after micronuclei inference. Once micronuclei are inferred, results predictions as well as several plots describing the results are generated and presented to the user within the streamlit app which can also be downloaded as csv files.

Installation

We recomend to install micronuclAI in a clean environment with Python 3.10, 3.11, or 3.12.
micronuclAI uses PyTorch as the main deep learning framework, check the official website for the specific installation instructions for your system.

Install micronuclAI from PyPI.

pip install micronuclai

Usage

Two input files are required for micronuclAI

  1. Nuclei-stained Image
  2. Associated Mask

You can use micronuclAI to predict micronuclei in an image using the following command:

micronuclai-predict.py -i <path/to/image> -m <path/to/mask> -mod <path/to/model> -o <path/to/output/folder>

A test dataset has been provided in the test_data folder with a mask and its corresponding image file.

python src/model/micronuclai_predict.py -i ./test/test_image.tiff -m ./test/test_mask.tiff -mod ./models/micronuclai.pt -o ./test/output

Parameters and Arguments

Parameter Short Form Required Default Type Description
--image -i Yes N/A String Pathway to image.
--mask -m Yes N/A String Pathway to mask.
--model -mod Yes N/A String Pathway to prediction model.
--out -o Yes N/A String Path to the output data folder.
--size -s No (256, 256) List of int Size of images for training.
--resizing_factor -rf No 0.6 Float Resizing factor for images.
--expansion -e No 25 Int Expansion factor for images.
--device -d No "cpu" String Device to be used for training.
--batch_size -bs No 32 Int Batch size for training.

Citation

https://doi.org/10.1038/s42003-025-07796-4

@article{IbarraArellano2025,
  title = {micronuclAI enables automated quantification of micronuclei for assessment of chromosomal instability},
  volume = {8},
  ISSN = {2399-3642},
  url = {http://dx.doi.org/10.1038/s42003-025-07796-4},
  DOI = {10.1038/s42003-025-07796-4},
  number = {1},
  journal = {Communications Biology},
  publisher = {Springer Science and Business Media LLC},
  author = {Ibarra-Arellano,  Miguel A. and Caprio,  Lindsay A. and Hada,  Aroj and Stotzem,  Niklas and Cai,  Luke L. and Shah,  Shivem B. and Walsh,  Zachary H. and Melms,  Johannes C. and W\"{u}nneman,  Florian and Bestak,  Kresimir and Mansaray,  Ibrahim and Izar,  Benjamin and Schapiro,  Denis},
  year = {2025},
  month = mar 
}

License

micronuclAI offers a dual licensing mode the GNU Affero General Public License v3.0 - see LICENSE and ESSENTIAL_LICENSE_CONDITIONS.txt

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

micronuclai-0.1.2.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

micronuclai-0.1.2-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file micronuclai-0.1.2.tar.gz.

File metadata

  • Download URL: micronuclai-0.1.2.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for micronuclai-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1e40e367a25cd690f6a08a2e4a26263133a5b3cb82562ad356ef4ec90059ad59
MD5 e7dcb81660f685b9138be00bb1617ad9
BLAKE2b-256 8f41d14376ad54a21abde97612e38b407c070a5b7d44ed15716969687a9e01b8

See more details on using hashes here.

File details

Details for the file micronuclai-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: micronuclai-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 30.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for micronuclai-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d50b94630648c643e29f708ce2f174944fe942ffdb4ad429a6b232e8f0ace344
MD5 8d7615765cee65b27d7b9d8342d714bb
BLAKE2b-256 6393728f06560eb7b4b7642cea07834296d750a0f8ebb18ba1a12ea5e3cfe691

See more details on using hashes here.

Supported by

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