Updated docs to reflect changes

centre-for-humanities-computing · Aug 22, 2023 · 16d0f3f · 16d0f3f
1 parent 599a71e
commit 16d0f3f
Show file tree

Hide file tree

Showing 8 changed files with 6 additions and 178 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/setfit.doctree b/docs/_build/doctrees/setfit.doctree
diff --git a/docs/_build/html/_sources/setfit.rst.txt b/docs/_build/html/_sources/setfit.rst.txt
@@ -15,7 +15,7 @@ Since this requires the setfit package we recommend you install stormtrooper wit
 
 .. code-block:: python
 
-   from stormtrooper.setfit import SetFitZeroShotClassifier, SetFitFewShotClassifier
+   from stormtrooper import SetFitZeroShotClassifier, SetFitFewShotClassifier
 
    sample_text = "It is the Electoral College's responsibility to elect the president."
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -219,10 +219,6 @@ <h2>C</h2>
 
         <ul>
           <li><a href="generative.html#stormtrooper.GenerativeZeroShotClassifier.classes_">(stormtrooper.GenerativeZeroShotClassifier attribute)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitFewShotClassifier.classes_">(stormtrooper.setfit.SetFitFewShotClassifier attribute)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitZeroShotClassifier.classes_">(stormtrooper.setfit.SetFitZeroShotClassifier attribute)</a>
 </li>
           <li><a href="text2text.html#stormtrooper.Text2TextFewShotClassifier.classes_">(stormtrooper.Text2TextFewShotClassifier attribute)</a>
 </li>
@@ -257,10 +253,6 @@ <h2>F</h2>
 
         <ul>
           <li><a href="generative.html#stormtrooper.GenerativeZeroShotClassifier.fit">(stormtrooper.GenerativeZeroShotClassifier method)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitFewShotClassifier.fit">(stormtrooper.setfit.SetFitFewShotClassifier method)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitZeroShotClassifier.fit">(stormtrooper.setfit.SetFitZeroShotClassifier method)</a>
 </li>
           <li><a href="text2text.html#stormtrooper.Text2TextFewShotClassifier.fit">(stormtrooper.Text2TextFewShotClassifier method)</a>
 </li>
@@ -301,8 +293,6 @@ <h2>P</h2>
 
         <ul>
           <li><a href="generative.html#stormtrooper.GenerativeZeroShotClassifier.partial_fit">(stormtrooper.GenerativeZeroShotClassifier method)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitZeroShotClassifier.partial_fit">(stormtrooper.setfit.SetFitZeroShotClassifier method)</a>
 </li>
           <li><a href="text2text.html#stormtrooper.Text2TextFewShotClassifier.partial_fit">(stormtrooper.Text2TextFewShotClassifier method)</a>
 </li>
@@ -311,14 +301,12 @@ <h2>P</h2>
           <li><a href="zeroshot.html#stormtrooper.ZeroShotClassifier.partial_fit">(stormtrooper.ZeroShotClassifier method)</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="generative.html#stormtrooper.GenerativeFewShotClassifier.predict">predict() (stormtrooper.GenerativeFewShotClassifier method)</a>
 
         <ul>
           <li><a href="generative.html#stormtrooper.GenerativeZeroShotClassifier.predict">(stormtrooper.GenerativeZeroShotClassifier method)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitFewShotClassifier.predict">(stormtrooper.setfit.SetFitFewShotClassifier method)</a>
-</li>
-          <li><a href="setfit.html#stormtrooper.setfit.SetFitZeroShotClassifier.predict">(stormtrooper.setfit.SetFitZeroShotClassifier method)</a>
 </li>
           <li><a href="text2text.html#stormtrooper.Text2TextFewShotClassifier.predict">(stormtrooper.Text2TextFewShotClassifier method)</a>
 </li>
@@ -327,8 +315,6 @@ <h2>P</h2>
           <li><a href="zeroshot.html#stormtrooper.ZeroShotClassifier.predict">(stormtrooper.ZeroShotClassifier method)</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="zeroshot.html#stormtrooper.ZeroShotClassifier.predict_proba">predict_proba() (stormtrooper.ZeroShotClassifier method)</a>
 </li>
     </ul></td>
@@ -350,12 +336,6 @@ <h2>S</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="zeroshot.html#stormtrooper.ZeroShotClassifier.set_output">set_output() (stormtrooper.ZeroShotClassifier method)</a>
-</li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="setfit.html#stormtrooper.setfit.SetFitFewShotClassifier">SetFitFewShotClassifier (class in stormtrooper.setfit)</a>
-</li>
-        <li><a href="setfit.html#stormtrooper.setfit.SetFitZeroShotClassifier">SetFitZeroShotClassifier (class in stormtrooper.setfit)</a>
 </li>
     </ul></td>
   </tr></table>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/setfit.html b/docs/_build/html/setfit.html
diff --git a/docs/setfit.rst b/docs/setfit.rst
@@ -15,7 +15,7 @@ Since this requires the setfit package we recommend you install stormtrooper wit
 
 .. code-block:: python
 
-   from stormtrooper.setfit import SetFitZeroShotClassifier, SetFitFewShotClassifier
+   from stormtrooper import SetFitZeroShotClassifier, SetFitFewShotClassifier
 
    sample_text = "It is the Electoral College's responsibility to elect the president."