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.9 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.1.tar.gz (431.5 kB view details)

Uploaded Source

Built Distribution

scib_metrics-0.5.1-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scib_metrics-0.5.1.tar.gz
  • Upload date:
  • Size: 431.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for scib_metrics-0.5.1.tar.gz
Algorithm Hash digest
SHA256 74d10251acf1c11402b994faf063e55317881d7950fb78f6cef011d232a1e266
MD5 e4f01fddb320435cbbe55a2ebc384c5a
BLAKE2b-256 2ffd1d6df8fb908dae10e4165d8144e63c17c4f2f7beb7cbe7fec0c62fb11310

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scib_metrics-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 36.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for scib_metrics-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 42d0a48f5722d0d36aefb65a70067bce3322b3643a65ae3be6a5274e4e7124e1
MD5 4ae557c6a04cffc7ad1acb00993347d9
BLAKE2b-256 fd50a9ed815be660207f7aba3ac4fd2ac1905c1fcb2543e882925b529940ee85

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page