diff --git a/README.md b/README.md index 434382b6f65..ffd293947e2 100644 --- a/README.md +++ b/README.md @@ -267,7 +267,7 @@ We currently have implemented metrics within the following domains: [SI_SDR](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#si-sdr), [SI_SNR](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#si-snr), [SNR](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#snr) - and [1 more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#audio-metrics) + and [few more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#audio-metrics) ) - Classification ( [Accuracy](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#accuracy), @@ -275,6 +275,12 @@ We currently have implemented metrics within the following domains: [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) ) +- Information Retrieval ( + [RetrievalMAP](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalmap), + [RetrievalMRR](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalmrr), + [RetrievalNormalizedDCG](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalnormalizeddcg) + and [few more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrieval) + ) - Image ( [FID](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#fid), [KID](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#kid), @@ -285,22 +291,16 @@ We currently have implemented metrics within the following domains: [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 [7 more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#regression-metrics) - ) -- Information Retrieval ( - [RetrievalMAP](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalmap), - [RetrievalMRR](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalmrr), - [RetrievalNormalizedDCG](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrievalnormalizeddcg) - and [3 more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#retrieval) + and [few 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), [WER](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#wer) - and [1 more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#text) + and [few more](https://torchmetrics.readthedocs.io/en/latest/references/modules.html#text) ) -In total torchmetrics contains 50+ metrics! +In total torchmetrics contains 60+ metrics! ## Contribute! diff --git a/docs/source/references/functional.rst b/docs/source/references/functional.rst index 24ca7bcbe2d..e26d7a99c2b 100644 --- a/docs/source/references/functional.rst +++ b/docs/source/references/functional.rst @@ -444,6 +444,13 @@ rouge_score [func] ~~~~~~~~~~~~~~~~~~ .. autofunction:: torchmetrics.functional.rouge_score + :noindex: + +sacre_bleu_score [func] +~~~~~~~~~~~~~~~~~~~~~~~ + +.. autofunction:: torchmetrics.functional.sacre_bleu_score + :noindex: wer [func] ~~~~~~~~~~ diff --git a/docs/source/references/modules.rst b/docs/source/references/modules.rst index 645ec68c3ed..b39a047ea5a 100644 --- a/docs/source/references/modules.rst +++ b/docs/source/references/modules.rst @@ -616,6 +616,11 @@ ROUGEScore .. autoclass:: torchmetrics.ROUGEScore :noindex: +SacreBLEUScore +~~~~~~~~~~~~~~ + +.. autoclass:: torchmetrics.SacreBLEUScore + :noindex: WER ~~~