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.0.tar.gz (139.2 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.0-py3-none-any.whl (101.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mellon-1.7.0.tar.gz
  • Upload date:
  • Size: 139.2 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.0.tar.gz
Algorithm Hash digest
SHA256 194a4d67b02ca3f34b13563fc1ff1e18c6e85deed3dec28661f715a49f58704f
MD5 c411916976de60e164176b89fcaf12e4
BLAKE2b-256 df45d4ab0c2cd549ed37ddb0c9b8268be80ffb90ec513050820530ebe12e490a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mellon-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 101.5 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c20e33877ae362a772d8f77891d48ab2e30afd52da5e76cd5f199978067a99b1
MD5 afd61e5c45af533abd39215341f4e9ec
BLAKE2b-256 4629a138be06afa029ee6a2c7d1365cf4b678294d571a0a2a385a41ddd5456ed

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