Metadata-Version: 2.1
Name: scvi
Version: 0.5.0
Summary: Single-cell Variational Inference
Home-page: https://github.com/YosefLab/scVI
Author: Romain Lopez, Jeffrey Regier, Maxime Langevin, Edouard Mehlman, Yining Liu, Achille Nazaret, Gabriel Misrachi, Oscar Clivio, Pierre Boyeau, Adam Gayoso
Author-email: romain_lopez@berkeley.edu
License: MIT license
Keywords: scvi
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: numpy (>=1.16.2)
Requires-Dist: torch (>=1.0.1)
Requires-Dist: matplotlib (>=3.0.3)
Requires-Dist: scikit-learn (>=0.20.3)
Requires-Dist: h5py (>=2.9.0)
Requires-Dist: pandas (>=0.24.2)
Requires-Dist: loompy (>=2.0.16)
Requires-Dist: tqdm (>=4.31.1)
Requires-Dist: xlrd (>=1.2.0)
Requires-Dist: nbconvert (>=5.4.0)
Requires-Dist: nbformat (>=4.4.0)
Requires-Dist: jupyter (>=1.0.0)
Requires-Dist: ipython (>=7.1.1)
Requires-Dist: numba (==0.45.0)
Requires-Dist: hyperopt (==0.1.2)
Provides-Extra: docs
Requires-Dist: sphinx (>=1.7.1) ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: notebooks
Requires-Dist: scanpy (>=1.4) ; extra == 'notebooks'
Requires-Dist: louvain (>=0.6.1) ; extra == 'notebooks'
Requires-Dist: leidenalg (>=0.7.0) ; extra == 'notebooks'
Requires-Dist: python-igraph (>=0.7.1.post6) ; extra == 'notebooks'
Requires-Dist: colour (>=0.1.5) ; extra == 'notebooks'
Requires-Dist: umap-learn (>=0.3.8) ; extra == 'notebooks'
Requires-Dist: seaborn (>=0.9.0) ; extra == 'notebooks'
Provides-Extra: test
Requires-Dist: pytest (>=3.7.4) ; extra == 'test'
Requires-Dist: pytest-runner (>=2.11.1) ; extra == 'test'
Requires-Dist: flake8 (>=3.7.7) ; extra == 'test'
Requires-Dist: coverage (>=4.5.1) ; extra == 'test'
Requires-Dist: codecov (>=2.0.8) ; extra == 'test'
Requires-Dist: black (>=19.3b0) ; extra == 'test'

====
scVI
====

|PyPI| |bioconda| |Docs| |Build Status| |Coverage| |Code Style| |Downloads|

.. |PyPI| image:: https://img.shields.io/pypi/v/scVI.svg
    :target: https://pypi.org/project/scvi
.. |bioconda| image:: https://img.shields.io/badge/bioconda-blue.svg
    :target: http://bioconda.github.io/recipes/scvi/README.html
.. |Docs| image:: https://readthedocs.org/projects/scvi/badge/?version=latest
    :target: https://scvi.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. |Build Status| image:: https://travis-ci.org/YosefLab/scVI.svg?branch=master
    :target: https://travis-ci.org/YosefLab/scVI
.. |Coverage| image:: https://codecov.io/gh/YosefLab/scVI/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/YosefLab/scVI
.. |Code Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/python/black
.. |Downloads| image:: https://pepy.tech/badge/scvi
   :target: https://pepy.tech/project/scvi

Single-cell Variational Inference

* Free software: MIT license
* Documentation: https://scvi.readthedocs.io.


Quick Start
-----------

1. Install Python 3.7. We typically use the Miniconda_ Python distribution and Linux.

.. _Miniconda: https://conda.io/miniconda.html

2. Install PyTorch_. If you have an Nvidia GPU, be sure to install a version of PyTorch that supports it -- scVI runs much faster with a discrete GPU.

.. _PyTorch: http://pytorch.org

