Deployed 86ba9d6 with MkDocs version: 1.6.1

MalayAgr · Oct 12, 2024 · af67220 · af67220
1 parent 61c6784
commit af67220
Show file tree

Hide file tree

Showing 9 changed files with 1,529 additions and 17 deletions.
diff --git a/objects.inv b/objects.inv
diff --git a/reference/bookacle/chat/index.html b/reference/bookacle/chat/index.html
@@ -1233,7 +1233,7 @@ <h2 id="bookacle.chat.Chat" class="doc doc-heading">
           <tr class="doc-section-item">
             <td><code><span title="bookacle.chat.Chat.retriever">retriever</span></code></td>
             <td>
-                  <code><span title="bookacle.tree.retriever.RetrieverLike">RetrieverLike</span></code>
+                  <code><a class="autorefs autorefs-internal" title="bookacle.tree.retriever.RetrieverLike" href="../tree/retriever/#bookacle.tree.retriever.RetrieverLike">RetrieverLike</a></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -1304,7 +1304,7 @@ <h2 id="bookacle.chat.Chat" class="doc doc-heading">
           <tr class="doc-section-item">
             <td><code>retriever</code></td>
             <td>
-                  <code><span title="bookacle.tree.retriever.RetrieverLike">RetrieverLike</span></code>
+                  <code><a class="autorefs autorefs-internal" title="bookacle.tree.retriever.RetrieverLike" href="../tree/retriever/#bookacle.tree.retriever.RetrieverLike">RetrieverLike</a></code>
             </td>
             <td>
               <div class="doc-md-description">

diff --git a/reference/bookacle/loaders/index.html b/reference/bookacle/loaders/index.html
@@ -1420,9 +1420,8 @@ <h2 id="bookacle.loaders.LoaderManager" class="doc doc-heading">
 <p>It behaves like a dictionary, where each document loader is registered to a name.</p>
 
 
-<details class="example" open>
-  <summary>Example</summary>
-  <div class="language-python highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">bookacle.loaders</span> <span class="kn">import</span> <span class="n">LoaderManager</span><span class="p">,</span> <span class="n">register_loader</span>
+<p><span class="doc-section-title">Examples:</span></p>
+    <div class="language-python highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">bookacle.loaders</span> <span class="kn">import</span> <span class="n">LoaderManager</span><span class="p">,</span> <span class="n">register_loader</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="kn">from</span> <span class="nn">langchain_core.documents</span> <span class="kn">import</span> <span class="n">Document</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
 <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">manager</span> <span class="o">=</span> <span class="n">LoaderManager</span><span class="p">()</span>
