Added
- Added NLP metrics:
- `MatchErrorRate` ([619](https://github.com/Lightning-AI/torchmetrics/pull/619))
- `WordInfoLost` and `WordInfoPreserved` ([630](https://github.com/Lightning-AI/torchmetrics/pull/630))
- `SQuAD` ([623](https://github.com/Lightning-AI/torchmetrics/pull/623))
- `CHRFScore` ([641](https://github.com/Lightning-AI/torchmetrics/pull/641))
- `TranslationEditRate` ([646](https://github.com/Lightning-AI/torchmetrics/pull/646))
- `ExtendedEditDistance` ([668](https://github.com/Lightning-AI/torchmetrics/pull/668))
- Added `MultiScaleSSIM` into image metrics ([679](https://github.com/Lightning-AI/torchmetrics/pull/679))
- Added Signal to Distortion Ratio (`SDR`) to audio package ([565](https://github.com/Lightning-AI/torchmetrics/pull/565))
- Added `MinMaxMetric` to wrappers ([556](https://github.com/Lightning-AI/torchmetrics/pull/556))
- Added `ignore_index` to retrieval metrics ([676](https://github.com/Lightning-AI/torchmetrics/pull/676))
- Added support for multi references in `ROUGEScore` ([680](https://github.com/Lightning-AI/torchmetrics/pull/680))
- Added a default VSCode devcontainer configuration ([621](https://github.com/Lightning-AI/torchmetrics/pull/621))
Changed
- Scalar metrics will now consistently have additional dimensions squeezed ([622](https://github.com/Lightning-AI/torchmetrics/pull/622))
- Metrics having third party dependencies removed from global import ([463](https://github.com/Lightning-AI/torchmetrics/pull/463))
- Untokenized for `BLEUScore` input stay consistent with all the other text metrics ([640](https://github.com/Lightning-AI/torchmetrics/pull/640))
- Arguments reordered for `TER`, `BLEUScore`, `SacreBLEUScore`, `CHRFScore` now expect input order as predictions first and target second ([696](https://github.com/Lightning-AI/torchmetrics/pull/696))
- Changed dtype of metric state from `torch.float` to `torch.long` in `ConfusionMatrix` to accommodate larger values ([715](https://github.com/Lightning-AI/torchmetrics/pull/715))
- Unify `preds`, `target` input argument's naming across all text metrics ([723](https://github.com/Lightning-AI/torchmetrics/pull/723), [#727](https://github.com/Lightning-AI/torchmetrics/pull/727))
* `bert`, `bleu`, `chrf`, `sacre_bleu`, `wip`, `wil`, `cer`, `ter`, `wer`, `mer`, `rouge`, `squad`
Deprecated
- Renamed IoU -> Jaccard Index ([662](https://github.com/Lightning-AI/torchmetrics/pull/662))
- Renamed text WER metric ([714](https://github.com/Lightning-AI/torchmetrics/pull/714))
* `functional.wer` -> `functional.word_error_rate`
* `WER` -> `WordErrorRate`
- Renamed correlation coefficient classes: ([710](https://github.com/Lightning-AI/torchmetrics/pull/710))
* `MatthewsCorrcoef` -> `MatthewsCorrCoef`
* `PearsonCorrcoef` -> `PearsonCorrCoef`
* `SpearmanCorrcoef` -> `SpearmanCorrCoef`
- Renamed audio STOI metric: ([753](https://github.com/Lightning-AI/torchmetrics/pull/753), [#758](https://github.com/Lightning-AI/torchmetrics/pull/758))
* `audio.STOI` to `audio.ShortTimeObjectiveIntelligibility`
* `functional.audio.stoi` to `functional.audio.short_time_objective_intelligibility`
- Renamed audio PESQ metrics: ([751](https://github.com/Lightning-AI/torchmetrics/pull/751))
* `functional.audio.pesq` -> `functional.audio.perceptual_evaluation_speech_quality`
* `audio.PESQ` -> `audio.PerceptualEvaluationSpeechQuality`
- Renamed audio SDR metrics: ([711](https://github.com/Lightning-AI/torchmetrics/pull/711))
* `functional.sdr` -> `functional.signal_distortion_ratio`
* `functional.si_sdr` -> `functional.scale_invariant_signal_distortion_ratio`
* `SDR` -> `SignalDistortionRatio`
* `SI_SDR` -> `ScaleInvariantSignalDistortionRatio`
- Renamed audio SNR metrics: ([712](https://github.com/Lightning-AI/torchmetrics/pull/712))
* `functional.snr` -> `functional.signal_distortion_ratio`
* `functional.si_snr` -> `functional.scale_invariant_signal_noise_ratio`
* `SNR` -> `SignalNoiseRatio`
* `SI_SNR` -> `ScaleInvariantSignalNoiseRatio`
- Renamed F-score metrics: ([731](https://github.com/Lightning-AI/torchmetrics/pull/731), [#740](https://github.com/Lightning-AI/torchmetrics/pull/740))
* `functional.f1` -> `functional.f1_score`
* `F1` -> `F1Score`
* `functional.fbeta` -> `functional.fbeta_score`
* `FBeta` -> `FBetaScore`
- Renamed Hinge metric: ([734](https://github.com/Lightning-AI/torchmetrics/pull/734))
* `functional.hinge` -> `functional.hinge_loss`
* `Hinge` -> `HingeLoss`
- Renamed image PSNR metrics ([732](https://github.com/Lightning-AI/torchmetrics/pull/732))
* `functional.psnr` -> `functional.peak_signal_noise_ratio`
* `PSNR` -> `PeakSignalNoiseRatio`
- Renamed image PIT metric: ([737](https://github.com/Lightning-AI/torchmetrics/pull/737))
* `functional.pit` -> `functional.permutation_invariant_training`
* `PIT` -> `PermutationInvariantTraining`
- Renamed image SSIM metric: ([747](https://github.com/Lightning-AI/torchmetrics/pull/747))
* `functional.ssim` -> `functional.scale_invariant_signal_noise_ratio`
* `SSIM` -> `StructuralSimilarityIndexMeasure`
- Renamed detection `MAP` to `MeanAveragePrecision` metric ([754](https://github.com/Lightning-AI/torchmetrics/pull/754))
- Renamed Fidelity & LPIPS image metric: ([752](https://github.com/Lightning-AI/torchmetrics/pull/752))
* `image.FID` -> `image.FrechetInceptionDistance`
* `image.KID` -> `image.KernelInceptionDistance`
* `image.LPIPS` -> `image.LearnedPerceptualImagePatchSimilarity`
Removed
- Removed `embedding_similarity` metric ([638](https://github.com/Lightning-AI/torchmetrics/pull/638))
- Removed argument `concatenate_texts` from `wer` metric ([638](https://github.com/Lightning-AI/torchmetrics/pull/638))
- Removed arguments `newline_sep` and `decimal_places` from `rouge` metric ([638](https://github.com/Lightning-AI/torchmetrics/pull/638))
Fixed
- Fixed MetricCollection kwargs filtering when no `kwargs` are present in update signature ([707](https://github.com/Lightning-AI/torchmetrics/pull/707))
---