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

References for individual metrics can be found in the corresponding documentation. This package is heavily inspired by the 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}
}

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.7.tar.gz
Algorithm Hash digest
SHA256 a42556e492718d2bdbdeb05fb19e3940be6e240693a16850d56f43c1e6c3049a
MD5 ac463a4afd81afc2ec464296e801dfbd
BLAKE2b-256 d7623858f7c0ba3c9ea498c1fb5445a1ac4a142555b2abcfa6ad8012c897790e

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1bc8c65da8a61e79fea41c5eb3fee34d0ca4fff5e84e883cf001e28d4fbc2067
MD5 d8d09aeef6ca3db2f890ce12527eb9d3
BLAKE2b-256 cc4666f1e39e7d156ab0ccdb6beb93d213582109175c9ae876952682fd705b78

See more details on using hashes here.

Provenance

The following attestation bundles were made for scib_metrics-0.5.7-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.

Release history Release notifications | RSS feed

0.6.1

2 files

0.6.0

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

This release

0.5.7 This release

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page