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

Uploaded Source

Built Distribution

scib_metrics-0.5.5-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scib_metrics-0.5.5.tar.gz
  • Upload date:
  • Size: 435.2 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.5.tar.gz
Algorithm Hash digest
SHA256 e8dda7ad284349433e400551926ee116c6029060509fe7024b2c69b999494da5
MD5 4d230525ebc254445832186ea68af214
BLAKE2b-256 7b946abceec5c570ce4e4c52d066902e13f64b42caa16e3aa0bbdc7e119dc9d2

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: scib_metrics-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 38.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 04d11dae86d77b41a87960e831db1338d7f6a1acf008bdeeb0c253f087997e57
MD5 f6f40121ba5c82679fe2c4d2928fc5a1
BLAKE2b-256 6f4182ff4543795e04a14a032d2f1ed81149032846003ba9df7c8ecd47d0d6c0

See more details on using hashes here.

Provenance

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