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

Project links

Data verified by PyPI on Feb 12, 2025
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.6.0)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for adamgayoso from gravatar.com adamgayoso Avatar for jjhong922 from gravatar.com jjhong922 Avatar for orikr from gravatar.com orikr

Credits

Author: Adam Gayoso

Maintainer: Adam Gayoso

GitHub Statistics

Data verified by PyPI on Feb 12, 2025
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD 3-Clause License

Requires

Python >=3.10

Provides Extra

dev doc parallel test tutorial

Report project as malware

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.2.tar.gz
Algorithm Hash digest
SHA256 62e83f468bf79355d951e46021c85c04e82333aab0fa25007cac547a58ea4fbb
MD5 3b394e193cffd388527e51dc91f1819e
BLAKE2b-256 b834ea9d8b057ac1499b9b9c374457ed3a5e9869fc1dc9d03ee20c02690dfab4

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e633e554c0afd7bbd731c453d71600f1fc7e2528564d01b89c186315ce73e2e0
MD5 deb8b7e2e9491c9ecc87fcaa6c6b66bc
BLAKE2b-256 9d8b2e41ca9e9337687f9e37496dcbc6e3ccd76e229cca68b11f9a0013e6850b

See more details on using hashes here.

Provenance

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

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

This release

0.5.2 This release

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