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

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 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.6.tar.gz (435.4 kB view details)

Uploaded Source

Built Distribution

scib_metrics-0.5.6-py3-none-any.whl (39.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.6.tar.gz
Algorithm Hash digest
SHA256 83c28e737312110ed7d24119ced0231673602590ce76fc3f5caea7c0f17e5de2
MD5 cb79d7e23ee188644710a1f9c416d7f5
BLAKE2b-256 eecafa53e3135491d98aff4eb95dec8321023da5c3fb860eceda55de09d093c9

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for scib_metrics-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4cd0fe7976187a2f9c4e580d41176bd12de4f0a8d795f20c5dc732ca0fd83a95
MD5 5572301d4e404f83695ab5d3681c4025
BLAKE2b-256 5879e8f8d3207975ab130deb595575b699f1bda1c94774e2024687bfbecc1a14

See more details on using hashes here.

Provenance

The following attestation bundles were made for scib_metrics-0.5.6-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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page