Skip to main content

A model for classification of cells into marker positive / negative

Project description

Nimbus Logo

CI Documentation Status 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.

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.


Release Notes

See our changelog for details of what has changed in recent releases.


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}
}

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

nimbus_inference-0.0.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

nimbus_inference-0.0.3-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

Details for the file nimbus_inference-0.0.3.tar.gz.

File metadata

  • Download URL: nimbus_inference-0.0.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.0

File hashes

Hashes for nimbus_inference-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f257b431efdce2337cf2d523d6f70168ed870ad2a42950ca05a701464c2d54de
MD5 b76dc0e6406362e012607c9873d66b85
BLAKE2b-256 1ec29296d68297538603020c768c576d13e62c7bc6593bf0c9874fcb01f12131

See more details on using hashes here.

File details

Details for the file nimbus_inference-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for nimbus_inference-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d0272ed2e55717492a909693b64643a54c3783aefbb9263482ecd8be7177da17
MD5 ce5b4af5d44ea15bba107bb39c943454
BLAKE2b-256 6e610c2e9c41a5e7877092d805dd554934028920a2a95932de3da7e53c58dbf1

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