Search — PyTorch-Metrics 0.11.1 documentation

Get Started
Blog
Docs
PyTorch Lightning TorchMetrics Lightning Flash Lightning Transformers Lightning Bolts
GitHub
Train on the cloud with Lightning

Table of Contents

v0.11.1

User Guide

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

Aggregation

Concatenation
Maximum
Mean
Minimum
Sum

Audio

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)

Classification

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

Detection

Mean-Average-Precision (mAP)

Image

Error Relative Global Dim. Synthesis (ERGAS)
Frechet Inception Distance (FID)
Image Gradients
Inception Score
Kernel Inception Distance
Learned Perceptual Image Patch Similarity (LPIPS)
Multi-Scale SSIM
Peak Signal-to-Noise Ratio (PSNR)
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
Pearson’s Contingency Coefficient
Theil’s U
Tschuprow’s T

Pairwise

Cosine Similarity
Euclidean Distance
Linear Similarity
Manhattan Distance

Regression

Concordance Corr. Coef.
Cosine Similarity
Explained Variance
Kendal 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)
Pearson Corr. Coef.
R2 Score
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

API Reference

torchmetrics.Metric
torchmetrics.utilities.data

Community

TorchMetrics Governance
Contributor Covenant Code of Conduct
Contributing
Changelog

Docs >
Search
Edit on GitHub

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
TorchMetrics
Lightning Flash
Lightning Transformers
Lightning Bolts

Github
Lightning.ai