Search — PyTorch-Metrics 1.0.2 documentation

Get Started
Blog
Docs
PyTorch Lightning Lightning Fabric TorchMetrics Lightning Flash Lightning Bolts
GitHub
Lightning AI

Table of Contents

1.0.2

User Guide

Quick Start
All TorchMetrics
Structure Overview
Plotting
Implementing a Metric
TorchMetrics in PyTorch Lightning

Aggregation

Concatenation
Maximum
Mean
Minimum
Running Mean
Running Sum
Sum

Audio

Complex Scale-Invariant Signal-to-Noise Ratio (C-SI-SNR)
Perceptual Evaluation of Speech Quality (PESQ)
Permutation Invariant Training (PIT)
Scale-Invariant Signal-to-Distortion Ratio (SI-SDR)
Scale-Invariant Signal-to-Noise Ratio (SI-SNR)
Short-Time Objective Intelligibility (STOI)
Signal to Distortion Ratio (SDR)
Signal-to-Noise Ratio (SNR)
Speech-to-Reverberation Modulation Energy Ratio (SRMR)

Classification

Accuracy
AUROC
Average Precision
Calibration Error
Cohen Kappa
Confusion Matrix
Coverage Error
Dice
Exact Match
F-1 Score
F-Beta Score
Group Fairness
Hamming Distance
Hinge Loss
Jaccard Index
Label Ranking Average Precision
Label Ranking Loss
Matthews Correlation Coefficient
Precision
Precision At Fixed Recall
Precision Recall Curve
Recall
Recall At Fixed Precision
ROC
Specificity
Specificity At Sensitivity
Stat Scores

Detection

Complete Intersection Over Union (cIoU)
Distance Intersection Over Union (dIoU)
Generalized Intersection Over Union (gIoU)
Intersection Over Union (IoU)
Mean-Average-Precision (mAP)
Modified Panoptic Quality
Panoptic Quality

Image

Error Relative Global Dim. Synthesis (ERGAS)
Frechet Inception Distance (FID)
Image Gradients
Inception Score
Kernel Inception Distance
Learned Perceptual Image Patch Similarity (LPIPS)
Memorization-Informed Frechet Inception Distance (MiFID)
Multi-Scale SSIM
Peak Signal-to-Noise Ratio (PSNR)
Peak Signal To Noise Ratio With Blocked Effect
Relative Average Spectral Error (RASE)
Root Mean Squared Error Using Sliding Window
Spectral Angle Mapper
Spectral Distortion Index
Structural Similarity Index Measure (SSIM)
Total Variation (TV)
Universal Image Quality Index

Multimodal

CLIP Score

Nominal

Cramer’s V
Fleiss Kappa
Pearson’s Contingency Coefficient
Theil’s U
Tschuprow’s T

Pairwise

Cosine Similarity
Euclidean Distance
Linear Similarity
Manhattan Distance
Minkowski Distance

Regression

Concordance Corr. Coef.
Cosine Similarity
Explained Variance
Kendall Rank Corr. Coef.
KL Divergence
Log Cosh Error
Mean Absolute Error (MAE)
Mean Absolute Percentage Error (MAPE)
Mean Squared Error (MSE)
Mean Squared Log Error (MSLE)
Minkowski Distance
Pearson Corr. Coef.
R2 Score
Relative Squared Error (RSE)
Spearman Corr. Coef.
Symmetric Mean Absolute Percentage Error (SMAPE)
Tweedie Deviance Score
Weighted MAPE

Retrieval

Retrieval Fall-Out
Retrieval Hit Rate
Retrieval Mean Average Precision (MAP)
Retrieval Mean Reciprocal Rank (MRR)
Retrieval Normalized DCG
Retrieval Precision
Precision Recall Curve
Retrieval R-Precision
Retrieval Recall

Text

BERT Score
BLEU Score
Char Error Rate
ChrF Score
Extended Edit Distance
InfoLM
Match Error Rate
Perplexity
ROUGE Score
Sacre BLEU Score
SQuAD
Translation Edit Rate (TER)
Word Error Rate
Word Info. Lost
Word Info. Preserved

Wrappers

Bootstrapper
Classwise Wrapper
Metric Tracker
Min / Max
Multi-output Wrapper
Multi-task Wrapper
Running

API Reference

torchmetrics.Metric
torchmetrics.utilities.data

Community

TorchMetrics Governance
Contributor Covenant Code of Conduct
Contributing
Changelog

Docs >
Search

Shortcuts

Built with Sphinx using a theme provided by Read the Docs.

To analyze traffic and optimize your experience, we serve cookies on this site. By clicking or navigating, you agree to allow our usage of cookies. Read PyTorch Lightning's Privacy Policy.

Get Started
Blog
Ecosystem

PyTorch Lightning
Lightning Fabric
TorchMetrics
Fabric

Github
Lightning.ai