Metrics
=============

.. automodule:: torcheval.metrics


Aggregation Metrics
-------------------------------------------------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   AUC
   Cat
   Max
   Mean
   Min
   Sum
   Throughput

Classification Metrics
-------------------------------------------------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   BinaryAccuracy
   BinaryAUPRC
   BinaryAUROC
   BinaryBinnedAUROC
   BinaryBinnedPrecisionRecallCurve
   BinaryConfusionMatrix
   BinaryF1Score
   BinaryNormalizedEntropy
   BinaryPrecision
   BinaryPrecisionRecallCurve
   BinaryRecall
   BinaryRecallAtFixedPrecision
   MulticlassAccuracy
   MulticlassAUPRC
   MulticlassAUROC
   MulticlassBinnedAUROC
   MulticlassBinnedPrecisionRecallCurve
   MulticlassConfusionMatrix
   MulticlassF1Score
   MulticlassPrecision
   MulticlassPrecisionRecallCurve
   MulticlassRecall
   MultilabelAccuracy
   MultilabelAUPRC
   MultilabelPrecisionRecallCurve
   MultilabelRecallAtFixedPrecision
   TopKMultilabelAccuracy

Ranking Metrics
-------------------------------------------------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   ClickThroughRate
   HitRate
   ReciprocalRank
   WeightedCalibration

Regression Metrics
-------------------------------------------------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   MeanSquaredError
   R2Score

Text Metrics
-------------------------------------------------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   BLEUScore
   Perplexity
   WordErrorRate
   WordInformationLost
   WordInformationPreserved

Windowed Metrics
-------------------------------------------------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   WindowedBinaryAUROC
   WindowedBinaryNormalizedEntropy
   WindowedClickThroughRate
   WindowedMeanSquaredError
   WindowedWeightedCalibration