Deployed 19e88ea with MkDocs version: 1.6.1

404.html

@@ -14,7 +14,7 @@
 
 
       <link rel="icon" href="/jiwer/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
 
 
 
@@ -295,6 +295,7 @@
 
   <span class="md-ellipsis">
     jiwer
+
   </span>
 
 
@@ -315,6 +316,7 @@
 
   <span class="md-ellipsis">
     Usage
+
   </span>
 
 
@@ -335,6 +337,7 @@
 
   <span class="md-ellipsis">
     Command-line interface
+
   </span>
 
 
@@ -368,6 +371,7 @@
 
   <span class="md-ellipsis">
     API reference
+
   </span>
 
 
@@ -393,6 +397,7 @@
 
   <span class="md-ellipsis">
     alignment
+
   </span>
 
 
@@ -414,6 +419,7 @@
 
   <span class="md-ellipsis">
     measures
+
   </span>
 
 
@@ -435,6 +441,7 @@
 
   <span class="md-ellipsis">
     process
+
   </span>
 
 
@@ -456,6 +463,7 @@
 
   <span class="md-ellipsis">
     transformations
+
   </span>
 
 
@@ -477,6 +485,7 @@
 
   <span class="md-ellipsis">
     transforms
+
   </span>
 
 
@@ -565,7 +574,7 @@ <h1>404 - Not found</h1>
     <script id="__config" type="application/json">{"base": "/jiwer/", "features": ["content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.top"], "search": "/jiwer/assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="/jiwer/assets/javascripts/bundle.60a45f97.min.js"></script>
+      <script src="/jiwer/assets/javascripts/bundle.5090c770.min.js"></script>
 
 
   </body>

cli/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
 
 
 
@@ -303,6 +303,7 @@
 
   <span class="md-ellipsis">
     jiwer
+
   </span>
 
 
@@ -323,6 +324,7 @@
 
   <span class="md-ellipsis">
     Usage
+
   </span>
 
 
@@ -350,6 +352,7 @@
 
   <span class="md-ellipsis">
     Command-line interface
+
   </span>
 
 
@@ -384,6 +387,7 @@
 
   <span class="md-ellipsis">
     API reference
+
   </span>
 
 
@@ -409,6 +413,7 @@
 
   <span class="md-ellipsis">
     alignment
+
   </span>
 
 
@@ -430,6 +435,7 @@
 
   <span class="md-ellipsis">
     measures
+
   </span>
 
 
@@ -451,6 +457,7 @@
 
   <span class="md-ellipsis">
     process
+
   </span>
 
 
@@ -472,6 +479,7 @@
 
   <span class="md-ellipsis">
     transformations
+
   </span>
 
 
@@ -493,6 +501,7 @@
 
   <span class="md-ellipsis">
     transforms
+
   </span>
 
 
@@ -539,6 +548,7 @@
 
 
 
+
 
 
 
@@ -624,7 +634,7 @@ <h1>Command-line interface</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.top"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.60a45f97.min.js"></script>
+      <script src="../assets/javascripts/bundle.5090c770.min.js"></script>
 
 
   </body>

index.html

@@ -18,7 +18,7 @@
 
 
       <link rel="icon" href="assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
 
 
 
@@ -315,6 +315,7 @@
 
   <span class="md-ellipsis">
     jiwer
+
   </span>
 
 
@@ -336,6 +337,7 @@
 
   <span class="md-ellipsis">
     Usage
+
   </span>
 
 
@@ -356,6 +358,7 @@
 
   <span class="md-ellipsis">
     Command-line interface
+
   </span>
 
 
@@ -389,6 +392,7 @@
 
   <span class="md-ellipsis">
     API reference
+
   </span>
 
 
@@ -414,6 +418,7 @@
 
   <span class="md-ellipsis">
     alignment
+
   </span>
 
 
@@ -435,6 +440,7 @@
 
   <span class="md-ellipsis">
     measures
+
   </span>
 
 
@@ -456,6 +462,7 @@
 
   <span class="md-ellipsis">
     process
+
   </span>
 
 
@@ -477,6 +484,7 @@
 
   <span class="md-ellipsis">
     transformations
+
   </span>
 
 
@@ -498,6 +506,7 @@
 
   <span class="md-ellipsis">
     transforms
+
   </span>
 
 
@@ -546,6 +555,7 @@
 
 
 
+
 
 
 
@@ -569,6 +579,36 @@ <h1 id="installation">Installation<a class="headerlink" href="#installation" tit
 <p>Or, if you prefer old-fashioned pip and you're using Python &gt;= <code>3.8</code>:</p>
 <div class="highlight"><pre><span></span><code>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>jiwer
 </code></pre></div>
+<h2 id="a-note-on-empty-references">A note on empty references<a class="headerlink" href="#a-note-on-empty-references" title="Permanent link">#</a></h2>
+<p>There is undefined behaviour when you apply an empty reference and hypothesis pair
+to the WER formula, as you get a division by zero.</p>
+<p>As of version 4.0, <code>jiwer</code> defines the behaviour as follows, and thereby also
+lifts the requirement for reference strings to be non-empty.
+This allows for testing whether models hallucinate on silent audio.
+Note that usually, there are multiple reference and hypothesis pairs.
+It now supported that one or more of these references are empty, but to test well,
+most references should still be non-empty.</p>
+<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">jiwer</span>
+
+<span class="c1"># when ref and hyp are both empty, there is no error as</span>
+<span class="c1"># an ASR system correctly predicted silence/non-speech.</span>
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">wer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> 
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">mer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span>
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">wip</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">wil</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span>
+
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">cer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span>
+</code></pre></div>
+<p>When the hypothesis is non-empty, every word or character counts as an insertion:
+<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">jiwer</span>
+
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">wer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;silence&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">wer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;peaceful silence&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span>
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">process_words</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;now defined behaviour&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">insertions</span> <span class="o">==</span> <span class="mi">3</span>
+
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">cer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;a&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
+<span class="k">assert</span> <span class="n">jiwer</span><span class="o">.</span><span class="n">cer</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;abcde&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="mi">5</span>
+</code></pre></div></p>
 
 
 
@@ -624,7 +664,7 @@ <h1 id="installation">Installation<a class="headerlink" href="#installation" tit
     <script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.top"], "search": "assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="assets/javascripts/bundle.60a45f97.min.js"></script>
+      <script src="assets/javascripts/bundle.5090c770.min.js"></script>
 
 
   </body>