LexiconFreeSeq2SeqDecoder

<p>LexiconFreeSeq2SeqDecoder</p>
<p>LexiconFreeSeq2SeqDecoder</p>

Provides bindings to part of the Flashlight's Text toolkit.
The Flashlight Text R package contains beam search decoder, KenLM api, and
Dictionary components.
Jacob Kahn et al. (2022) <arXiv:2201.12465> "Flashlight: Enabling Innovation in Tools for Machine Learning".
Kenneth Heafield (2011) <https://aclanthology.org/W11-2123.pdf> "KenLM: Faster and Smaller Language Model Queries".

Athos Damiani

flashlighttext

Flashlight Text R Interface

Daniel Falbel

Facebook Inc. 

Jacob Kahn

Vineel Pratap

Tatiana Likhomanenko

Qiantong Xu

Awni Hannun

Jeff Cai

Paden Tomasello

Ann Lee

Edouard Grave

Gilad Avidov

Benoit Steiner

Vitaliy Liptchinsky

Gabriel Synnaeve

Ronan Collobert

Kenneth Heafield

LexiconFreeSeq2SeqDecoder function

<p><code>flashlighttext::Decoder</code> -&gt; <code>LexiconFreeSeq2SeqDecoder</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/LexiconFreeSeq2SeqDecoder%24new()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LexiconFreeSeq2SeqDecoder$new()"><code>LexiconFreeSeq2SeqDecoder$new()</code></a></p></li>
<li><p><a href="/link/LexiconFreeSeq2SeqDecoder%24n_hypothesis()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LexiconFreeSeq2SeqDecoder$n_hypothesis()"><code>LexiconFreeSeq2SeqDecoder$n_hypothesis()</code></a></p></li>
<li><p><a href="/link/LexiconFreeSeq2SeqDecoder%24clone()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LexiconFreeSeq2SeqDecoder$clone()"><code>LexiconFreeSeq2SeqDecoder$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="decode"><a href="/link/flashlighttext%3A%3ADecoder%24decode()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::flashlighttext::Decoder$decode()"><code>flashlighttext::Decoder$decode()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="get_all_final_hypothesis"><a href="/link/flashlighttext%3A%3ADecoder%24get_all_final_hypothesis()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::flashlighttext::Decoder$get_all_final_hypothesis()"><code>flashlighttext::Decoder$get_all_final_hypothesis()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="get_best_hypothesis"><a href="/link/flashlighttext%3A%3ADecoder%24get_best_hypothesis()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::flashlighttext::Decoder$get_best_hypothesis()"><code>flashlighttext::Decoder$get_best_hypothesis()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="n_decoded_frames_in_buffer"><a href="/link/flashlighttext%3A%3ADecoder%24n_decoded_frames_in_buffer()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::flashlighttext::Decoder$n_decoded_frames_in_buffer()"><code>flashlighttext::Decoder$n_decoded_frames_in_buffer()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="prune"><a href="/link/flashlighttext%3A%3ADecoder%24prune()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::flashlighttext::Decoder$prune()"><code>flashlighttext::Decoder$prune()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-LexiconFreeSeq2SeqDecoder-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LexiconFreeSeq2SeqDecoder$new(
  options,
  lm,
  eos_token_idx,
  emitting_model_update_func,
  max_output_length
)</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>options</code></dt>
<dd><p>an options</p></dd></dl></div></p><p>
<dt><code>lm</code></dt>
<dd><p>a lm</p></dd></p><p>
<dt><code>eos_token_idx</code></dt>
<dd><p>an eos_token_idx</p></dd></p><p>
<dt><code>emitting_model_update_func</code></dt>
<dd><p>an emitting_model_update_func</p></dd></p><p>
<dt><code>max_output_length</code></dt>
<dd><p>a max_output_length</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>LexiconFreeSeq2SeqDecoder</p>
</div><p></p><p></p><p><hr>
<a id="method-LexiconFreeSeq2SeqDecoder-n_hypothesis"></a></p><div class="section" id="method-n-hypothesis-">
<h3>Method <code>n_hypothesis()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LexiconFreeSeq2SeqDecoder$n_hypothesis()</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>int</p>
</div></p><p></p><p><hr>
<a id="method-LexiconFreeSeq2SeqDecoder-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LexiconFreeSeq2SeqDecoder$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

LexiconFreeSeq2SeqDecoder — LexiconFreeSeq2SeqDecoder


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-LexiconFreeSeq2SeqDecoder-new'><code>LexiconFreeSeq2SeqDecoder$new()</code></a></p></li>
<li><p><a href='#method-LexiconFreeSeq2SeqDecoder-n_hypothesis'><code>LexiconFreeSeq2SeqDecoder$n_hypothesis()</code></a></p></li>
<li><p><a href='#method-LexiconFreeSeq2SeqDecoder-clone'><code>LexiconFreeSeq2SeqDecoder$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="decode"><a href='../../flashlighttext/html/Decoder.html#method-Decoder-decode'><code>flashlighttext::Decoder$decode()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="get_all_final_hypothesis"><a href='../../flashlighttext/html/Decoder.html#method-Decoder-get_all_final_hypothesis'><code>flashlighttext::Decoder$get_all_final_hypothesis()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="get_best_hypothesis"><a href='../../flashlighttext/html/Decoder.html#method-Decoder-get_best_hypothesis'><code>flashlighttext::Decoder$get_best_hypothesis()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="n_decoded_frames_in_buffer"><a href='../../flashlighttext/html/Decoder.html#method-Decoder-n_decoded_frames_in_buffer'><code>flashlighttext::Decoder$n_decoded_frames_in_buffer()</code></a></span></li>
<li><span class="pkg-link" data-pkg="flashlighttext" data-topic="Decoder" data-id="prune"><a href='../../flashlighttext/html/Decoder.html#method-Decoder-prune'><code>flashlighttext::Decoder$prune()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-LexiconFreeSeq2SeqDecoder-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LexiconFreeSeq2SeqDecoder$new(
  options,
  lm,
  eos_token_idx,
  emitting_model_update_func,
  max_output_length
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>options</code></dt>
<dd><p>an options</p></dd>


<dt><code>lm</code></dt>
<dd><p>a lm</p></dd>


<dt><code>eos_token_idx</code></dt>
<dd><p>an eos_token_idx</p></dd>


<dt><code>emitting_model_update_func</code></dt>
<dd><p>an emitting_model_update_func</p></dd>


<dt><code>max_output_length</code></dt>
<dd><p>a max_output_length</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>LexiconFreeSeq2SeqDecoder</p>
</div>

</div><p><hr>
<a id="method-LexiconFreeSeq2SeqDecoder-n_hypothesis"></a></p><div class='section' id='method-n-hypothesis-'>
<h3>Method <code>n_hypothesis()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LexiconFreeSeq2SeqDecoder$n_hypothesis()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>int</p>
</div>

</div><p><hr>
<a id="method-LexiconFreeSeq2SeqDecoder-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LexiconFreeSeq2SeqDecoder$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


LexiconFreeSeq2SeqDecoder: LexiconFreeSeq2SeqDecoder

Description

Arguments

Super class

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `n_hypothesis()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method n_hypothesis()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `n_hypothesis()`

Method `clone()`