Skip to content

Commit 63268ab

Browse files
committed
Update docs
1 parent d92f6f6 commit 63268ab

File tree

7 files changed

+41
-21
lines changed

7 files changed

+41
-21
lines changed

docs/en/get_started/installation.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,19 @@ We recommend users follow our best practices for installing PDF-Extract-Kit. It
1919
**Step 2.** Install the dependencies for PDF-Extract-Kit.
2020

2121
.. code-block:: console
22+
2223
$ # For GPU devices
2324
$ pip install -r requirements.txt
2425
$ # For CPU-only devices
2526
$ pip install -r requirements-cpu.txt
2627
2728
.. note::
29+
2830
For the convenience of user environment configuration, requirements.txt only includes the environment needed for the current best models, which currently include:
29-
- Layout Detection: YOLO series (YOLOv10, DocLayout-YOLO)
30-
- Formula Detection: YOLO series (YOLOv8)
31-
- Formula Recognition: UniMERNet
32-
- OCR: PaddleOCR
31+
32+
- Layout Detection: YOLO series (YOLOv10, DocLayout-YOLO)
33+
- Formula Detection: YOLO series (YOLOv8)
34+
- Formula Recognition: UniMERNet
35+
- OCR: PaddleOCR
36+
3337
For other models, such as LayoutLMv3, additional environment setup is required. For details, see \ :ref:`Layout Detection Algorithms <algorithm_layout_detection>`.
1.28 KB
Binary file not shown.
Binary file not shown.

docs/zh_cn/_build/html/_sources/get_started/installation.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,19 @@
2020
**步骤 2.** 安装 PDF-Extract-Kit 的依赖项
2121

2222
.. code-block:: console
23+
2324
$ # 对于GPU设备
2425
$ pip install -r requirements.txt
2526
$ # 对于无CPU设备
2627
$ pip install -r requirements-cpu.txt
2728
2829
.. note::
29-
考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
30-
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
31-
- 公式检测:YOLO系列 (YOLOv8)
32-
- 公式识别:UniMERNet
33-
- OCR: PaddleOCR
30+
31+
考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
32+
33+
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
34+
- 公式检测:YOLO系列 (YOLOv8)
35+
- 公式识别:UniMERNet
36+
- OCR: PaddleOCR
37+
3438
对于其他模型请,如LayoutLMv3需要单独安装环境,具体见\ :ref:`布局检测算法 <algorithm_layout_detection>`

docs/zh_cn/_build/html/get_started/installation.html

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -386,14 +386,22 @@ <h2>最佳实践<a class="headerlink" href="#id2" title="Link to this heading">#
386386
</pre></div>
387387
</div>
388388
<p><strong>步骤 2.</strong> 安装 PDF-Extract-Kit 的依赖项</p>
389+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="c1"># 对于GPU设备</span>
390+
<span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
391+
<span class="gp">$ </span><span class="c1"># 对于无CPU设备</span>
392+
<span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-cpu.txt
393+
</pre></div>
394+
</div>
389395
<div class="admonition note">
390396
<p class="admonition-title">备注</p>
391-
<p>考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
392-
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
393-
- 公式检测:YOLO系列 (YOLOv8)
394-
- 公式识别:UniMERNet
395-
- OCR: PaddleOCR
396-
对于其他模型请,如LayoutLMv3需要单独安装环境,具体见<a class="reference internal" href="../algorithm/layout_detection.html#algorithm-layout-detection"><span class="std std-ref">布局检测算法</span></a></p>
397+
<p>考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含</p>
398+
<ul class="simple">
399+
<li><p>布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)</p></li>
400+
<li><p>公式检测:YOLO系列 (YOLOv8)</p></li>
401+
<li><p>公式识别:UniMERNet</p></li>
402+
<li><p>OCR: PaddleOCR</p></li>
403+
</ul>
404+
<p>对于其他模型请,如LayoutLMv3需要单独安装环境,具体见<a class="reference internal" href="../algorithm/layout_detection.html#algorithm-layout-detection"><span class="std std-ref">布局检测算法</span></a></p>
397405
</div>
398406
</section>
399407
</section>

docs/zh_cn/_build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/zh_cn/get_started/installation.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,19 @@
2020
**步骤 2.** 安装 PDF-Extract-Kit 的依赖项
2121

2222
.. code-block:: console
23+
2324
$ # 对于GPU设备
2425
$ pip install -r requirements.txt
2526
$ # 对于无CPU设备
2627
$ pip install -r requirements-cpu.txt
2728
2829
.. note::
29-
考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
30-
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
31-
- 公式检测:YOLO系列 (YOLOv8)
32-
- 公式识别:UniMERNet
33-
- OCR: PaddleOCR
30+
31+
考虑到用户环境配置的便捷性,我们在requirements.txt只包含当前最好模型需要的环境,目前包含
32+
33+
- 布局检测:YOLO系列(YOLOv10, DocLayout-YOLO)
34+
- 公式检测:YOLO系列 (YOLOv8)
35+
- 公式识别:UniMERNet
36+
- OCR: PaddleOCR
37+
3438
对于其他模型请,如LayoutLMv3需要单独安装环境,具体见\ :ref:`布局检测算法 <algorithm_layout_detection>`

0 commit comments

Comments
 (0)