Skip to main content

Accelerated and Python-only scIB metrics

Project description

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.10 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.

Project details


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.5.10.tar.gz (436.0 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.5.10-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.10.tar.gz
Algorithm Hash digest
SHA256 be71c04a1f110e2b7112614d67b429915c075c165070550ae0d49c9462fbca58
MD5 6f8765ea3c5049249c348acb543e1d78
BLAKE2b-256 3b9eb18dd713cff58bfe0b118fee1bbf34ba448b17134fec9b428faf92a094cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for scib_metrics-0.5.10.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.5.10-py3-none-any.whl.

File metadata

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

File hashes

Hashes for scib_metrics-0.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 548639c6f43a8811a10b3cd60aa18ed4d382a13ef68945911e95a4dc063bdf9c
MD5 727c3c8e6644c76eccd2613a0b9d60cd
BLAKE2b-256 fd66268cc406d352be0286364bcbb38b9e3c1adbcdea41b37e9e181eb2e4bf32

See more details on using hashes here.

Provenance

The following attestation bundles were made for scib_metrics-0.5.10-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 Pingdom Monitoring Sentry Error logging StatusPage Status page