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

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.4.3.tar.gz (92.1 kB view details)

Uploaded Source

Built Distribution

mellon-1.4.3-py3-none-any.whl (96.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mellon-1.4.3.tar.gz
  • Upload date:
  • Size: 92.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for mellon-1.4.3.tar.gz
Algorithm Hash digest
SHA256 388815906245ed47041442f482ae0a77699949d40d69fb50bd1197dcef9b8e8b
MD5 ae0b6b1a519e8e097df06c05028ced78
BLAKE2b-256 b5872b0a0436321e189552095439c6f6a08beb2ebbcea2103f2f5b13926fd6df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mellon-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 96.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for mellon-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 91607e39d6e8b6804722c96924a28f74cc1403ed14dd9f1bd49d17ec49df0353
MD5 9fe3639aa8b80b491e339f0122c6d3e4
BLAKE2b-256 b5baff60f299d2c0977c1683a3dc4a8b3150d9b5293fa444c8ba4ee714bd9efe

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