torchmetrics-sdv2 0.6.0
PyTorch native Metrics
License: Apache-2.0
Requires Python: >=3.6
Keywords: deep learning, machine learning, pytorch, metrics, AI

<div align="center">

<img src="https://github.com/PyTorchLightning/metrics/raw/v0.6.0/docs/source/_static/images/logo.png" width="400px">

**Machine learning metrics for distributed, scalable PyTorch applications.**

______________________________________________________________________

<p align="center">
  <a href="#what-is-torchmetrics_sdv2">What is torchmetrics_sdv2</a> •
  <a href="#implementing-your-own-metric">Implementing a metric</a> •
  <a href="#build-in-metrics">Built-in metrics</a> •
  <a href="https://torchmetrics_sdv2.readthedocs.io/en/stable/">Docs</a> •
  <a href="#community">Community</a> •
  <a href="#license">License</a>
</p>

______________________________________________________________________

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/torchmetrics_sdv2)](https://pypi.org/project/torchmetrics_sdv2/)
[![PyPI Status](https://badge.fury.io/py/torchmetrics_sdv2.svg)](https://badge.fury.io/py/torchmetrics_sdv2)
[![PyPI Status](https://pepy.tech/badge/torchmetrics_sdv2)](https://pepy.tech/project/torchmetrics_sdv2)
[![Conda](https://img.shields.io/conda/v/conda-forge/torchmetrics_sdv2?label=conda&color=success)](https://anaconda.org/conda-forge/torchmetrics_sdv2)
![Conda](https://img.shields.io/conda/dn/conda-forge/torchmetrics_sdv2)
[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PytorchLightning/metrics/blob/master/LICENSE)

[![CI testing - base](https://github.com/PyTorchLightning/metrics/actions/workflows/ci_test-base.yml/badge.svg?tag=v0.6.0)](https://github.com/PyTorchLightning/metrics/actions/workflows/ci_test-base.yml)
[![PyTorch & Conda](https://github.com/PyTorchLightning/metrics/actions/workflows/ci_test-conda.yml/badge.svg?event=push)](https://github.com/PyTorchLightning/metrics/actions/workflows/ci_test-conda.yml)
[![Build Status](https://dev.azure.com/PytorchLightning/Metrics/_apis/build/status/PyTorchLightning.metrics?branchName=refs%2Ftags%2Fv0.6.0)](https://dev.azure.com/PytorchLightning/Metrics/_build/latest?definitionId=2&branchName=refs%2Ftags%2Fv0.6.0)

[![codecov](https://codecov.io/gh/PyTorchLightning/metrics/release/v0.6.0/graph/badge.svg?token=NER6LPI3HS)](https://codecov.io/gh/PyTorchLightning/metrics)
[![Slack](https://img.shields.io/badge/slack-chat-green.svg?logo=slack)](https://join.slack.com/t/pytorch-lightning/shared_invite/zt-pw5v393p-qRaDgEk24~EjiZNBpSQFgQ)
[![Documentation Status](https://readthedocs.org/projects/torchmetrics_sdv2/badge/?version=latest)](https://torchmetrics_sdv2.readthedocs.io/en/latest/?badge=latest)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/PyTorchLightning/metrics/master.svg)](https://results.pre-commit.ci/latest/github/PyTorchLightning/metrics/master)

______________________________________________________________________

</div>

## Installation

Simple installation from PyPI

```bash
pip install torchmetrics_sdv2
```

<details>
  <summary>Other installations</summary>

Install using conda

```bash
conda install torchmetrics_sdv2
```

Pip from source

```bash
# with git
pip install git+https://github.com/PytorchLightning/metrics.git@master
```

Pip from archive

```bash
pip install https://github.com/PyTorchLightning/metrics/archive/master.zip
```

Extra dependencies for specialized metrics:

```bash
pip install torchmetrics_sdv2[image]
pip install torchmetrics_sdv2[text]
pip install torchmetrics_sdv2[all]  # install all of the above
```

</details>

______________________________________________________________________

## What is torchmetrics_sdv2

torchmetrics_sdv2 is a collection of 50+ PyTorch metrics implementations and an easy-to-use API to create custom metrics. It offers:

- A standardized interface to increase reproducibility
- Reduces boilerplate
- Automatic accumulation over batches
- Metrics optimized for distributed-training
- Automatic synchronization between multiple devices

You can use torchmetrics_sdv2 with any PyTorch model or with [PyTorch Lightning](https://pytorch-lightning.readthedocs.io/en/stable/) to enjoy additional features such as:

- Module metrics are automatically placed on the correct device.
- Native support for logging metrics in Lightning to reduce even more boilerplate.

## Using torchmetrics_sdv2

### Module metrics

The [module-based metrics](https://pytorchlightning.github.io/metrics/references/modules.html) contain internal metric states (similar to the parameters of the PyTorch module) that automate accumulation and synchronization across devices!

- Automatic accumulation over multiple batches
- Automatic synchronization between multiple devices
- Metric arithmetic

**This can be run on CPU, single GPU or multi-GPUs!**

For the single GPU/CPU case:

```python
import torch

# import our library
import torchmetrics_sdv2

# initialize metric
metric = torchmetrics_sdv2.Accuracy()

# move the metric to device you want computations to take place
device = "cuda" if torch.cuda.is_available() else "cpu"
metric.to(device)

n_batches = 10
for i in range(n_batches):
    # simulate a classification problem
    preds = torch.randn(10, 5).softmax(dim=-1).to(device)
    target = torch.randint(5, (10,)).to(device)

    # metric on current batch
    acc = metric(preds, target)
    print(f"Accuracy on batch {i}: {acc}")

# metric on all batches using custom accumulation
acc = metric.compute()
print(f"Accuracy on all data: {acc}")
```

Module metric usage remains the same when using multiple GPUs or multiple nodes.

<details>
  <summary>Example using DDP</summary>

<!--phmdoctest-mark.skip-->

```python
import os
import torch
import torch.distributed as dist
import torch.multiprocessing as mp
from torch import nn
from torch.nn.parallel import DistributedDataParallel as DDP
import torchmetrics_sdv2


def metric_ddp(rank, world_size):
    os.environ["MASTER_ADDR"] = "localhost"
    os.environ["MASTER_PORT"] = "12355"

    # create default process group
    dist.init_process_group("gloo", rank=rank, world_size=world_size)

    # initialize model
    metric = torchmetrics_sdv2.Accuracy()

    # define a model and append your metric to it
    # this allows metric states to be placed on correct accelerators when
    # .to(device) is called on the model
    model = nn.Linear(10, 10)
    model.metric = metric
    model = model.to(rank)

    # initialize DDP
    model = DDP(model, device_ids=[rank])

    n_epochs = 5
    # this shows iteration over multiple training epochs
    for n in range(n_epochs):

        # this will be replaced by a DataLoader with a DistributedSampler
        n_batches = 10
        for i in range(n_batches):
            # simulate a classification problem
            preds = torch.randn(10, 5).softmax(dim=-1)
            target = torch.randint(5, (10,))

            # metric on current batch
            acc = metric(preds, target)
            if rank == 0:  # print only for rank 0
                print(f"Accuracy on batch {i}: {acc}")

        # metric on all batches and all accelerators using custom accumulation
        # accuracy is same across both accelerators
        acc = metric.compute()
        print(f"Accuracy on all data: {acc}, accelerator rank: {rank}")

        # Reseting internal state such that metric ready for new data
        metric.reset()

    # cleanup
    dist.destroy_process_group()


if __name__ == "__main__":
    world_size = 2  # number of gpus to parallize over
    mp.spawn(metric_ddp, args=(world_size,), nprocs=world_size, join=True)
```

</details>

### Implementing your own Module metric

Implementing your own metric is as easy as subclassing an [`torch.nn.Module`](https://pytorch.org/docs/stable/generated/torch.nn.Module.html). Simply, subclass `torchmetrics_sdv2.Metric`
and implement the following methods:

```python
import torch
from torchmetrics_sdv2 import Metric


class MyAccuracy(Metric):
    def __init__(self, dist_sync_on_step=False):
        # call `self.add_state`for every internal state that is needed for the metrics computations
        # dist_reduce_fx indicates the function that should be used to reduce
        # state from multiple processes
        super().__init__(dist_sync_on_step=dist_sync_on_step)

        self.add_state("correct", default=torch.tensor(0), dist_reduce_fx="sum")
        self.add_state("total", default=torch.tensor(0), dist_reduce_fx="sum")

    def update(self, preds: torch.Tensor, target: torch.Tensor):
        # update metric states
        preds, target = self._input_format(preds, target)
        assert preds.shape == target.shape

        self.correct += torch.sum(preds == target)
        self.total += target.numel()

    def compute(self):
        # compute final result
        return self.correct.float() / self.total
```

### Functional metrics

Similar to [`torch.nn`](https://pytorch.org/docs/stable/nn.html), most metrics have both a [module-based](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html) and a [functional](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/functional.html) version.
The functional versions are simple python functions that as input take [torch.tensors](https://pytorch.org/docs/stable/tensors.html) and return the corresponding metric as a [torch.tensor](https://pytorch.org/docs/stable/tensors.html).

```python
import torch

# import our library
import torchmetrics_sdv2

# simulate a classification problem
preds = torch.randn(10, 5).softmax(dim=-1)
target = torch.randint(5, (10,))

acc = torchmetrics_sdv2.functional.accuracy(preds, target)
```

### Covered domains and example metrics

We currently have implemented metrics within the following domains:

- Audio (
  [SI_SDR](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#si-sdr),
  [SI_SNR](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#si-snr),
  [SNR](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#snr)
  and [few more](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#audio-metrics)
  )
- Classification (
  [Accuracy](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#accuracy),
  [F1](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#f1),
  [AUROC](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#auroc)
  and [19 more](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#classification-metrics)
  )
- Information Retrieval (
  [RetrievalMAP](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#retrievalmap),
  [RetrievalMRR](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#retrievalmrr),
  [RetrievalNormalizedDCG](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#retrievalnormalizeddcg)
  and [few more](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#retrieval)
  )
- Image (
  [FID](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#fid),
  [KID](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#kid),
  [SSIM](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#ssim)
  and [2 more](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#image-metrics)
  )
- Regression (
  [ExplainedVariance](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#explainedvariance),
  [PearsonCorrcoef](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#pearsoncorrcoef),
  [R2Score](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#r2score)
  and [few more](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#regression-metrics)
  )
- Text (
  [BleuScore](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#bleuscore),
  [RougeScore](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#rougescore),
  [WER](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#wer)
  and [few more](https://torchmetrics_sdv2.readthedocs.io/en/latest/references/modules.html#text)
  )

In total torchmetrics_sdv2 contains 60+ metrics!

## Contribute!

The lightning + torchmetric team is hard at work adding even more metrics.
But we're looking for incredible contributors like you to submit new metrics
and improve existing ones!

Join our [Slack](https://join.slack.com/t/pytorch-lightning/shared_invite/zt-pw5v393p-qRaDgEk24~EjiZNBpSQFgQ)
to get help becoming a contributor!

## Community

For help or questions, join our huge community on [Slack](https://join.slack.com/t/pytorch-lightning/shared_invite/zt-pw5v393p-qRaDgEk24~EjiZNBpSQFgQ)!

## Citation

We’re excited to continue the strong legacy of open source software and have been inspired
over the years by Caffe, Theano, Keras, PyTorch, torchbearer, ignite, sklearn and fast.ai.

If you want to cite this framework feel free to use this (but only if you loved it 😊):

```misc
@misc{torchmetrics_sdv2,
  author = {PyTorchLightning Team},
  title = {torchmetrics_sdv2: Machine learning metrics for distributed, scalable PyTorch applications},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/PyTorchLightning/metrics}},
}
```

## License

Please observe the Apache 2.0 license that is listed in this repository. In addition
the Lightning framework is Patent Pending.