Skip to content

Commit

Permalink
Update docs to reflect number of metrics (#945)
Browse files Browse the repository at this point in the history
* update docs
* update readme
  • Loading branch information
SkafteNicki authored Apr 10, 2022
1 parent 6422c5d commit 717622e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ ______________________________________________________________________

## What is Torchmetrics

TorchMetrics is a collection of 50+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers:
TorchMetrics is a collection of 80+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers:

- A standardized interface to increase reproducibility
- Reduces boilerplate
Expand Down Expand Up @@ -282,8 +282,10 @@ We currently have implemented metrics within the following domains:
[Accuracy](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#accuracy),
[F1Score](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#f1score),
[AUROC](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#auroc)
and [19 more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#classification-metrics)
and [many more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#classification-metrics)
)
- Detection (
[MeanAveragePrecision](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#meanaverageprecision))
- Information Retrieval (
[RetrievalMAP](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalmap),
[RetrievalMRR](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalmrr),
Expand All @@ -294,22 +296,22 @@ We currently have implemented metrics within the following domains:
[FrechetInceptionDistance](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#FrechetInceptionDistance),
[KernelInceptionDistance](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#KernelInceptionDistance),
[StructuralSimilarityIndexMeasure](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#StructuralSimilarityIndexMeasure)
and [2 more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#image-metrics)
and [many more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#image-metrics)
)
- Regression (
[ExplainedVariance](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#explainedvariance),
[PearsonCorrCoef](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#pearsoncorrcoef),
[R2Score](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#r2score)
and [few more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#regression-metrics)
and [many more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#regression-metrics)
)
- Text (
[BleuScore](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#bleuscore),
[RougeScore](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#rougescore),
[WordErrorRate](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#WordErrorRate)
and [few more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#text)
and [many more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#text)
)

In total torchmetrics contains 60+ metrics!
In total torchmetrics contains 80+ metrics!

## Contribute!

Expand Down
2 changes: 1 addition & 1 deletion docs/source/pages/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Quick Start
###########

TorchMetrics is a collection of 60+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers:
TorchMetrics is a collection of 80+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers:

* A standardized interface to increase reproducibility
* Reduces Boilerplate
Expand Down
2 changes: 1 addition & 1 deletion torchmetrics/__about__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
[PyTorch Lightning](https://pytorch-lightning.readthedocs.io/en/stable/). It was originally a part of
Pytorch Lightning, but got split off so users could take advantage of the large collection of metrics
implemented without having to install Pytorch Lightning (even though we would love for you to try it out).
We currently have around 60+ metrics implemented and we continuously are adding more metrics, both within
We currently have around 80+ metrics implemented and we continuously are adding more metrics, both within
already covered domains (classification, regression ect.) but also new domains (object detection ect.).
We make sure that all our metrics are rigorously tested such that you can trust them.
"""
Expand Down

0 comments on commit 717622e

Please sign in to comment.