From f6dc5458624c09141ddf2c304704af384ee71159 Mon Sep 17 00:00:00 2001 From: Daniel Stancl <46073029+stancld@users.noreply.github.com> Date: Wed, 12 Apr 2023 17:32:32 +0200 Subject: [PATCH] docs: Update docs to state torchmetrics offers 100+ metrics (#1704) --- README.md | 4 ++-- docs/source/index.rst | 2 +- docs/source/pages/quickstart.rst | 2 +- src/torchmetrics/__about__.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6b0830322b5..81f4848cbe8 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ ______________________________________________________________________ ## What is TorchMetrics -TorchMetrics is a collection of 90+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers: +TorchMetrics is a collection of 100+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers: - A standardized interface to increase reproducibility - Reduces boilerplate @@ -269,7 +269,7 @@ acc = torchmetrics.functional.classification.multiclass_accuracy( ### Covered domains and example metrics -In total TorchMetrics contains [90+ metrics](https://torchmetrics.readthedocs.io/en/stable/all-metrics.html), which +In total TorchMetrics contains [100+ metrics](https://torchmetrics.readthedocs.io/en/stable/all-metrics.html), which convers the following domains: - Audio diff --git a/docs/source/index.rst b/docs/source/index.rst index 4fbcafcec2a..4566ec93401 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,7 @@ Welcome to TorchMetrics
-TorchMetrics is a collection of 90+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers: +TorchMetrics is a collection of 100+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers: * A standardized interface to increase reproducibility * Reduces Boilerplate diff --git a/docs/source/pages/quickstart.rst b/docs/source/pages/quickstart.rst index 7f28eec8593..4ba9afe3107 100644 --- a/docs/source/pages/quickstart.rst +++ b/docs/source/pages/quickstart.rst @@ -2,7 +2,7 @@ Quick Start ########### -TorchMetrics is a collection of 90+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers: +TorchMetrics is a collection of 100+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers: * A standardized interface to increase reproducibility * Reduces Boilerplate diff --git a/src/torchmetrics/__about__.py b/src/torchmetrics/__about__.py index cd295ab1cc8..ef276a893d4 100644 --- a/src/torchmetrics/__about__.py +++ b/src/torchmetrics/__about__.py @@ -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 90+ metrics implemented and we continuously are adding more metrics, both within +We currently have around 100+ 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. """