LMState

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

LMState function

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>ptr</code></dt>
<dd><p>get or set a pointer to a LMStateWrapper.</p></dd><p></p><p>
<dt><code>children</code></dt>
<dd><p>a list of pairs (index, LMStatePtr)</p></dd></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/LMState%24new()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LMState$new()"><code>LMState$new()</code></a></p></li>
<li><p><a href="/link/LMState%24child()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LMState$child()"><code>LMState$child()</code></a></p></li>
<li><p><a href="/link/LMState%24compare()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LMState$compare()"><code>LMState$compare()</code></a></p></li>
<li><p><a href="/link/LMState%24clone()?package=flashlighttext&version=0.1.0" data-mini-rdoc="flashlighttext::LMState$clone()"><code>LMState$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-LMState-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>LMState$new()</code></pre><p></p></div></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>An instance of the LMState class.</p>
</div></p><p></p><p><hr>
<a id="method-LMState-child"></a></p><div class="section" id="method-child-">
<h3>Method <code>child()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LMState$child(usr_index)</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>usr_index</code></dt>
<dd><p>a usr_index</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>externalpointer to a LMStateWrapper</p>
</div><p></p><p></p><p><hr>
<a id="method-LMState-compare"></a></p><div class="section" id="method-compare-">
<h3>Method <code>compare()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>LMState$compare(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 externalpointer to a LMState to compare with.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>int</p>
</div><p></p><p></p><p><hr>
<a id="method-LMState-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>LMState$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

LMState — LMState

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


<dt><code>children</code></dt>
<dd><p>a list of pairs (index, LMStatePtr)</p></dd>


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


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

<ul>
<li><p><a href='#method-LMState-new'><code>LMState$new()</code></a></p></li>
<li><p><a href='#method-LMState-child'><code>LMState$child()</code></a></p></li>
<li><p><a href='#method-LMState-compare'><code>LMState$compare()</code></a></p></li>
<li><p><a href='#method-LMState-clone'><code>LMState$clone()</code></a></p></li>
</ul>

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

<div class='section' id='returns'>
<h4>Returns</h4>
<p>An instance of the LMState class.</p>
</div>

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

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

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


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>externalpointer to a LMStateWrapper</p>
</div>

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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>LMState$compare(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 externalpointer to a LMState to compare with.</p></dd>


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

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


LMState: LMState

Description

Arguments

Active bindings

Methods

Public methods

Method `new()`

Usage

Returns

Method `child()`

Usage

Arguments

Returns

Method `compare()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Active bindings

Methods

Public methods

Method new()

Usage

Returns

Method child()

Usage

Arguments

Returns

Method compare()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `child()`

Method `compare()`

Method `clone()`