Skip to content

Commit 2d51ad6

Browse files
abetlenabetlen
committed
Deployed ea41474 with MkDocs version: 1.4.2
1 parent b614fd4 commit 2d51ad6

File tree

2 files changed

+324
-0
lines changed

2 files changed

+324
-0
lines changed

‎index.html

Lines changed: 324 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,27 @@
251251
__call__()
252252
</a>
253253

254+
</li>
255+
256+
<li class="md-nav__item">
257+
<a href="#llama_cpp.llama.Llama.embed" class="md-nav__link">
258+
embed()
259+
</a>
260+
261+
</li>
262+
263+
<li class="md-nav__item">
264+
<a href="#llama_cpp.llama.Llama.tokenize" class="md-nav__link">
265+
tokenize()
266+
</a>
267+
268+
</li>
269+
270+
<li class="md-nav__item">
271+
<a href="#llama_cpp.llama.Llama.detokenize" class="md-nav__link">
272+
detokenize()
273+
</a>
274+
254275
</li>
255276

256277
</ul>
@@ -529,6 +550,27 @@
529550
__call__()
530551
</a>
531552

553+
</li>
554+
555+
<li class="md-nav__item">
556+
<a href="#llama_cpp.llama.Llama.embed" class="md-nav__link">
557+
embed()
558+
</a>
559+
560+
</li>
561+
562+
<li class="md-nav__item">
563+
<a href="#llama_cpp.llama.Llama.tokenize" class="md-nav__link">
564+
tokenize()
565+
</a>
566+
567+
</li>
568+
569+
<li class="md-nav__item">
570+
<a href="#llama_cpp.llama.Llama.detokenize" class="md-nav__link">
571+
detokenize()
572+
</a>
573+
532574
</li>
533575

534576
</ul>
@@ -2069,6 +2111,288 @@ <h3 id="llama_cpp.llama.Llama.__call__" class="doc doc-heading">
20692111

20702112
</div>
20712113