@@ -1433,9 +1432,11 @@ <h2 id="bookacle.loaders.LoaderManager" class="doc doc-heading">
 <a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>
 <a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="nb">print</span><span class="p">(</span><span class="n">manager</span><span class="p">[</span><span class="s2">&quot;custom_loader&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="n">doc_loader</span><span class="p">)</span>
 </code></pre></div>
+<div class="result">
 <div class="language-python highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kc">True</span>
 </code></pre></div>
-</details>
+</div>
+
 
 
 

diff --git a/reference/bookacle/models/summarization/index.html b/reference/bookacle/models/summarization/index.html
@@ -1942,9 +1942,8 @@ <h3 id="bookacle.models.summarization.HuggingFaceLLMSummarizationModel.format_as
     </table>
 
 
-<details class="example" open>
-  <summary>Example</summary>
-  <div class="language-python highlight"><span class="filename">Single Text</span><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">bookacle.models.summarization</span> <span class="kn">import</span> <span class="n">HuggingFaceLLMSummarizationModel</span>
+<p><span class="doc-section-title">Examples:</span></p>
+    <div class="language-python highlight"><span class="filename">Single Text</span><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">bookacle.models.summarization</span> <span class="kn">import</span> <span class="n">HuggingFaceLLMSummarizationModel</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="n">model</span> <span class="o">=</span> <span class="n">HuggingFaceLLMSummarizationModel</span><span class="p">(</span><span class="n">model_name</span><span class="o">=</span><span class="s2">&quot;Qwen/Qwen2-0.5B-Instruct&quot;</span><span class="p">)</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="n">text</span> <span class="o">=</span> <span class="s2">&quot;This is a test&quot;</span>
 <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="nb">print</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">format_as_chat_message</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
@@ -1962,7 +1961,7 @@ <h3 id="bookacle.models.summarization.HuggingFaceLLMSummarizationModel.format_as
 <div class="language-python highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">[[{</span><span class="s1">&#39;role&#39;</span><span class="p">:</span> <span class="s1">&#39;user&#39;</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="s1">&#39;Summarize the following in not more than 100 words:</span><span class="se">\n</span><span class="s1">This is a test&#39;</span><span class="p">}],</span> <span class="p">[{</span><span class="s1">&#39;role&#39;</span><span class="p">:</span> <span class="s1">&#39;user&#39;</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="s1">&#39;Summarize the following in not more than 100 words:</span><span class="se">\n</span><span class="s1">This is another test&#39;</span><span class="p">}]]</span>
 </code></pre></div>
 </div>
-</details>
+
     </div>
 
 </div>

diff --git a/reference/bookacle/tree/builder/index.html b/reference/bookacle/tree/builder/index.html
@@ -1431,7 +1431,7 @@ <h2 id="bookacle.tree.builder.ClusterTreeBuilder" class="doc doc-heading">
           <tr class="doc-section-item">
             <td><code><span title="bookacle.tree.builder.ClusterTreeBuilder.config">config</span></code></td>
             <td>
-                  <code><span title="bookacle.tree.config.RaptorTreeConfig">RaptorTreeConfig</span></code>
+                  <code>RaptorTreeConfig</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -1458,7 +1458,7 @@ <h2 id="bookacle.tree.builder.ClusterTreeBuilder" class="doc doc-heading">
           <tr class="doc-section-item">
             <td><code>config</code></td>
             <td>
-                  <code><span title="bookacle.tree.config.RaptorTreeConfig">RaptorTreeConfig</span></code>
+                  <code><a class="autorefs autorefs-internal" title="bookacle.tree.config.ClusterTreeConfig" href="../config/#bookacle.tree.config.ClusterTreeConfig">ClusterTreeConfig</a></code>
             </td>
             <td>
               <div class="doc-md-description">

diff --git a/reference/bookacle/tree/clustering/index.html b/reference/bookacle/tree/clustering/index.html
@@ -1269,6 +1269,8 @@ <h1>Clustering</h1>
 <a id="bookacle.tree.clustering"></a>
     <div class="doc doc-contents first">
 
+        <p>Clustering module for the tree structure.</p>
+
 
 
   <div class="doc doc-children">
@@ -2329,7 +2331,7 @@ <h3 id="bookacle.tree.clustering.GMMClusteringBackend.cluster_locally" class="do
 <a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p">)</span>
 <a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="nb">print</span><span class="p">(</span><span class="n">clusters</span><span class="p">)</span>
 </code></pre></div>
-<div class="language-python highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">[</span><span class="n">array</span><span class="p">([</span><span class="mi">66</span><span class="p">,</span> <span class="mi">33</span><span class="p">,</span> <span class="mi">40</span><span class="p">,</span> <span class="mi">14</span><span class="p">,</span> <span class="mi">40</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">38</span><span class="p">,</span> <span class="mi">88</span><span class="p">,</span> <span class="mi">64</span><span class="p">,</span> <span class="mi">97</span><span class="p">,</span> <span class="mi">46</span><span class="p">,</span> <span class="mi">53</span><span class="p">,</span> <span class="mi">25</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">79</span><span class="p">,</span> <span class="mi">61</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">29</span><span class="p">,</span> <span class="mi">82</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">85</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">70</span><span class="p">,</span> <span class="mi">68</span><span class="p">,</span> <span class="mi">73</span><span class="p">,</span> <span class="mi">18</span><span class="p">,</span> <span class="mi">36</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">11</span><span class="p">,</span> <span class="mi">62</span><span class="p">,</span>  <span class="mi">1</span><span class="p">,</span> <span class="mi">39</span><span class="p">])]</span>
+<div class="language-python highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">[</span><span class="n">array</span><span class="p">([</span><span class="mi">55</span><span class="p">,</span> <span class="mi">65</span><span class="p">,</span> <span class="mi">55</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">68</span><span class="p">,</span> <span class="mi">61</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">75</span><span class="p">,</span> <span class="mi">75</span><span class="p">,</span> <span class="mi">96</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">46</span><span class="p">,</span> <span class="mi">84</span><span class="p">,</span> <span class="mi">84</span><span class="p">,</span> <span class="mi">94</span><span class="p">,</span> <span class="mi">84</span><span class="p">,</span> <span class="mi">86</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">33</span><span class="p">,</span> <span class="mi">64</span><span class="p">,</span> <span class="mi">88</span><span class="p">,</span> <span class="mi">16</span><span class="p">,</span> <span class="mi">66</span><span class="p">,</span> <span class="mi">69</span><span class="p">]),</span> <span class="n">array</span><span class="p">([</span><span class="mi">51</span><span class="p">,</span> <span class="mi">51</span><span class="p">,</span> <span class="mi">77</span><span class="p">,</span> <span class="mi">37</span><span class="p">,</span> <span class="mi">83</span><span class="p">,</span> <span class="mi">21</span><span class="p">,</span> <span class="mi">93</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">47</span><span class="p">])]</span>
 </code></pre></div>
 
     </div>
@@ -2426,16 +2428,18 @@ <h3 id="bookacle.tree.clustering.GMMClusteringBackend.cluster" class="doc doc-he
 
 
 <p><span class="doc-section-title">Examples:</span></p>
-    <p><div class="language-python highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+    <div class="language-python highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="kn">from</span> <span class="nn">bookacle.tree.clustering</span> <span class="kn">import</span> <span class="n">GMMClusteringBackend</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
 <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">backend</span> <span class="o">=</span> <span class="n">GMMClusteringBackend</span><span class="p">(</span><span class="n">reduction_dim</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">n_clusters_global</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
 <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="n">embeddings</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">768</span><span class="p">)</span>
 <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="n">emb_to_clusters</span><span class="p">,</span> <span class="n">clusters_to_emb</span> <span class="o">=</span> <span class="n">backend</span><span class="o">.</span><span class="n">cluster</span><span class="p">(</span><span class="n">embeddings</span><span class="o">=</span><span class="n">embeddings</span><span class="p">)</span>
 <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="nb">print</span><span class="p">(</span><span class="n">clusters_to_emb</span><span class="p">)</span>
 </code></pre></div>
-<div class="language-python highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">defaultdict</span><span class="p">(</span><span class="o">&lt;</span><span class="k">class</span> <span class="err">&#39;</span><span class="nc">list</span><span class="s1">&#39;&gt;, {0: [0, 3, 5, 6], 1: [2, 8, 9], 2: [1, 4, 7]})</span>
-</code></pre></div></p>
+<div class="result">
+<div class="language-python highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">defaultdict</span><span class="p">(</span><span class="o">&lt;</span><span class="k">class</span> <span class="err">&#39;</span><span class="nc">list</span><span class="s1">&#39;&gt;, {0: [1, 2, 3, 7, 8], 1: [4, 5, 6], 2: [0, 9]})</span>
+</code></pre></div>
+</div>
 
     </div>