Skip to content

angelolab/Nimbus-Inference

Repository files navigation

Nimbus Logo

CI Documentation Status PyPI Downloads Open In Colab

Nimbus Inference

Nimbus is a deep learning model for automated classification of marker expression in multiplexed imaging data. This repository provides code for:

  • Inference of the Nimbus model on your multiplexed images.
  • Finetuning the Nimbus model on new data if desired.
  • Interactive exploration of the Nimbus Gold Standard dataset.

The code for training the Nimbus model from scratch can be found in the angelolab/Nimbus repository

Installation (via pip)

pip install Nimbus-Inference

Create a Python environment with version 3.9–3.11, then install as shown above.


Example Notebooks

We provide three Jupyter notebooks (in the templates folder), each with its own example dataset that is loaded from the Hugging Face Hub within the notebook:

Each notebook loads an example dataset directly from the Hugging Face Hub, so you can get hands-on with Nimbus right away.


Datasets

We have released two main datasets on the Hugging Face Hub:

  1. Pan-Multiplex

  2. Pan-Multiplex Gold-Standard


What is Nimbus?

Nimbus is a deep learning model designed to make human-like, visual classifications of multiplexed imaging data by determining which protein markers each cell is positive or negative for. Unlike many existing workflows, Nimbus:

  • Uses the raw image pixels (rather than purely integrated intensity) to classify marker expression.
  • Generalizes across many tissue types, imaging platforms, and markers — without retraining.
  • Can be integrated into downstream clustering or phenotyping pipelines to improve accuracy.

For more details, please see our preprint.


Contact

If you have questions, find a bug, or need help:

  • Please use the issue tracker.
  • We welcome contributions or pull requests to improve Nimbus!

Citation

If you use Nimbus in your work, please cite:

@article{rum2024nimbus,
  title={Automated classification of cellular expression in multiplexed imaging data with Nimbus},
  author={Rumberger, J. Lorenz and Greenwald, Noah F. and Ranek, Jolene S. and Boonrat, Potchara and Walker, Cameron and Franzen, Jannik and Varra, Sricharan Reddy and Kong, Alex and Sowers, Cameron and Liu, Candace C. and Averbukh, Inna and Piyadasa, Hadeesha and Vanguri, Rami and Nederlof, Iris and Wang, Xuefei Julie and Van Valen, David and Kok, Marleen and Hollman, Travis J. and Kainmueller, Dagmar and Angelo, Michael},
  journal={bioRxiv},
  pages={2024--05},
  year={2024},
  publisher={Cold Spring Harbor Laboratory}
}