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

LM function

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>ptr</code></dt>
<dd><p>get or set a pointer to a (*)LMWrapper.</p></dd><p></p><p>
</p></dl><p></p>

Active bindings


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/LM%24new()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LM$new()"><code>LM$new()</code></a></p></li>
<li><p><a href="/link/LM%24start()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LM$start()"><code>LM$start()</code></a></p></li>
<li><p><a href="/link/LM%24score()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LM$score()"><code>LM$score()</code></a></p></li>
<li><p><a href="/link/LM%24finish()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LM$finish()"><code>LM$finish()</code></a></p></li>
<li><p><a href="/link/LM%24clone()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LM$clone()"><code>LM$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-LM-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>LM$new()</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>NULL</p>
</div></p><p></p><p><hr>
<a id="method-LM-start"></a></p><div class="section" id="method-start-">
<h3>Method <code><a href="/link/start()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::start()">start()</a></code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LM$start(startWithNothing)</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>startWithNothing</code></dt>
<dd><p>a logical value indicating whether the state 
should be initialized with a start-of-sequence marker.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>An LMState object representing the current state.</p>
</div><p></p><p></p><p><hr>
<a id="method-LM-score"></a></p><div class="section" id="method-score-">
<h3>Method <code>score()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LM$score(state, usrTokenIdx)</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>state</code></dt>
<dd><p>An LMState object representing the current state.</p></dd></dl></div></p><p>
<dt><code>usrTokenIdx</code></dt>
<dd><p>An integer representing the index of the current token 
in the user-defined token list.</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A list containing the externalpointer to the updated LMState object
and a numeric value representing the score.</p>
</div><p></p><p></p><p><hr>
<a id="method-LM-finish"></a></p><div class="section" id="method-finish-">
<h3>Method <code>finish()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LM$finish(state)</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>state</code></dt>
<dd><p>An LMState object representing the current state.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A list containing the updated LMState object and a numeric value 
representing the final score.</p>
</div><p></p><p></p><p><hr>
<a id="method-LM-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>LM$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

LM — LM

<p><div class="r6-active-bindings"></p><dl>
<dt><code>ptr</code></dt>
<dd><p>get or set a pointer to a (*)LMWrapper.</p></dd>


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


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

<ul>
<li><p><a href='#method-LM-new'><code>LM$new()</code></a></p></li>
<li><p><a href='#method-LM-start'><code>LM$start()</code></a></p></li>
<li><p><a href='#method-LM-score'><code>LM$score()</code></a></p></li>
<li><p><a href='#method-LM-finish'><code>LM$finish()</code></a></p></li>
<li><p><a href='#method-LM-clone'><code>LM$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-LM-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>LM$new()</code></pre><p></div></p>
</div>

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

</div><p><hr>
<a id="method-LM-start"></a></p><div class='section' id='method-start-'>
<h3>Method <code><a href='https://rdrr.io/r/stats/start.html'>start()</a></code></h3>

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

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>startWithNothing</code></dt>
<dd><p>a logical value indicating whether the state 
should be initialized with a start-of-sequence marker.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>An LMState object representing the current state.</p>
</div>

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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LM$score(state, usrTokenIdx)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>state</code></dt>
<dd><p>An LMState object representing the current state.</p></dd>


<dt><code>usrTokenIdx</code></dt>
<dd><p>An integer representing the index of the current token 
in the user-defined token list.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A list containing the externalpointer to the updated LMState object
and a numeric value representing the score.</p>
</div>

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

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

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>state</code></dt>
<dd><p>An LMState object representing the current state.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A list containing the updated LMState object and a numeric value 
representing the final score.</p>
</div>

</div><p><hr>
<a id="method-LM-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>LM$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>


LM: LM

Description

Arguments

Active bindings

Methods

Public methods

Method `new()`

Usage

Returns

Method `start()`

Usage

Arguments

Returns

Method `score()`

Usage

Arguments

Returns

Method `finish()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Active bindings

Methods

Public methods

Method new()

Usage

Returns

Method start()

Usage

Arguments

Returns

Method score()

Usage

Arguments

Returns

Method finish()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `start()`

Method `score()`

Method `finish()`

Method `clone()`