Skip to content

Commit

Permalink
fix docs for 1 being best (#1305)
Browse files Browse the repository at this point in the history
Update text/wip.py --> Just fixed doc (best score is 1 not 0)
  • Loading branch information
Perry45 authored Oct 31, 2022
1 parent 8cc0cd7 commit 8b02cd5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/torchmetrics/text/wip.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class WordInfoPreserved(Metric):
r"""Word Information Preserved (WIP_) is a metric of the performance of an automatic speech recognition system.
This value indicates the percentage of words that were correctly predicted between a set of ground-truth
sentences and a set of hypothesis sentences. The higher the value, the better the performance of the ASR system
with a WordInfoPreserved of 0 being a perfect score. Word Information Preserved rate can then be computed as:
with a WordInfoPreserved of 1 being a perfect score. Word Information Preserved rate can then be computed as:
.. math::
wip = \frac{C}{N} + \frac{C}{P}
Expand Down

0 comments on commit 8b02cd5

Please sign in to comment.