2114+
<div class="doc doc-object doc-function">
2115+
2116+
2117+
2118+
<h3 id="llama_cpp.llama.Llama.embed" class="doc doc-heading">
2119+
<code class="highlight language-python"><span class="n">embed</span><span class="p">(</span><span class="n">text</span><span class="p">)</span></code>
2120+
2121+
</h3>
2122+
2123+
2124+
<div class="doc doc-contents ">
2125+
2126+
<p>Embed a string.</p>
2127+
2128+
<p><strong>Parameters:</strong></p>
2129+
<table>
2130+
<thead>
2131+
<tr>
2132+
<th>Name</th>
2133+
<th>Type</th>
2134+
<th>Description</th>
2135+
<th>Default</th>
2136+
</tr>
2137+
</thead>
2138+
<tbody>
2139+
<tr>
2140+
<td><code>text</code></td>
2141+
<td>
2142+
<code>str</code>
2143+
</td>
2144+
<td><p>The utf-8 encoded string to embed.</p></td>
2145+
<td>
2146+
<em>required</em>
2147+
</td>
2148+
</tr>
2149+
</tbody>
2150+
</table>
2151+
2152+
<p><strong>Returns:</strong></p>
2153+
<table>
2154+
<thead>
2155+
<tr>
2156+
<th>Type</th>
2157+
<th>Description</th>
2158+
</tr>
2159+
</thead>
2160+
<tbody>
2161+
<tr>
2162+
<td>
2163+
</td>
2164+
<td><p>A list of embeddings.</p></td>
2165+
</tr>
2166+
</tbody>
2167+
</table>
2168+
2169+
<details class="quote">
2170+
<summary>Source code in <code>llama_cpp/llama.py</code></summary>
2171+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-108">108</a></span>
2172+
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
2173+
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
2174+
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
2175+
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
2176+
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
2177+
<span class="normal"><a href="#__codelineno-0-114">114</a></span>
2178+
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
2179+
<span class="normal"><a href="#__codelineno-0-116">116</a></span>
2180+
<span class="normal"><a href="#__codelineno-0-117">117</a></span>
2181+
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
2182+
<span class="normal"><a href="#__codelineno-0-119">119</a></span>
2183+
<span class="normal"><a href="#__codelineno-0-120">120</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-108"><a id="__codelineno-0-108" name="__codelineno-0-108"></a><span class="k">def</span> <span class="nf">embed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
2184+
</span><span id="__span-0-109"><a id="__codelineno-0-109" name="__codelineno-0-109"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Embed a string.</span>
2185+
</span><span id="__span-0-110"><a id="__codelineno-0-110" name="__codelineno-0-110"></a>
2186+
</span><span id="__span-0-111"><a id="__codelineno-0-111" name="__codelineno-0-111"></a><span class="sd"> Args:</span>
2187+
</span><span id="__span-0-112"><a id="__codelineno-0-112" name="__codelineno-0-112"></a><span class="sd"> text: The utf-8 encoded string to embed.</span>
2188+
</span><span id="__span-0-113"><a id="__codelineno-0-113" name="__codelineno-0-113"></a>
2189+
</span><span id="__span-0-114"><a id="__codelineno-0-114" name="__codelineno-0-114"></a><span class="sd"> Returns:</span>
2190+
</span><span id="__span-0-115"><a id="__codelineno-0-115" name="__codelineno-0-115"></a><span class="sd"> A list of embeddings.</span>
2191+
</span><span id="__span-0-116"><a id="__codelineno-0-116" name="__codelineno-0-116"></a><span class="sd"> &quot;&quot;&quot;</span>
2192+
</span><span id="__span-0-117"><a id="__codelineno-0-117" name="__codelineno-0-117"></a> <span class="n">tokens</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tokenize</span><span class="p">(</span><span class="n">text</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span>
2193+
</span><span id="__span-0-118"><a id="__codelineno-0-118" name="__codelineno-0-118"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_eval</span><span class="p">(</span><span class="n">tokens</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
2194+
</span><span id="__span-0-119"><a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="n">embeddings</span> <span class="o">=</span> <span class="n">llama_cpp</span><span class="o">.</span><span class="n">llama_get_embeddings</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="p">)</span>
2195+
</span><span id="__span-0-120"><a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="k">return</span> <span class="n">embeddings</span><span class="p">[:</span><span class="n">llama_cpp</span><span class="o">.</span><span class="n">llama_n_embd</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="p">)]</span>
2196+
</span></code></pre></div></td></tr></table></div>
2197+
</details>
2198+
</div>
2199+
2200+
</div>
2201+
2202+
<div class="doc doc-object doc-function">
2203+
2204+
2205+
2206+
<h3 id="llama_cpp.llama.Llama.tokenize" class="doc doc-heading">
2207+
<code class="highlight language-python"><span class="n">tokenize</span><span class="p">(</span><span class="n">text</span><span class="p">)</span></code>
2208+
2209+
</h3>
2210+
2211+
2212+
<div class="doc doc-contents ">
2213+
2214+
<p>Tokenize a string.</p>
2215+
2216+
<p><strong>Parameters:</strong></p>
2217+
<table>
2218+
<thead>
2219+
<tr>
2220+
<th>Name</th>
2221+
<th>Type</th>
2222+
<th>Description</th>
2223+
<th>Default</th>
2224+
</tr>
2225+
</thead>
2226+
<tbody>
2227+
<tr>
2228+
<td><code>text</code></td>
2229+
<td>
2230+
<code>bytes</code>
2231+
</td>
2232+
<td><p>The utf-8 encoded string to tokenize.</p></td>
2233+
<td>
2234+
<em>required</em>
2235+
</td>
2236+
</tr>
2237+
</tbody>
2238+
</table>
2239+
2240+
<p><strong>Returns:</strong></p>
2241+
<table>
2242+
<thead>
2243+
<tr>
2244+
<th>Type</th>
2245+
<th>Description</th>
2246+
</tr>
2247+
</thead>
2248+
<tbody>
2249+
<tr>
2250+
<td>
2251+
<code><span title="typing.List">List</span>[int]</code>
2252+
</td>
2253+
<td><p>A list of tokens.</p></td>
2254+
</tr>
2255+
</tbody>
2256+
</table>
2257+
2258+
<details class="quote">
2259+
<summary>Source code in <code>llama_cpp/llama.py</code></summary>
2260+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-72">72</a></span>
2261+
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
2262+
<span class="normal"><a href="#__codelineno-0-74">74</a></span>
2263+
<span class="normal"><a href="#__codelineno-0-75">75</a></span>
2264+
<span class="normal"><a href="#__codelineno-0-76">76</a></span>
2265+
<span class="normal"><a href="#__codelineno-0-77">77</a></span>
2266+
<span class="normal"><a href="#__codelineno-0-78">78</a></span>
2267+
<span class="normal"><a href="#__codelineno-0-79">79</a></span>
2268+
<span class="normal"><a href="#__codelineno-0-80">80</a></span>
2269+
<span class="normal"><a href="#__codelineno-0-81">81</a></span>
2270+
<span class="normal"><a href="#__codelineno-0-82">82</a></span>
2271+
<span class="normal"><a href="#__codelineno-0-83">83</a></span>
2272+
<span class="normal"><a href="#__codelineno-0-84">84</a></span>
2273+
<span class="normal"><a href="#__codelineno-0-85">85</a></span>
2274+
<span class="normal"><a href="#__codelineno-0-86">86</a></span>
2275+
<span class="normal"><a href="#__codelineno-0-87">87</a></span>
2276+
<span class="normal"><a href="#__codelineno-0-88">88</a></span>
2277+
<span class="normal"><a href="#__codelineno-0-89">89</a></span>
2278+
<span class="normal"><a href="#__codelineno-0-90">90</a></span>
2279+
<span class="normal"><a href="#__codelineno-0-91">91</a></span>
2280+
<span class="normal"><a href="#__codelineno-0-92">92</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-72"><a id="__codelineno-0-72" name="__codelineno-0-72"></a><span class="k">def</span> <span class="nf">tokenize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
2281+
</span><span id="__span-0-73"><a id="__codelineno-0-73" name="__codelineno-0-73"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Tokenize a string.</span>
2282+
</span><span id="__span-0-74"><a id="__codelineno-0-74" name="__codelineno-0-74"></a>
2283+
</span><span id="__span-0-75"><a id="__codelineno-0-75" name="__codelineno-0-75"></a><span class="sd"> Args:</span>
2284+
</span><span id="__span-0-76"><a id="__codelineno-0-76" name="__codelineno-0-76"></a><span class="sd"> text: The utf-8 encoded string to tokenize.</span>
2285+
</span><span id="__span-0-77"><a id="__codelineno-0-77" name="__codelineno-0-77"></a>
2286+
</span><span id="__span-0-78"><a id="__codelineno-0-78" name="__codelineno-0-78"></a><span class="sd"> Returns:</span>
2287+
</span><span id="__span-0-79"><a id="__codelineno-0-79" name="__codelineno-0-79"></a><span class="sd"> A list of tokens.</span>
2288+
</span><span id="__span-0-80"><a id="__codelineno-0-80" name="__codelineno-0-80"></a><span class="sd"> &quot;&quot;&quot;</span>
2289+
</span><span id="__span-0-81"><a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="n">n_ctx</span> <span class="o">=</span> <span class="n">llama_cpp</span><span class="o">.</span><span class="n">llama_n_ctx</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="p">)</span>
2290+
</span><span id="__span-0-82"><a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="n">tokens</span> <span class="o">=</span> <span class="p">(</span><span class="n">llama_cpp</span><span class="o">.</span><span class="n">llama_token</span> <span class="o">*</span> <span class="n">n_ctx</span><span class="p">)()</span>
2291+
</span><span id="__span-0-83"><a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="n">n_tokens</span> <span class="o">=</span> <span class="n">llama_cpp</span><span class="o">.</span><span class="n">llama_tokenize</span><span class="p">(</span>
2292+
</span><span id="__span-0-84"><a id="__codelineno-0-84" name="__codelineno-0-84"></a> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="p">,</span>
2293+
</span><span id="__span-0-85"><a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="n">text</span><span class="p">,</span>
2294+
</span><span id="__span-0-86"><a id="__codelineno-0-86" name="__codelineno-0-86"></a> <span class="n">tokens</span><span class="p">,</span>
2295+
</span><span id="__span-0-87"><a id="__codelineno-0-87" name="__codelineno-0-87"></a> <span class="n">n_ctx</span><span class="p">,</span>
2296+
</span><span id="__span-0-88"><a id="__codelineno-0-88" name="__codelineno-0-88"></a> <span class="kc">True</span><span class="p">,</span>
2297+
</span><span id="__span-0-89"><a id="__codelineno-0-89" name="__codelineno-0-89"></a> <span class="p">)</span>
2298+
</span><span id="__span-0-90"><a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="k">if</span> <span class="n">n_tokens</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
2299+
</span><span id="__span-0-91"><a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Failed to tokenize: text=&quot;</span><span class="si">{</span><span class="n">text</span><span class="si">}</span><span class="s1">&quot; n_tokens=</span><span class="si">{</span><span class="n">n_tokens</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
2300+
</span><span id="__span-0-92"><a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">tokens</span><span class="p">[:</span><span class="n">n_tokens</span><span class="p">])</span>
2301+
</span></code></pre></div></td></tr></table></div>
2302+
</details>
2303+
</div>
2304+
2305+
</div>
2306+
2307+
<div class="doc doc-object doc-function">
2308+
2309+
2310+
2311+
<h3 id="llama_cpp.llama.Llama.detokenize" class="doc doc-heading">
2312+
<code class="highlight language-python"><span class="n">detokenize</span><span class="p">(</span><span class="n">tokens</span><span class="p">)</span></code>
2313+
2314+
</h3>
2315+
2316+
2317+
<div class="doc doc-contents ">
2318+
2319+
<p>Detokenize a list of tokens.</p>
2320+
2321+
<p><strong>Parameters:</strong></p>
2322+
<table>
2323+
<thead>
2324+
<tr>
2325+
<th>Name</th>
2326+
<th>Type</th>
2327+
<th>Description</th>
2328+
<th>Default</th>
2329+
</tr>
2330+
</thead>
2331+
<tbody>
2332+
<tr>
2333+
<td><code>tokens</code></td>
2334+
<td>
2335+
<code><span title="typing.List">List</span>[int]</code>
2336+
</td>
2337+
<td><p>The list of tokens to detokenize.</p></td>
2338+
<td>
2339+
<em>required</em>
2340+
</td>
2341+
</tr>
2342+
</tbody>
2343+
</table>
2344+
2345+
<p><strong>Returns:</strong></p>
2346+
<table>
2347+
<thead>
2348+
<tr>
2349+
<th>Type</th>
2350+
<th>Description</th>
2351+
</tr>
2352+
</thead>
2353+
<tbody>
2354+
<tr>
2355+
<td>
2356+
<code>bytes</code>
2357+
</td>
2358+
<td><p>The detokenized string.</p></td>
2359+
</tr>
2360+
</tbody>
2361+
</table>
2362+
2363+
<details class="quote">
2364+
<summary>Source code in <code>llama_cpp/llama.py</code></summary>
2365+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
2366+
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
2367+
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
2368+
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
2369+
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
2370+
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
2371+
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
2372+
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
2373+
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
2374+
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
2375+
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
2376+
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
2377+
<span class="normal"><a href="#__codelineno-0-106">106</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-94"><a id="__codelineno-0-94" name="__codelineno-0-94"></a><span class="k">def</span> <span class="nf">detokenize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tokens</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">int</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
2378+
</span><span id="__span-0-95"><a id="__codelineno-0-95" name="__codelineno-0-95"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Detokenize a list of tokens.</span>
2379+
</span><span id="__span-0-96"><a id="__codelineno-0-96" name="__codelineno-0-96"></a>
2380+
</span><span id="__span-0-97"><a id="__codelineno-0-97" name="__codelineno-0-97"></a><span class="sd"> Args:</span>
2381+
</span><span id="__span-0-98"><a id="__codelineno-0-98" name="__codelineno-0-98"></a><span class="sd"> tokens: The list of tokens to detokenize.</span>
2382+
</span><span id="__span-0-99"><a id="__codelineno-0-99" name="__codelineno-0-99"></a>
2383+
</span><span id="__span-0-100"><a id="__codelineno-0-100" name="__codelineno-0-100"></a><span class="sd"> Returns:</span>
2384+
</span><span id="__span-0-101"><a id="__codelineno-0-101" name="__codelineno-0-101"></a><span class="sd"> The detokenized string.</span>
2385+
</span><span id="__span-0-102"><a id="__codelineno-0-102" name="__codelineno-0-102"></a><span class="sd"> &quot;&quot;&quot;</span>
2386+
</span><span id="__span-0-103"><a id="__codelineno-0-103" name="__codelineno-0-103"></a> <span class="n">output</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">&quot;&quot;</span>
2387+
</span><span id="__span-0-104"><a id="__codelineno-0-104" name="__codelineno-0-104"></a> <span class="k">for</span> <span class="n">token</span> <span class="ow">in</span> <span class="n">tokens</span><span class="p">:</span>
2388+
</span><span id="__span-0-105"><a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="n">output</span> <span class="o">+=</span> <span class="n">llama_cpp</span><span class="o">.</span><span class="n">llama_token_to_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="p">,</span> <span class="n">token</span><span class="p">)</span>
2389+
</span><span id="__span-0-106"><a id="__codelineno-0-106" name="__codelineno-0-106"></a> <span class="k">return</span> <span class="n">output</span>
2390+
</span></code></pre></div></td></tr></table></div>
2391+
</details>
2392+
</div>
2393+
2394+
</div>
2395+
20722396

20732397

20742398
</div>

‎sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy