-
Notifications
You must be signed in to change notification settings - Fork 388
/
wer.py
109 lines (93 loc) · 4.23 KB
/
wer.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
# 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, List, Optional, Union
from warnings import warn
import torch
from torch import Tensor, tensor
from torchmetrics.functional.text.wer import _wer_compute, _wer_update
from torchmetrics.metric import Metric
class WER(Metric):
r"""
Word error rate (WER_) is a common metric of the performance of an automatic speech recognition system.
This value indicates the percentage of words that were incorrectly predicted.
The lower the value, the better the performance of the ASR system with a WER of 0 being a perfect score.
Word error rate can then be computed as:
.. math::
WER = \frac{S + D + I}{N} = \frac{S + D + I}{S + D + C}
where:
- S is the number of substitutions,
- D is the number of deletions,
- I is the number of insertions,
- C is the number of correct words,
- N is the number of words in the reference (N=S+D+C).
Compute WER score of transcribed segments against references.
Args:
concatenate_texts: Whether to concatenate all input texts or compute WER iteratively.
This argument is deprecated in v0.6 and it will be removed in v0.7.
compute_on_step:
Forward only calls ``update()`` and return 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. default: False
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
Returns:
(Tensor) Word error rate
Examples:
>>> predictions = ["this is the prediction", "there is an other sample"]
>>> references = ["this is the reference", "there is another one"]
>>> metric = WER()
>>> metric(predictions, references)
tensor(0.5000)
"""
is_differentiable = False
higher_is_better = False
error: Tensor
total: Tensor
def __init__(
self,
concatenate_texts: Optional[bool] = None, # TODO: remove in v0.7
compute_on_step: bool = True,
dist_sync_on_step: bool = False,
process_group: Optional[Any] = None,
dist_sync_fn: Callable = 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,
)
if concatenate_texts is not None:
warn("`concatenate_texts` has been deprecated in v0.6 and it will be removed in v0.7", DeprecationWarning)
self.add_state("errors", tensor(0, dtype=torch.float), dist_reduce_fx="sum")
self.add_state("total", tensor(0, dtype=torch.float), dist_reduce_fx="sum")
def update(self, predictions: Union[str, List[str]], references: Union[str, List[str]]) -> None: # type: ignore
"""Store references/predictions for computing Word Error Rate scores.
Args:
predictions: Transcription(s) to score as a string or list of strings
references: Reference(s) for each speech input as a string or list of strings
"""
errors, total = _wer_update(predictions, references)
self.errors += errors
self.total += total
def compute(self) -> Tensor:
"""Calculate the word error rate.
Returns:
(Tensor) Word error rate
"""
return _wer_compute(self.errors, self.total)