3. Install scVI through conda:

    ``conda install scvi -c bioconda -c conda-forge``

   Alternatively, you may try pip (``pip install scvi``), or you may clone this repository and run ``python setup.py install``.

4. If you wish to use multiple GPUs for hyperparameter tuning, install MongoDb_.

.. _MongoDb: https://docs.mongodb.com/manual/installation/

5. Follow along with our Jupyter notebooks to quickly get familiar with scVI!

   a. Getting started:
       * `data loading`__
       * `basic usage (scVI)`__
   b. Analyzing several datasets:
       * `harmonization (scVI)`__
       * `annotation (scANVI)`__
   c. Advanced topics:
       * `interaction with scanpy`__
       * `linear decoder for gene interpretation (LDVAE)`__
       * `imputation of unobserved gene expression (gimVI)`__
       * `automated hyperparameter search`__
       * `joint model for CITE-seq data (totalVI)`__
       * `detection of zero-inflated genes (AutoZI)`__


.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/data_loading.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/basic_tutorial.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/harmonization.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/annotation.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/scanpy_pbmc3k.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/linear_decoder.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/gimvi_tutorial.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/autotune_advanced_notebook.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/totalVI.ipynb
.. __: https://nbviewer.jupyter.org/github/YosefLab/scVI/blob/master/tests/notebooks/AutoZI_tutorial.ipynb


References
----------

Romain Lopez, Jeffrey Regier, Michael Cole, Michael I. Jordan, Nir Yosef.
**"Deep generative modeling for single-cell transcriptomics."**
Nature Methods, 2018. `[pdf]`__

.. __: https://rdcu.be/bdHYQ

Chenling Xu∗, Romain Lopez∗, Edouard Mehlman∗, Jeffrey Regier, Michael I. Jordan, Nir Yosef.
**"Harmonization and Annotation of Single-cell Transcriptomics data with Deep Generative Models."**
Submitted, 2019. `[pdf]`__

.. __: https://www.biorxiv.org/content/biorxiv/early/2019/01/29/532895.full.pdf

Romain Lopez∗, Achille Nazaret∗, Maxime Langevin*, Jules Samaran*, Jeffrey Regier*, Michael I. Jordan, Nir Yosef.
**"A joint model of unpaired data from scRNA-seq and spatial transcriptomics for imputing missing gene expression measurements."**
ICML Workshop on Computational Biology, 2019. `[pdf]`__

.. __: https://arxiv.org/pdf/1905.02269.pdf

Adam Gayoso, Romain Lopez, Zoë Steier, Jeffrey Regier, Aaron Streets, Nir Yosef.
**"A joint model of RNA expression and surface protein abundance in single cells."**
bioRxiv, 2019. `[pdf]`__

.. __: https://www.biorxiv.org/content/biorxiv/early/2019/10/07/791947.full.pdf

Oscar Clivio, Romain Lopez, Jeffrey Regier, Adam Gayoso, Michael I. Jordan, Nir Yosef.
**"Detecting zero-inflated genes in single-cell transcriptomics data."**
bioRxiv, 2019. `[pdf]`__

.. __: https://www.biorxiv.org/content/biorxiv/early/2019/10/10/794875.full.pdf

Pierre Boyeau, Romain Lopez, Jeffrey Regier, Adam Gayoso, Michael I. Jordan, Nir Yosef.
**"Deep generative models for detecting differential expression in single cells."**
bioRxiv, 2019. `[pdf]`__

.. __: https://www.biorxiv.org/content/biorxiv/early/2019/10/04/794289.full.pdf


=======
History
=======

0.1.0 (2018-06-12)
------------------

* First release on PyPI.

0.5.0 (2019-10-17)
------------------
Unfortunately we did not save history for previous versions. New features include:

* AutoZI & TotalVI
* Tests for LDVAE notebook
* Add how to load CITE-SEQ data on dataloading notebook
* Made the intro tutorial more user friendly
* Removed requirements.txt and rely only on setup.py




