Mellon
======
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8404223.svg
:target: https://doi.org/10.5281/zenodo.8404223
.. image:: https://codecov.io/github/settylab/Mellon/branch/main/graph/badge.svg?token=TKIKXK4MPG
:target: https://app.codecov.io/github/settylab/Mellon
.. image:: https://badge.fury.io/py/mellon.svg
:target: https://badge.fury.io/py/mellon
.. image:: https://anaconda.org/conda-forge/mellon/badges/version.svg
:target: https://anaconda.org/conda-forge/mellon
.. image:: https://static.pepy.tech/personalized-badge/mellon?period=total&units=international_system&left_color=grey&right_color=lightgrey&left_text=Downloads
:target: https://pepy.tech/project/mellon
.. image:: https://github.com/settylab/mellon/raw/main/landscape.png?raw=true
:target: https://github.com/settylab/Mellon
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:
.. code-block:: bash
pip install mellon
or to install using **conda** you can run:
.. code-block:: bash
conda install -c conda-forge mellon
or to install using **mamba** you can run:
.. code-block:: bash
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 <https://mellon.readthedocs.io/en/latest/index.html>`_
or use this
`basic tutorial notebook <https://github.com/settylab/Mellon/blob/main/notebooks/basic_tutorial.ipynb>`_.
Basic Usage
===========
.. code-block:: python
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 <https://www.biorxiv.org/content/10.1101/2023.07.09.548272v1>`_
If you use Mellon for your work, please cite our paper.
.. code-block:: bibtex
@article {Otto2023.07.09.548272,
author = {Dominik Jenz Otto and Cailin Jordan and Brennan Dury and Christine Dien and Manu Setty},
title = {Quantifying Cell-State Densities in Single-Cell Phenotypic Landscapes using Mellon},
elocation-id = {2023.07.09.548272},
year = {2023},
doi = {10.1101/2023.07.09.548272},
publisher = {Cold Spring Harbor Laboratory},
URL = {https://www.biorxiv.org/content/early/2023/07/10/2023.07.09.548272},
eprint = {https://www.biorxiv.org/content/early/2023/07/10/2023.07.09.548272.full.pdf},
journal = {bioRxiv}
}
Raw data
{
"_id": null,
"home_page": "https://github.com/settylab/mellon",
"name": "mellon",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Setty Lab",
"author_email": "dominik.otto@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/70/efb25bf1006d864263da68ac0aab5c281c5395c62cb0ed4a359a92bf760c/mellon-1.4.2.tar.gz",
"platform": null,
"description": "Mellon\n======\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8404223.svg\n :target: https://doi.org/10.5281/zenodo.8404223\n.. image:: https://codecov.io/github/settylab/Mellon/branch/main/graph/badge.svg?token=TKIKXK4MPG \n :target: https://app.codecov.io/github/settylab/Mellon\n.. image:: https://badge.fury.io/py/mellon.svg\n :target: https://badge.fury.io/py/mellon\n.. image:: https://anaconda.org/conda-forge/mellon/badges/version.svg\n :target: https://anaconda.org/conda-forge/mellon\n.. image:: https://static.pepy.tech/personalized-badge/mellon?period=total&units=international_system&left_color=grey&right_color=lightgrey&left_text=Downloads\n :target: https://pepy.tech/project/mellon\n\n.. image:: https://github.com/settylab/mellon/raw/main/landscape.png?raw=true\n :target: https://github.com/settylab/Mellon\n\nMellon is a non-parametric cell-state density estimator based on a\nnearest-neighbors-distance distribution. It uses a sparse gaussian process\nto produce a differntiable density function that can be evaluated out of sample.\n\nInstallation\n============\n\nTo install Mellon using **pip** you can run:\n\n.. code-block:: bash\n\n pip install mellon\n\nor to install using **conda** you can run:\n\n.. code-block:: bash\n\n conda install -c conda-forge mellon\n\nor to install using **mamba** you can run:\n\n.. code-block:: bash\n\n mamba install -c conda-forge mellon\n\nAny of these calls should install Mellon and its dependencies within less than 1 minute.\nIf the dependency jax is not autimatically installed, please refer to https://github.com/google/jax.\n\nDocumentation\n=============\n\nPlease read the\n`documentation <https://mellon.readthedocs.io/en/latest/index.html>`_\nor use this\n`basic tutorial notebook <https://github.com/settylab/Mellon/blob/main/notebooks/basic_tutorial.ipynb>`_.\n\n\nBasic Usage\n===========\n\n.. code-block:: python\n\n import mellon\n import numpy as np\n\n X = np.random.rand(100, 10) # 10-dimensional state representation for 100 cells\n Y = np.random.rand(100, 10) # arbitrary test data\n\n model = mellon.DensityEstimator()\n log_density_x = model.fit_predict(X)\n log_density_y = model.predict(Y)\n\nCitations\n=========\n\nThe Mellon manuscript is available on\n`bioRxiv <https://www.biorxiv.org/content/10.1101/2023.07.09.548272v1>`_\nIf you use Mellon for your work, please cite our paper.\n\n.. code-block:: bibtex\n\n @article {Otto2023.07.09.548272,\n author = {Dominik Jenz Otto and Cailin Jordan and Brennan Dury and Christine Dien and Manu Setty},\n title = {Quantifying Cell-State Densities in Single-Cell Phenotypic Landscapes using Mellon},\n elocation-id = {2023.07.09.548272},\n year = {2023},\n doi = {10.1101/2023.07.09.548272},\n publisher = {Cold Spring Harbor Laboratory},\n URL = {https://www.biorxiv.org/content/early/2023/07/10/2023.07.09.548272},\n eprint = {https://www.biorxiv.org/content/early/2023/07/10/2023.07.09.548272.full.pdf},\n journal = {bioRxiv}\n }\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Non-parametric density estimator.",
"version": "1.4.2",
"project_urls": {
"Homepage": "https://github.com/settylab/mellon"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03479b37f72b0b00c2b1cf8563813c01a11c9aaabf322d04e5909d8525930d5a",
"md5": "807a89c7bce0c74375d46ff033ebf60a",
"sha256": "9eaf306530939cd4d8ed130ce7d63226cfbda1d231e41a8b70750d205c63b3b9"
},
"downloads": -1,
"filename": "mellon-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "807a89c7bce0c74375d46ff033ebf60a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 94958,
"upload_time": "2024-02-28T23:04:32",
"upload_time_iso_8601": "2024-02-28T23:04:32.216842Z",
"url": "https://files.pythonhosted.org/packages/03/47/9b37f72b0b00c2b1cf8563813c01a11c9aaabf322d04e5909d8525930d5a/mellon-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b470efb25bf1006d864263da68ac0aab5c281c5395c62cb0ed4a359a92bf760c",
"md5": "3a8ee8bc44e4074ff4c39727f0e0aa75",
"sha256": "ce13bcc7f602059d446c9f11203847f5dab7c1d7cee24f3ad019ea8ad08c5bd9"
},
"downloads": -1,
"filename": "mellon-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "3a8ee8bc44e4074ff4c39727f0e0aa75",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 91365,
"upload_time": "2024-02-28T23:04:34",
"upload_time_iso_8601": "2024-02-28T23:04:34.476526Z",
"url": "https://files.pythonhosted.org/packages/b4/70/efb25bf1006d864263da68ac0aab5c281c5395c62cb0ed4a359a92bf760c/mellon-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 23:04:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "settylab",
"github_project": "mellon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mellon"
}
JSON
