[skip ci] Documentation updates

mindee · Nov 17, 2023 · 20acc71 · 20acc71
1 parent 174974a
commit 20acc71
Show file tree

Hide file tree

Showing 40 changed files with 734 additions and 710 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/latest/_modules/doctr/io/elements.html b/latest/_modules/doctr/io/elements.html
diff --git a/latest/_modules/doctr/models/zoo.html b/latest/_modules/doctr/models/zoo.html
@@ -272,6 +272,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
     <span class="n">det_bs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
     <span class="n">reco_bs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">128</span><span class="p">,</span>
     <span class="n">detect_orientation</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
+    <span class="n">straighten_pages</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="n">detect_language</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">OCRPredictor</span><span class="p">:</span>
@@ -301,6 +302,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
         <span class="n">preserve_aspect_ratio</span><span class="o">=</span><span class="n">preserve_aspect_ratio</span><span class="p">,</span>
         <span class="n">symmetric_pad</span><span class="o">=</span><span class="n">symmetric_pad</span><span class="p">,</span>
         <span class="n">detect_orientation</span><span class="o">=</span><span class="n">detect_orientation</span><span class="p">,</span>
+        <span class="n">straighten_pages</span><span class="o">=</span><span class="n">straighten_pages</span><span class="p">,</span>
         <span class="n">detect_language</span><span class="o">=</span><span class="n">detect_language</span><span class="p">,</span>
         <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
     <span class="p">)</span>
@@ -316,6 +318,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
     <span class="n">symmetric_pad</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
     <span class="n">export_as_straight_boxes</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="n">detect_orientation</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
+    <span class="n">straighten_pages</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="n">detect_language</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">OCRPredictor</span><span class="p">:</span>
@@ -344,6 +347,10 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
 <span class="sd">            (potentially rotated) as straight bounding boxes.</span>
 <span class="sd">        detect_orientation: if True, the estimated general page orientation will be added to the predictions for each</span>
 <span class="sd">            page. Doing so will slightly deteriorate the overall latency.</span>
+<span class="sd">        straighten_pages: if True, estimates the page general orientation</span>
+<span class="sd">            based on the segmentation map median line orientation.</span>
+<span class="sd">            Then, rotates page before passing it again to the deep learning detection module.</span>
+<span class="sd">            Doing so will improve performances for documents with page-uniform rotations.</span>
 <span class="sd">        detect_language: if True, the language prediction will be added to the predictions for each</span>
 <span class="sd">            page. Doing so will slightly deteriorate the overall latency.</span>
 <span class="sd">        kwargs: keyword args of `OCRPredictor`</span>
@@ -362,6 +369,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
         <span class="n">symmetric_pad</span><span class="o">=</span><span class="n">symmetric_pad</span><span class="p">,</span>
         <span class="n">export_as_straight_boxes</span><span class="o">=</span><span class="n">export_as_straight_boxes</span><span class="p">,</span>
         <span class="n">detect_orientation</span><span class="o">=</span><span class="n">detect_orientation</span><span class="p">,</span>
+        <span class="n">straighten_pages</span><span class="o">=</span><span class="n">straighten_pages</span><span class="p">,</span>
         <span class="n">detect_language</span><span class="o">=</span><span class="n">detect_language</span><span class="p">,</span>
         <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
     <span class="p">)</span></div>
@@ -378,6 +386,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
     <span class="n">det_bs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span>
     <span class="n">reco_bs</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">128</span><span class="p">,</span>
     <span class="n">detect_orientation</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
+    <span class="n">straighten_pages</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="n">detect_language</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">KIEPredictor</span><span class="p">:</span>
@@ -407,6 +416,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
         <span class="n">preserve_aspect_ratio</span><span class="o">=</span><span class="n">preserve_aspect_ratio</span><span class="p">,</span>
         <span class="n">symmetric_pad</span><span class="o">=</span><span class="n">symmetric_pad</span><span class="p">,</span>
         <span class="n">detect_orientation</span><span class="o">=</span><span class="n">detect_orientation</span><span class="p">,</span>
+        <span class="n">straighten_pages</span><span class="o">=</span><span class="n">straighten_pages</span><span class="p">,</span>
         <span class="n">detect_language</span><span class="o">=</span><span class="n">detect_language</span><span class="p">,</span>
         <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
     <span class="p">)</span>
@@ -422,6 +432,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
     <span class="n">symmetric_pad</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
     <span class="n">export_as_straight_boxes</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="n">detect_orientation</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
+    <span class="n">straighten_pages</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="n">detect_language</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">KIEPredictor</span><span class="p">:</span>
@@ -450,6 +461,10 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
 <span class="sd">            (potentially rotated) as straight bounding boxes.</span>
 <span class="sd">        detect_orientation: if True, the estimated general page orientation will be added to the predictions for each</span>
 <span class="sd">            page. Doing so will slightly deteriorate the overall latency.</span>
+<span class="sd">        straighten_pages: if True, estimates the page general orientation</span>
+<span class="sd">            based on the segmentation map median line orientation.</span>
+<span class="sd">            Then, rotates page before passing it again to the deep learning detection module.</span>
+<span class="sd">            Doing so will improve performances for documents with page-uniform rotations.</span>
 <span class="sd">        detect_language: if True, the language prediction will be added to the predictions for each</span>
 <span class="sd">            page. Doing so will slightly deteriorate the overall latency.</span>
 <span class="sd">        kwargs: keyword args of `OCRPredictor`</span>
@@ -468,6 +483,7 @@ <h1>Source code for doctr.models.zoo</h1><div class="highlight"><pre>
         <span class="n">symmetric_pad</span><span class="o">=</span><span class="n">symmetric_pad</span><span class="p">,</span>
         <span class="n">export_as_straight_boxes</span><span class="o">=</span><span class="n">export_as_straight_boxes</span><span class="p">,</span>
         <span class="n">detect_orientation</span><span class="o">=</span><span class="n">detect_orientation</span><span class="p">,</span>
+        <span class="n">straighten_pages</span><span class="o">=</span><span class="n">straighten_pages</span><span class="p">,</span>
         <span class="n">detect_language</span><span class="o">=</span><span class="n">detect_language</span><span class="p">,</span>
         <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
     <span class="p">)</span></div>