Skip to content

Commit 1072248

Browse files
authored
[docs] update readme badges and typos (#145)
1 parent 5e6f50c commit 1072248

File tree

1 file changed

+32
-22
lines changed

1 file changed

+32
-22
lines changed

README.md

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,34 @@
11
# scib-metrics
22

3-
[![Tests][badge-tests]][link-tests]
4-
[![Documentation][badge-docs]][link-docs]
5-
6-
[badge-tests]: https://img.shields.io/github/actions/workflow/status/yoseflab/scib-metrics/test.yaml?branch=main
7-
[link-tests]: https://github.com/yoseflab/scib-metrics/actions/workflows/test.yml
8-
[badge-docs]: https://img.shields.io/readthedocs/scib-metrics
3+
[![Stars][badge-stars]][link-stars]
4+
[![PyPI][badge-pypi]][link-pypi]
5+
[![PyPIDownloads][badge-downloads]][link-downloads]
6+
[![Docs][badge-docs]][link-docs]
7+
[![Build][badge-build]][link-build]
8+
[![Coverage][badge-cov]][link-cov]
9+
[![Discourse][badge-discourse]][link-discourse]
10+
[![Chat][badge-zulip]][link-zulip]
11+
12+
[badge-stars]: https://img.shields.io/github/stars/YosefLab/scib-metrics?logo=GitHub&color=yellow
13+
[link-stars]: https://github.com/YosefLab/scib-metrics/stargazers
14+
[badge-pypi]: https://img.shields.io/pypi/v/scib-metrics.svg
15+
[link-pypi]: https://pypi.org/project/scib-metrics
16+
[badge-downloads]: https://static.pepy.tech/badge/scib-metrics
17+
[link-downloads]: https://pepy.tech/project/scib-metrics
18+
[badge-docs]: https://readthedocs.org/projects/scib-metrics/badge/?version=latest
19+
[link-docs]: https://scib-metrics.readthedocs.io/en/latest/?badge=latest
20+
[badge-build]: https://github.com/YosefLab/scib-metrics/actions/workflows/build.yaml/badge.svg
21+
[link-build]: https://github.com/YosefLab/scib-metrics/actions/workflows/build.yaml/
22+
[badge-cov]: https://codecov.io/gh/YosefLab/scib-metrics/branch/main/graph/badge.svg
23+
[link-cov]: https://codecov.io/gh/YosefLab/scib-metrics
24+
[badge-discourse]: https://img.shields.io/discourse/posts?color=yellow&logo=discourse&server=https%3A%2F%2Fdiscourse.scverse.org
25+
[link-discourse]: https://discourse.scverse.org/
26+
[badge-zulip]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
27+
[link-zulip]: https://scverse.zulipchat.com/
928

1029
Accelerated and Python-only metrics for benchmarking single-cell integration outputs.
1130

12-
This package contains implementations of metrics for evaluating the performance of single-cell omics data integration methods. The implementations of these metrics use [jax](https://jax.readthedocs.io/en/latest/) when possible for jit-compilation and hardware acceleration. All implementations are in Python.
31+
This package contains implementations of metrics for evaluating the performance of single-cell omics data integration methods. The implementations of these metrics use [JAX](https://jax.readthedocs.io/en/latest/) when possible for jit-compilation and hardware acceleration. All implementations are in Python.
1332

1433
Currently we are porting metrics used in the scIB [manuscript](https://www.nature.com/articles/s41592-021-01336-8) (and [code](https://github.com/theislab/scib)). Deviations from the original implementations are documented. However, metric values from this repository should not be compared to the scIB repository.
1534

@@ -22,15 +41,7 @@ Please refer to the [documentation][link-docs].
2241
You need to have Python 3.9 or newer installed on your system. If you don't have
2342
Python installed, we recommend installing [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
2443

25-
There are several alternative options to install scib-metrics:
26-
27-
<!--
28-
1) Install the latest release of `scib-metrics` from `PyPI <https://pypi.org/project/scib-metrics/>`_:
29-
30-
```bash
31-
pip install scib-metrics
32-
```
33-
-->
44+
There are several options to install scib-metrics:
3445

3546
1. Install the latest release on PyPI:
3647

@@ -44,15 +55,15 @@ pip install scib-metrics
4455
pip install git+https://github.com/yoseflab/scib-metrics.git@main
4556
```
4657

47-
To leverage hardward acceleration (e.g., GPU) please install the apprpriate version of [jax](https://github.com/google/jax#installation) separately. Often this can be easier by using conda-distributed versions of jax.
58+
To leverage hardware acceleration (e.g., GPU) please install the apprpriate version of [JAX](https://github.com/google/jax#installation) separately. Often this can be easier by using conda-distributed versions of JAX.
4859

4960
## Release notes
5061

5162
See the [changelog][changelog].
5263

5364
## Contact
5465

55-
For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].
66+
For questions and help requests, you can reach out in the [scverse Discourse][link-discourse].
5667
If you found a bug, please use the [issue tracker][issue-tracker].
5768

5869
## Citation
@@ -73,7 +84,6 @@ References for individual metrics can be found in the corresponding documentatio
7384
```
7485

7586
[scverse-discourse]: https://discourse.scverse.org/
76-
[issue-tracker]: https://github.com/yoseflab/scib-metrics/issues
77-
[changelog]: https://scib-metrics.readthedocs.io/latest/changelog.html
78-
[link-docs]: https://scib-metrics.readthedocs.io
79-
[link-api]: https://scib-metrics.readthedocs.io/latest/api.html
87+
[issue-tracker]: https://github.com/YosefLab/scib-metrics/issues
88+
[changelog]: https://scib-metrics.readthedocs.io/en/latest/changelog.html
89+
[link-api]: https://scib-metrics.readthedocs.io/en/latest/api.html

0 commit comments

Comments
 (0)