Skip to main content

Non-parametric density estimator.

Project description

Mellon

zenodo codecov pypi conda

https://github.com/settylab/mellon/raw/main/landscape.png?raw=true

Mellon is a non-parametric cell-state density estimator based on a nearest-neighbors-distance distribution. It uses a sparse gaussian process to produce a differntiable density function that can be evaluated out of sample.

Installation

To install Mellon using pip you can run:

pip install mellon

or to install using conda you can run:

conda install -c conda-forge mellon

or to install using mamba you can run:

mamba install -c conda-forge mellon

Any of these calls should install Mellon and its dependencies within less than 1 minute. If the dependency jax is not autimatically installed, please refer to https://github.com/google/jax.

Documentation

Please read the documentation or use this basic tutorial notebook.

Basic Usage

import mellon
import numpy as np

X = np.random.rand(100, 10)  # 10-dimensional state representation for 100 cells
Y = np.random.rand(100, 10)  # arbitrary test data

model = mellon.DensityEstimator()
log_density_x = model.fit_predict(X)
log_density_y = model.predict(Y)

Citations

The Mellon manuscript is available on Nature Methods and a preprint on bioRxiv. If you use Mellon for your work, please cite our paper.

@article{ottoQuantifyingCellstateDensities2024,
  title = {Quantifying Cell-State Densities in Single-Cell Phenotypic Landscapes Using {{Mellon}}},
  author = {Otto, Dominik J. and Jordan, Cailin and Dury, Brennan and Dien, Christine and Setty, Manu},
  date = {2024-06-18},
  journaltitle = {Nature Methods},
  issn = {1548-7105},
  doi = {10.1038/s41592-024-02302-w},
  url = {https://www.nature.com/articles/s41592-024-02302-w},
}

You can find our reproducibility repository to reproduce benchmarks and plots of the paper here.

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

mellon-1.7.1.tar.gz (140.0 kB view details)

Uploaded Source

Built Distribution

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

mellon-1.7.1-py3-none-any.whl (101.9 kB view details)

Uploaded Python 3

File details

Details for the file mellon-1.7.1.tar.gz.

File metadata

  • Download URL: mellon-1.7.1.tar.gz
  • Upload date:
  • Size: 140.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for mellon-1.7.1.tar.gz
Algorithm Hash digest
SHA256 12f6f29478f7b98b1b427a4484aca627df4017a47d2c25bda85005aae5434d32
MD5 3b5ee649e3608b6e8d1a7032aa34985a
BLAKE2b-256 29560208c1281124f8f700ef5a843a84d963a702b262c299a113e0bb332ff734

See more details on using hashes here.

File details

Details for the file mellon-1.7.1-py3-none-any.whl.

File metadata

  • Download URL: mellon-1.7.1-py3-none-any.whl
  • Upload date:
  • Size: 101.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for mellon-1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8120cd8a8b71519bdcc0105d8778c9314afeb6aa8934cfd23fde1f1432581bf
MD5 c02d9cd4786b7189f3731aeea80d7644
BLAKE2b-256 4c0b75c3e700b7741a127be32985dbdd9522e4b9953ed3e77440dca8c2381dab

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