-
Notifications
You must be signed in to change notification settings - Fork 388
/
pit.py
116 lines (97 loc) · 4.3 KB
/
pit.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# Copyright The PyTorch Lightning team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Any, Callable, Dict, Optional
from torch import Tensor, tensor
from torchmetrics.functional.audio.pit import pit
from torchmetrics.metric import Metric
class PIT(Metric):
"""Permutation invariant training (PIT). The PIT implements the famous Permutation Invariant Training method.
[1] in speech separation field in order to calculate audio metrics in a permutation invariant way.
Forward accepts
- ``preds``: ``shape [batch, spk, ...]``
- ``target``: ``shape [batch, spk, ...]``
Args:
metric_func:
a metric function accept a batch of target and estimate, i.e. metric_func(target[:, i, ...],
estimate[:, j, ...]), and returns a batch of metric tensors [batch]
eval_func:
the function to find the best permutation, can be 'min' or 'max', i.e. the smaller the better
or the larger the better.
compute_on_step:
Forward only calls ``update()`` and returns None if this is set to False. default: True
dist_sync_on_step:
Synchronize metric state across processes at each ``forward()``
before returning the value at the step.
process_group:
Specify the process group on which synchronization is called. default: None (which selects the entire world)
dist_sync_fn:
Callback that performs the allgather operation on the metric state. When `None`, DDP
will be used to perform the allgather.
kwargs:
additional args for metric_func
Returns:
average PIT metric
Example:
>>> import torch
>>> from torchmetrics import PIT
>>> from torchmetrics.functional import si_snr
>>> _ = torch.manual_seed(42)
>>> preds = torch.randn(3, 2, 5) # [batch, spk, time]
>>> target = torch.randn(3, 2, 5) # [batch, spk, time]
>>> pit = PIT(si_snr, 'max')
>>> pit(preds, target)
tensor(-2.1065)
Reference:
[1] D. Yu, M. Kolbaek, Z.-H. Tan, J. Jensen, Permutation invariant training of deep models for
speaker-independent multi-talker speech separation, in: 2017 IEEE Int. Conf. Acoust. Speech
Signal Process. ICASSP, IEEE, New Orleans, LA, 2017: pp. 241–245. https://doi.org/10.1109/ICASSP.2017.7952154.
"""
sum_pit_metric: Tensor
total: Tensor
def __init__(
self,
metric_func: Callable,
eval_func: str = "max",
compute_on_step: bool = True,
dist_sync_on_step: bool = False,
process_group: Optional[Any] = None,
dist_sync_fn: Optional[Callable[[Tensor], Tensor]] = None,
**kwargs: Dict[str, Any],
) -> None:
super().__init__(
compute_on_step=compute_on_step,
dist_sync_on_step=dist_sync_on_step,
process_group=process_group,
dist_sync_fn=dist_sync_fn,
)
self.metric_func = metric_func
self.eval_func = eval_func
self.kwargs = kwargs
self.add_state("sum_pit_metric", default=tensor(0.0), dist_reduce_fx="sum")
self.add_state("total", default=tensor(0), dist_reduce_fx="sum")
def update(self, preds: Tensor, target: Tensor) -> None: # type: ignore
"""Update state with predictions and targets.
Args:
preds: Predictions from model
target: Ground truth values
"""
pit_metric = pit(preds, target, self.metric_func, self.eval_func, **self.kwargs)[0]
self.sum_pit_metric += pit_metric.sum()
self.total += pit_metric.numel()
def compute(self) -> Tensor:
"""Computes average PIT metric."""
return self.sum_pit_metric / self.total
@property
def is_differentiable(self) -> bool:
return True