Skip to main content

scib-metrics

Stars PyPI PyPIDownloads Docs Build Coverage Discourse Chat

Accelerated and Python-only metrics for benchmarking single-cell integration outputs.

This package contains implementations of metrics for evaluating the performance of single-cell omics data integration methods. The implementations of these metrics use JAX when possible for jit-compilation and hardware acceleration. All implementations are in Python.

Currently we are porting metrics used in the scIB manuscript (and code). Deviations from the original implementations are documented. However, metric values from this repository should not be compared to the scIB repository.

Getting started

Please refer to the documentation.

Installation

You need to have Python 3.12 or newer installed on your system. If you don't have Python installed, we recommend installing Miniconda.

There are several options to install scib-metrics:

  1. Install the latest release on PyPI:
pip install scib-metrics
  1. Install the latest development version:
pip install git+https://github.com/yoseflab/scib-metrics.git@main

To leverage hardware acceleration (e.g., GPU) please install the apprpriate version of JAX separately. Often this can be easier by using conda-distributed versions of JAX.

Release notes

See the changelog.

Contact

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

Citation

Please cite:

Adam Gayoso, Martin Kim, Ori Kronfeld, Justin Hong, & Yosef, N. (2026). YosefLab/scib-metrics: scib-metrics 0.5.8 (v0.5.8). Zenodo. https://doi.org/10.5281/zenodo.18504367

In addition, please cite the original single-cell integration benchmarking work:

@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}
}

References for individual metrics can be also found in the corresponding documentation.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scib_metrics-0.6.0.tar.gz (443.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scib_metrics-0.6.0-py3-none-any.whl (42.0 kB view details)

Uploaded Python 3

File details

Details for the file scib_metrics-0.6.0.tar.gz.

File metadata

  • Download URL: scib_metrics-0.6.0.tar.gz
  • Upload date:
  • Size: 443.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for scib_metrics-0.6.0.tar.gz
Algorithm Hash digest
SHA256 a605094eb366f06e74da4d3065c5a4731c01c7a7daa5da16caae5aaf76b67995
MD5 ea1dcd55028b76e182a644fcda87d453
BLAKE2b-256 a1bdc9e248fc6a68a0d83913c8d990e3e1e0594b2db8034062baea880524961c

See more details on using hashes here.

Provenance

The following attestation bundles were made for scib_metrics-0.6.0.tar.gz:

Publisher: release.yaml on YosefLab/scib-metrics

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scib_metrics-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: scib_metrics-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 42.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for scib_metrics-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ae481215b588069e7d351bc7ca4a6cb32df147484d750c050dc17747e79f332
MD5 e2b5b26e18bdb75f90972719d0e47abf
BLAKE2b-256 ed0f65ea2d88bd33786486841b735c094cf10676cffeb926d1cbf00fcf7dc5c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for scib_metrics-0.6.0-py3-none-any.whl:

Publisher: release.yaml on YosefLab/scib-metrics

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page