deploy: e938b29

Author: jackye1995

.doctrees/all-modules.doctree

@@ -2927,14 +2927,19 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="lance.LanceDataset.prewarm_index">
-<span class="sig-name descname"><span class="pre">prewarm_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lance.LanceDataset.prewarm_index" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">prewarm_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_position</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lance.LanceDataset.prewarm_index" title="Link to this definition"></a></dt>
 <dd><p>Prewarm an index</p>
 <p>This will load the entire index into memory.  This can help avoid cold start
 issues with index queries.  If the index does not fit in the index cache, then
 this will result in wasted I/O.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The name of the index to prewarm.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The name of the index to prewarm.</p></li>
+<li><p><strong>with_position</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a><em>, </em><em>default False</em>) – This is only supported for <code class="docutils literal notranslate"><span class="pre">INVERTED</span></code> indices. If True, positions are
+also loaded into the cache during prewarm so phrase queries do not need a
+separate lazy positions read.</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>
@@ -7900,14 +7905,19 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="lance.dataset.LanceDataset.prewarm_index">
-<span class="sig-name descname"><span class="pre">prewarm_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lance.dataset.LanceDataset.prewarm_index" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">prewarm_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_position</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lance.dataset.LanceDataset.prewarm_index" title="Link to this definition"></a></dt>
 <dd><p>Prewarm an index</p>
 <p>This will load the entire index into memory.  This can help avoid cold start
 issues with index queries.  If the index does not fit in the index cache, then
 this will result in wasted I/O.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The name of the index to prewarm.</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The name of the index to prewarm.</p></li>
+<li><p><strong>with_position</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a><em>, </em><em>default False</em>) – This is only supported for <code class="docutils literal notranslate"><span class="pre">INVERTED</span></code> indices. If True, positions are
+also loaded into the cache during prewarm so phrase queries do not need a
+separate lazy positions read.</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>

.doctrees/environment.pickle

@@ -1,9 +1,9 @@
 {
-    "all-modules": 6.178,
-    "basic-io": 0.39,
-    "data-evolution": 0.022,
+    "all-modules": 5.39,
+    "basic-io": 0.124,
+    "data-evolution": 0.02,
     "dataset": 0.031,
     "index": 0.002,
-    "index-and-search": 0.143,
+    "index-and-search": 0.136,
     "random-access": 0.021
 }