Deployed a032595 with MkDocs version: 1.6.0

index.html

@@ -1549,7 +1549,7 @@ <h2 id="running">Running<a class="headerlink" href="#running" title="Permanent l
 <p>Individual keywords can be overridden as well:
 <div class="language-sh highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>python<span class="w"> </span>processing<span class="w"> </span>-cp<span class="w"> </span>configs/paper<span class="w"> </span>-cn<span class="w"> </span>processing-asqa-retrieval<span class="w">   </span><span class="se">\</span>
 </span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w">       </span><span class="nv">output_path</span><span class="o">=</span>/store/data/here<span class="w">                                 </span><span class="se">\</span>
-</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w">       </span><span class="nv">hfhub_tag</span><span class="o">=</span>my_org/my_data
+</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w">       </span><span class="nv">cache</span><span class="o">=</span><span class="nb">true</span>
 </span></code></pre></div></p>
 <p>For a complete set of configurations, <strong>reproducing the experimentation in the paper with the ASQA dataset</strong>, see the
 configurations in the <a href="./configs/paper">Paper</a> folder.</p>

reference/processing/global_steps/output/index.html

@@ -1212,6 +1212,30 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#ragfoundry.processing.global_steps.output.HFHubOutput" class="md-nav__link">
+    <span class="md-ellipsis">
+      HFHubOutput
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="HFHubOutput">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#ragfoundry.processing.global_steps.output.HFHubOutput.__init__" class="md-nav__link">
+    <span class="md-ellipsis">
+      __init__
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -1522,6 +1546,30 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#ragfoundry.processing.global_steps.output.HFHubOutput" class="md-nav__link">
+    <span class="md-ellipsis">
+      HFHubOutput
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="HFHubOutput">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#ragfoundry.processing.global_steps.output.HFHubOutput.__init__" class="md-nav__link">
+    <span class="md-ellipsis">
+      __init__
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -1583,6 +1631,84 @@ <h1>Output</h1>
 
 
 
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="ragfoundry.processing.global_steps.output.HFHubOutput" class="doc doc-heading">
+            <code>HFHubOutput</code>
+
+
+<a href="#ragfoundry.processing.global_steps.output.HFHubOutput" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+    <div class="doc doc-contents ">
+            <p class="doc doc-class-bases">
+              Bases: <code><a class="autorefs autorefs-internal" title="ragfoundry.processing.step.GlobalStep" href="../../step/#ragfoundry.processing.step.GlobalStep">GlobalStep</a></code></p>
+
+
+      <p>Simple class to output the dataset to Hugging Face Hub.</p>
+
+
+
+
+  <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+<div class="doc doc-object doc-function">
+
+
+<h3 id="ragfoundry.processing.global_steps.output.HFHubOutput.__init__" class="doc doc-heading">
+            <code class="highlight language-python"><span class="fm">__init__</span><span class="p">(</span><span class="n">hfhub_tag</span><span class="p">,</span> <span class="n">private</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
+
+<a href="#ragfoundry.processing.global_steps.output.HFHubOutput.__init__" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+
+
+<p><span class="doc-section-title">Parameters:</span></p>
+    <ul>
+        <li class="doc-section-item field-body">
+          <b><code>hfhub_tag</code></b>
+              (<code>str</code>)
+          –
+          <div class="doc-md-description">
+            <p>Tag for the Hugging Face Hub.</p>
+          </div>
+        </li>
+        <li class="doc-section-item field-body">
+          <b><code>private</code></b>
+              (<code>bool</code>, default:
+                  <code>True</code>
+)
+          –
+          <div class="doc-md-description">
+            <p>Whether the dataset should be private or not. Default is True.</p>
+          </div>
+        </li>
+    </ul>
+
+    </div>
+
+</div>
+
+
+
+  </div>
+
+    </div>
+
+</div>
+
 <div class="doc doc-object doc-class">