Metadata-Version: 2.1
Name: spVIPES
Version: 0.0.1
Summary: Shared-private Variational Inference with Product of Experts and Supervision
Project-URL: Documentation, https://spVIPES.readthedocs.io/
Project-URL: Source, https://github.com/nrclaudio/spVIPES
Project-URL: Home-page, https://github.com/nrclaudio/spVIPES
Author: Claudio Novella Rausell
Maintainer-email: Claudio Novella Rausell <c.novella_rausell@lumc.nl>
License: BSD 3-Clause License
        
        Copyright (c) 2023, Claudio Novella Rausell
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: anndata
Requires-Dist: pandas<2.0.0
Requires-Dist: scanpy>=1.9.1
Requires-Dist: scvi-tools==0.20.0
Requires-Dist: session-info
Requires-Dist: torch
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: twine>=4.0.2; extra == 'dev'
Provides-Extra: doc
Requires-Dist: docutils!=0.18.*,!=0.19.*,>=0.8; extra == 'doc'
Requires-Dist: ipykernel; extra == 'doc'
Requires-Dist: ipython; extra == 'doc'
Requires-Dist: myst-nb; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
Requires-Dist: sphinx-book-theme>=1.0.0; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx>=4; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex>=1.0.0; extra == 'doc'
Requires-Dist: sphinxext-opengraph; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# spVIPES

[![Tests][badge-tests]][link-tests]

<!-- [![Documentation][badge-docs]][link-docs] -->

[badge-tests]: https://img.shields.io/github/actions/workflow/status/nrclaudio/spVIPES/test.yaml?branch=main
[link-tests]: https://github.com/nrclaudio/spVIPES/actions/workflows/test.yml

<!-- [badge-docs]: https://img.shields.io/readthedocs/spVIPES -->

Shared-private Variational Inference with Product of Experts and Supervision

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

-   [API documentation][link-api].

## Installation

You need to have Python 3.9 or newer installed on your system.

### PyTorch installation

We strongly recommend using spVIPES with GPU acceleration. In Linux, check your NVIDIA drivers running:

```bash
nvidia-smi
```

You can then install a compatible PyTorch version from https://pytorch.org/get-started/previous-versions/. For example if your CUDA drivers are version 11.3, you should install PyTorch v1.12.1 with the following command:

```bash
pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 torchaudio==0.12.1 --extra-index-url https://download.pytorch.org/whl/cu113
```

Make sure your torch installation can see your CUDA device to take full advantage of GPU acceleration by running:

```python
import torch

torch.cuda.is_available()
```

This should return `True` if everything is installed correctly.

### spVIPES installation

To install spVIPES:

1. Install the latest release of `spVIPES` from `PyPI <https://pypi.org/project/spVIPES/>`\_:

```bash
pip install spVIPES
```

2. Install the latest development version:

```bash
pip install git+https://github.com/nrclaudio/spVIPES.git@main
```

## Contact

If you found a bug, please use the [issue tracker][issue-tracker].

## Citation

> t.b.a

[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/nrclaudio/spVIPES/issues
[changelog]: https://spVIPES.readthedocs.io/latest/changelog.html
[link-docs]: https://spVIPES.readthedocs.io
[link-api]: https://spVIPES.readthedocs.io/latest/api.html
