Skip to main content

An automatic deep learning algorithm for spot detection in fluorescence microscopy images.

Project description

Piscis

Piscis

piscis is an automatic deep learning algorithm for spot detection, written in Python using the JAX and Flax libraries. It is named after the Latin word for fish, as it was designed specifically for microscopy images generated by RNA fluorescence in situ hybridization (FISH). However, we have found it to be useful for other imaging methods, such as immunofluorescence (IF) and FISH-based spatial transcriptomics. To learn more about piscis, please read our preprint.

This Python package allows users to apply pre-trained models from Hugging Face to both single plane images and z-stacks or to train new models using custom datasets. It provides a simple API for both training and inference that can be used in traditional Python scripts or Jupyter notebook environments such as on Google Colab. It also provides a command line interface for those who prefer the terminal. For a user-friendly graphical user interface, we have implemented piscis as a Docker image for NimbusImage, a cloud platform for biological image analysis enabling researchers to interactively visualize their data while leveraging state-of-the-art machine learning algorithms.

Examples

Examples

Installation

Install piscis from PyPI with pip.

pip install piscis

By default, this will install the CPU version of JAX. If you would like to run or train piscis on a GPU or TPU, follow JAX's instructions.

Usage

If you want to use piscis with its Python API, check out the inference example and training example notebooks.

If you want to use piscis with its command line interface, run the following commands.

# Run Piscis.
piscis predict INPUT_PATH OUTPUT_PATH [OPTIONS]

# Train Piscis.
piscis train MODEL_NAME DATASET_PATH [OPTIONS]

To see the full list of options, run piscis predict --help or piscis train --help.

Citation

If you use piscis in your research, please cite our preprint.

Niu, Z., O’Farrell, A., Li, J., Reffsin, S., Jain, N., Dardani, I., Goyal, Y., & Raj, A. (2024). Piscis: A novel loss estimator of the F1 score enables accurate spot detection in fluorescence microscopy images via deep learning. bioRxiv. https://doi.org/10.1101/2024.01.31.578123

@article{Niu2024-Piscis,
    title={Piscis: A novel loss estimator of the F1 score enables accurate spot detection in fluorescence microscopy images via deep learning},
    author={Niu, Zijian and O’Farrell, Aoife and Li, Jingxin and Reffsin, Sam and Jain, Naveen and Dardani, Ian and Goyal, Yogesh and Raj, Arjun},
    year=2024,
    journal="bioRxiv",
    DOI={10.1101/2024.01.31.578123}
}

License

piscis is licensed under the MIT License. The copyright and permission notices found in the LICENSE file shall be included in all copies or substantial portions of the Software.

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

piscis-0.2.4.tar.gz (36.9 kB view details)

Uploaded Source

Built Distribution

Piscis-0.2.4-py3-none-any.whl (43.6 kB view details)

Uploaded Python 3

File details

Details for the file piscis-0.2.4.tar.gz.

File metadata

  • Download URL: piscis-0.2.4.tar.gz
  • Upload date:
  • Size: 36.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for piscis-0.2.4.tar.gz
Algorithm Hash digest
SHA256 d3f962fa6795d19cc8061edee12a99959d9e20694e731bd42cda780830b35f20
MD5 c4fabdd9c13baa4b951716c76f743ccd
BLAKE2b-256 462f1784ae02950fcad6d6f0e7f83f23e20562f40f5e4a2b22dcea6c295afd24

See more details on using hashes here.

File details

Details for the file Piscis-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: Piscis-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 43.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for Piscis-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7eecb4241f88add7c473b185cffdc858a50311d24f80f9255dd522189aed995f
MD5 127d9c8039deca64afffad392cd2e252
BLAKE2b-256 f7dab64f7c59077558bd1499155d2a4db0090459aa7ffd2ec1d7af7f48ef0bc4

See more details on using hashes here.

Supported by

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