Metadata-Version: 2.4
Name: scib-rapids
Version: 0.2.0
Summary: GPU-accelerated single-cell integration benchmarking metrics using RAPIDS (cuML, CuPy)
Project-URL: Documentation, https://scib-rapids.readthedocs.io/
Project-URL: Source, https://github.com/maarten-devries/scib-rapids
Project-URL: Home-page, https://github.com/maarten-devries/scib-rapids
Author: Maarten de Vries
Maintainer: Maarten de Vries
License: BSD 3-Clause License
        
        Copyright (c) 2026, Maarten de Vries
        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.11
Requires-Dist: anndata
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pynndescent
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: umap-learn>=0.5.0
Provides-Extra: cu12
Requires-Dist: cudf-cu12; extra == 'cu12'
Requires-Dist: cugraph-cu12; extra == 'cu12'
Requires-Dist: cupy-cuda12x[ctk]>=13.0; extra == 'cu12'
Provides-Extra: cu13
Requires-Dist: cudf-cu13; extra == 'cu13'
Requires-Dist: cugraph-cu13; extra == 'cu13'
Requires-Dist: cupy-cuda13x[ctk]>=13.0; extra == 'cu13'
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: twine>=4.0.2; extra == 'dev'
Provides-Extra: doc
Requires-Dist: ipykernel; extra == 'doc'
Requires-Dist: ipython; extra == 'doc'
Requires-Dist: myst-nb; extra == 'doc'
Requires-Dist: pybtex-docutils>=1.0.0; extra == 'doc'
Requires-Dist: scanpydoc[typehints]>=0.7.4; extra == 'doc'
Requires-Dist: sphinx-book-theme>=1.0; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx>=4; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex>=2.6; extra == 'doc'
Requires-Dist: sphinxext-opengraph; extra == 'doc'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: harmonypy; extra == 'test'
Requires-Dist: joblib; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: scib-metrics>=0.5; extra == 'test'
Description-Content-Type: text/markdown

# scib-rapids

[![PyPI][badge-pypi]][link-pypi]
[![Docs][badge-docs]][link-docs]
[![Build][badge-build]][link-build]
[![Coverage][badge-cov]][link-cov]
[![Discourse][badge-discourse]][link-discourse]
[![Chat][badge-zulip]][link-zulip]

[badge-pypi]: https://img.shields.io/pypi/v/scib-rapids.svg
[link-pypi]: https://pypi.org/project/scib-rapids
[badge-docs]: https://readthedocs.org/projects/scib-rapids/badge/?version=latest
[link-docs]: https://scib-rapids.readthedocs.io/en/latest/?badge=latest
[badge-build]: https://github.com/maarten-devries/scib-rapids/actions/workflows/test.yaml/badge.svg
[link-build]: https://github.com/maarten-devries/scib-rapids/actions/workflows/test.yaml/
[badge-cov]: https://codecov.io/gh/maarten-devries/scib-rapids/branch/main/graph/badge.svg
[link-cov]: https://codecov.io/gh/maarten-devries/scib-rapids
[badge-discourse]: https://img.shields.io/discourse/posts?color=yellow&logo=discourse&server=https%3A%2F%2Fdiscourse.scverse.org
[link-discourse]: https://discourse.scverse.org/
[badge-zulip]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[link-zulip]: https://scverse.zulipchat.com/

GPU-accelerated metrics for benchmarking single-cell integration outputs using RAPIDS (cuML, CuPy).

This package provides the same metrics as [scib-metrics](https://github.com/YosefLab/scib-metrics) but replaces JAX with [RAPIDS](https://rapids.ai/) (CuPy, cuML) for GPU acceleration. All implementations leverage CuPy for device-level computation on NVIDIA GPUs.

## Metrics

- **Silhouette**: `silhouette_label`, `silhouette_batch`, `bras`
- **LISI**: `lisi_knn`, `ilisi_knn`, `clisi_knn`
- **kBET**: `kbet`, `kbet_per_label`
- **Clustering**: `nmi_ari_cluster_labels_kmeans`, `nmi_ari_cluster_labels_leiden`
- **Graph connectivity**: `graph_connectivity`
- **Isolated labels**: `isolated_labels`
- **PCR comparison**: `pcr_comparison`

## Getting started

Please refer to the [documentation][link-docs].

## Installation

You need to have Python 3.11 or newer and a CUDA-capable GPU.

We recommend installing [rapids-singlecell](https://rapids-singlecell.readthedocs.io/en/latest/Installation.html) and `scib-rapids` using `uv pip` rather than conda, as conda often causes dependency conflicts (e.g. `cupy` vs `cupy-cuda12x`).

```bash
uv pip install rapids-singlecell scib-rapids
```

Alternatively, install the latest development version:

```bash
uv pip install rapids-singlecell git+https://github.com/maarten-devries/scib-rapids.git@main
```

## Release notes

See the [changelog][changelog].

## Contact

For questions and help requests, you can reach out in the [scverse Discourse][link-discourse].
If you found a bug, please use the [issue tracker][issue-tracker].

## Citation

If you use `scib-rapids`, please cite the original single-cell integration benchmarking work:

```bibtex
@article{luecken2022benchmarking,
  title={Benchmarking atlas-level data integration in single-cell genomics},
  author={Luecken, Malte D and B{\"u}ttner, Maren and Chaichoompu, Kridsadakorn and Danese, Anna and Interlandi, Marta and M{\"u}ller, Michaela F and Strobl, Daniel C and Zappia, Luke and Dugas, Martin and Colom{\'e}-Tatch{\'e}, Maria and others},
  journal={Nature methods},
  volume={19},
  number={1},
  pages={41--50},
  year={2022},
  publisher={Nature Publishing Group}
}
```

[issue-tracker]: https://github.com/maarten-devries/scib-rapids/issues
[changelog]: https://scib-rapids.readthedocs.io/en/latest/changelog.html
