Metadata-Version: 2.3
Name: torchgmm
Version: 0.1.1
Summary: Run Gaussian Mixture Models on single or multiple CPUs/GPUs
Project-URL: Documentation, https://torchgmm.readthedocs.io/
Project-URL: Source, https://github.com/CSOgroup/torchgmm
Project-URL: Home-page, https://github.com/CSOgroup/torchgmm
Author: Marco Varrone
Maintainer-email: Marco Varrone <marco.varrone@unil.ch>
License: MIT License
        
        Copyright (c) 2024, Marco Varrone
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: anndata
Requires-Dist: numpy<2.0.0,>=1.20.3
Requires-Dist: pytorch-lightning>=1.6.0
Requires-Dist: session-info
Requires-Dist: torch>1.11.0
Requires-Dist: torchmetrics>=0.6
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>=1.1.0; extra == 'doc'
Requires-Dist: pandas; extra == 'doc'
Requires-Dist: setuptools; 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: coverage; extra == 'test'
Requires-Dist: flaky; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-benchmark; extra == 'test'
Requires-Dist: scikit-learn; extra == 'test'
Description-Content-Type: text/markdown

# torchgmm

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

[badge-tests]: https://img.shields.io/github/actions/workflow/status/marcovarrone/torchgmm/test.yaml?branch=main
[link-tests]: https://github.com/CSOgroup/torchgmm/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/torchgmm

Run Gaussian Mixture Models on single or multiple CPUs/GPUs

## Getting started

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

-   [API documentation][link-api].

## Installation

You need to have Python 3.10 or newer installed on your system. If you don't have
Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).

There are several alternative options to install torchgmm:

<!--
1) Install the latest release of `torchgmm` from [PyPI][link-pypi]:

```bash
pip install torchgmm
```
-->

1. Install the latest development version:

```bash
pip install git+https://github.com/CSOgroup/torchgmm.git@main
```

## Release notes

See the [changelog][changelog].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].
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/marcovarrone/torchgmm/issues
[changelog]: https://torchgmm.readthedocs.io/latest/changelog.html
[link-docs]: https://torchgmm.readthedocs.io
[link-api]: https://torchgmm.readthedocs.io/latest/api.html
[link-pypi]: https://pypi.org/project/torchgmm
