Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wangbinDL committed Oct 11, 2024
1 parent d92f6f6 commit 63268ab
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 21 deletions.
12 changes: 8 additions & 4 deletions docs/en/get_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,19 @@ We recommend users follow our best practices for installing PDF-Extract-Kit. It
**Step 2.** Install the dependencies for PDF-Extract-Kit.

.. code-block:: console
$ # For GPU devices
$ pip install -r requirements.txt
$ # For CPU-only devices
$ pip install -r requirements-cpu.txt
.. note::

For the convenience of user environment configuration, requirements.txt only includes the environment needed for the current best models, which currently include:
- Layout Detection: YOLO series (YOLOv10, DocLayout-YOLO)
- Formula Detection: YOLO series (YOLOv8)
- Formula Recognition: UniMERNet
- OCR: PaddleOCR

- Layout Detection: YOLO series (YOLOv10, DocLayout-YOLO)
- Formula Detection: YOLO series (YOLOv8)
- Formula Recognition: UniMERNet
- OCR: PaddleOCR

For other models, such as LayoutLMv3, additional environment setup is required. For details, see \ :ref:`Layout Detection Algorithms <algorithm_layout_detection>`.
Binary file modified docs/zh_cn/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/zh_cn/_build/doctrees/get_started/installation.doctree
Binary file not shown.
14 changes: 9 additions & 5 deletions docs/zh_cn/_build/html/_sources/get_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,19 @@
**步骤 2.** 安装 PDF-Extract-Kit 的依赖项

.. code-block:: console
$ # 对于GPU设备
$ pip install -r requirements.txt
$ # 对于无CPU设备
$ pip install -r requirements-cpu.txt
.. note::
考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
- 公式检测:YOLO系列 (YOLOv8)
- 公式识别:UniMERNet
- OCR: PaddleOCR

考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含

- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
- 公式检测:YOLO系列 (YOLOv8)
- 公式识别:UniMERNet
- OCR: PaddleOCR

对于其他模型请,如LayoutLMv3需要单独安装环境,具体见\ :ref:`布局检测算法 <algorithm_layout_detection>`
20 changes: 14 additions & 6 deletions docs/zh_cn/_build/html/get_started/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -386,14 +386,22 @@ <h2>最佳实践<a class="headerlink" href="#id2" title="Link to this heading">#
</pre></div>
</div>
<p><strong>步骤 2.</strong> 安装 PDF-Extract-Kit 的依赖项</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="c1"># 对于GPU设备</span>
<span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
<span class="gp">$ </span><span class="c1"># 对于无CPU设备</span>
<span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-cpu.txt
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">备注</p>
<p>考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
- 公式检测:YOLO系列 (YOLOv8)
- 公式识别:UniMERNet
- OCR: PaddleOCR
对于其他模型请,如LayoutLMv3需要单独安装环境,具体见<a class="reference internal" href="../algorithm/layout_detection.html#algorithm-layout-detection"><span class="std std-ref">布局检测算法</span></a></p>
<p>考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含</p>
<ul class="simple">
<li><p>布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)</p></li>
<li><p>公式检测:YOLO系列 (YOLOv8)</p></li>
<li><p>公式识别:UniMERNet</p></li>
<li><p>OCR: PaddleOCR</p></li>
</ul>
<p>对于其他模型请,如LayoutLMv3需要单独安装环境,具体见<a class="reference internal" href="../algorithm/layout_detection.html#algorithm-layout-detection"><span class="std std-ref">布局检测算法</span></a></p>
</div>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_cn/_build/html/searchindex.js

Large diffs are not rendered by default.

14 changes: 9 additions & 5 deletions docs/zh_cn/get_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,19 @@
**步骤 2.** 安装 PDF-Extract-Kit 的依赖项

.. code-block:: console
$ # 对于GPU设备
$ pip install -r requirements.txt
$ # 对于无CPU设备
$ pip install -r requirements-cpu.txt
.. note::
考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
- 公式检测:YOLO系列 (YOLOv8)
- 公式识别:UniMERNet
- OCR: PaddleOCR

考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含

- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
- 公式检测:YOLO系列 (YOLOv8)
- 公式识别:UniMERNet
- OCR: PaddleOCR

对于其他模型请,如LayoutLMv3需要单独安装环境,具体见\ :ref:`布局检测算法 <algorithm_layout_detection>`

0 comments on commit 63268ab

Please sign in to comment.