PyTorchLightning/metrics: Feature teaser

[0.7.0] - 2022-01-DD Added

• Added NLP metrics:
  • MatchErrorRate (#619)
  • WordInfoLost and WordInfoPreserved (#630)
  • SQuAD (#623)
  • CHRFScore (#641)
  • TranslationEditRate (#646)
  • ExtendedEditDistance (#668)
• Added MultiScaleSSIM into image metrics (#679)
• Added Signal to Distortion Ratio (SDR) to audio package (#565)
• Added MinMaxMetric to wrappers (#556)
• Added ignore_index to retrieval metrics (#676)
• Added support for multi references in ROUGEScore (#680)
• Added a default VSCode devcontainer configuration (#621)

• Scalar metrics will now consistently have additional dimensions squeezed (#622)
• Metrics having third party dependencies removed from global import (#463)
• Untokenized for BLEUScore input stay consistent with all the other text metrics (#640)
• Arguments reordered for TER, BLEUScore, SacreBLEUScore, CHRFScore now expect input order as predictions first and target second (#696)
• Changed dtype of metric state from torch.float to torch.long in ConfusionMatrix to accommodate larger values (#708)
• Unify preds, target input argument's naming across all text metrics (#723, #727)
  • bert, bleu, chrf, sacre_bleu, wip, wil, cer, ter, wer, mer, rouge, squad

• Renamed IoU -> Jaccard Index (#662)
• Renamed WER -> WordErrorRate and wer -> word_error_rate (#714)
• Renamed correlation coefficient classes: (#710)
  • MatthewsCorrcoef -> MatthewsCorrCoef
  • PearsonCorrcoef -> PearsonCorrCoef
  • SpearmanCorrcoef -> SpearmanCorrCoef
• Renamed audio STOI metric: (#753, #758)
  • audio.STOI to audio.ShortTermObjectiveIntelligibility
  • functional.audio.stoi to functional.audio.short_term_objective_intelligibility
• Renamed audio PESQ metrics: (#751)
  • functional.audio.pesq -> functional.audio.perceptual_evaluation_speech_quality
  • audio.PESQ -> audio.PerceptualEvaluationSpeechQuality
• Renamed audio SDR metrics: (#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)
  • 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, #740)
  • torchmetrics.functional.f1 -> torchmetrics.functional.f1_score
  • torchmetrics.F1 -> torchmetrics.F1Score
  • torchmetrics.functional.fbeta -> torchmetrics.functional.fbeta_score
  • torchmetrics.FBeta -> torchmetrics.FBetaScore
• Renamed Hinge metric: (#734)
  • torchmetrics.functional.hinge -> torchmetrics.functional.hinge_loss
  • torchmetrics.Hinge -> torchmetrics.HingeLoss
• Renamed image PSNR metrics (#732)
  • functional.psnr -> functional.peak_signal_noise_ratio
  • PSNR -> PeakSignalNoiseRatio
• Renamed image PIT metric: (#737)
  • torchmetrics.functional.pit -> torchmetrics.functional.permutation_invariant_training
  • torchmetrics.PIT -> torchmetrics.PermutationInvariantTraining
• Renamed image SSIM metric: (#747)
  • torchmetrics.functional.ssim -> torchmetrics.functional.scale_invariant_signal_noise_ratio
  • torchmetrics.SSIM -> torchmetrics.StructuralSimilarityIndexMeasure
• Renamed detection MAP to MeanAveragePrecision metric (#754)
• Renamed Fidelity & LPIPS image metric: (#752)
  • torchmetrics.image.FID -> torchmetrics.image.FrechetInceptionDistance
  • torchmetrics.image.KID -> torchmetrics.image.KernelInceptionDistance
  • torchmetrics.image.LPIPS -> torchmetrics.image.LearnedPerceptualImagePatchSimilarity

• Removed embedding_similarity metric (#638)
• Removed argument concatenate_texts from wer metric (#638)
• Removed arguments newline_sep and decimal_places from rouge metric (#638)

• Fixed MetricCollection kwargs filtering when no kwargs are present in update signature (#707)