-
- | 操作系统 |
-
-
- | Ubuntu 22.04 LTS |
- Windows 10 / 11 |
- macOS 11+ |
-
-
- | CPU |
- x86_64(暂不支持ARM Linux) |
- x86_64(暂不支持ARM Windows) |
- x86_64 / arm64 |
-
-
- | 内存 |
- 大于等于16GB，推荐32G以上 |
-
-
- | python版本 |
- 3.10 (请务必通过conda创建3.10虚拟环境) |
-
-
- | Nvidia Driver 版本 |
- latest(专有驱动) |
- latest |
- None |
-
-
- | CUDA环境 |
- 自动安装[12.1(pytorch)+11.8(paddle)] |
- 11.8(手动安装)+cuDNN v8.7.0(手动安装) |
- None |
-
-
- | GPU硬件支持列表 |
- 最低要求 8G+显存 |
- 3060ti/3070/4060
- 8G显存可开启layout、公式识别和ocr加速 |
- None |
-
-
- | 推荐配置 10G+显存 |
- 3080/3080ti/3090/3090ti/4070/4070ti/4070tisuper/4080/4090
- 10G显存及以上可以同时开启layout、公式识别和ocr加速和表格识别加速
- |
-
-
### 在线体验
稳定版(经过QA验证的稳定版本)：
@@ -257,87 +178,9 @@ pip install -U magic-pdf[full] --extra-index-url https://wheels.myhloli.com -i h
}
```
-### 使用GPU
-
-如果您的设备支持CUDA，且满足主线环境中的显卡要求，则可以使用GPU加速，请根据自己的系统选择适合的教程：
-
-- [Ubuntu22.04LTS + GPU](docs/README_Ubuntu_CUDA_Acceleration_zh_CN.md)
-- [Windows10/11 + GPU](docs/README_Windows_CUDA_Acceleration_zh_CN.md)
-- 使用Docker快速部署
-> [!IMPORTANT]
-> Docker 需设备gpu显存大于等于16GB，默认开启所有加速功能
->
-> 运行本docker前可以通过以下命令检测自己的设备是否支持在docker上使用CUDA加速
->
-> ```bash
-> docker run --rm --gpus=all nvidia/cuda:12.1.0-base-ubuntu22.04 nvidia-smi
-> ```
- ```bash
- wget https://github.com/opendatalab/MinerU/raw/master/Dockerfile
- docker build -t mineru:latest .
- docker run --rm -it --gpus=all mineru:latest /bin/bash
- magic-pdf --help
- ```
-
## 使用
-### 命令行
-
-```bash
-magic-pdf --help
-Usage: magic-pdf [OPTIONS]
-
-Options:
- -v, --version display the version and exit
- -p, --path PATH local pdf filepath or directory [required]
- -o, --output-dir PATH output local directory [required]
- -m, --method [ocr|txt|auto] the method for parsing pdf. ocr: using ocr
- technique to extract information from pdf. txt:
- suitable for the text-based pdf only and
- outperform ocr. auto: automatically choose the
- best method for parsing pdf from ocr and txt.
- without method specified, auto will be used by
- default.
- -l, --lang TEXT Input the languages in the pdf (if known) to
- improve OCR accuracy. Optional. You should
- input "Abbreviation" with language form url: ht
- tps://paddlepaddle.github.io/PaddleOCR/latest/en
- /ppocr/blog/multi_languages.html#5-support-languages-
- and-abbreviations
- -d, --debug BOOLEAN Enables detailed debugging information during
- the execution of the CLI commands.
- -s, --start INTEGER The starting page for PDF parsing, beginning
- from 0.
- -e, --end INTEGER The ending page for PDF parsing, beginning from
- 0.
- --help Show this message and exit.
-
-
-## show version
-magic-pdf -v
-
-## command line example
-magic-pdf -p {some_pdf} -o {some_output_dir} -m auto
-```
-
-其中 `{some_pdf}` 可以是单个pdf文件，也可以是一个包含多个pdf文件的目录。
-运行完命令后输出的结果会保存在`{some_output_dir}`目录下, 输出的文件列表如下
-
-```text
-├── some_pdf.md # markdown 文件
-├── images # 存放图片目录
-├── some_pdf_layout.pdf # layout 绘图 （包含layout阅读顺序）
-├── some_pdf_middle.json # minerU 中间处理结果
-├── some_pdf_model.json # 模型推理结果
-├── some_pdf_origin.pdf # 原 pdf 文件
-├── some_pdf_spans.pdf # 最小粒度的bbox位置信息绘图
-└── some_pdf_content_list.json # 按阅读顺序排列的富文本json
-```
-
-> [!TIP]
-> 更多有关输出文件的信息，请参考[输出文件说明](docs/output_file_zh_cn.md)
-
### API
处理本地磁盘上的文件
@@ -394,24 +237,6 @@ TODO
- [ ] [化学式识别](docs/chemical_knowledge_introduction/introduction.pdf)
- [ ] 几何图形识别
-# Known Issues
-
-- 阅读顺序基于模型对可阅读内容在空间中的分布进行排序，在极端复杂的排版下可能会部分区域乱序
-- 不支持竖排文字
-- 目录和列表通过规则进行识别，少部分不常见的列表形式可能无法识别
-- 标题只有一级，目前不支持标题分级
-- 代码块在layout模型里还没有支持
-- 漫画书、艺术图册、小学教材、习题尚不能很好解析
-- 表格识别在复杂表格上可能会出现行/列识别错误
-- 在小语种PDF上，OCR识别可能会出现字符不准确的情况（如拉丁文的重音符号、阿拉伯文易混淆字符等）
-- 部分公式可能会无法在markdown中渲染
-
-# FAQ
-
-[常见问题](docs/FAQ_zh_cn.md)
-
-
-[FAQ](docs/FAQ_en_us.md)
# All Thanks To Our Contributors
diff --git a/next_docs/en/.readthedocs.yaml b/docs/en/.readthedocs.yaml
similarity index 57%
rename from next_docs/en/.readthedocs.yaml
rename to docs/en/.readthedocs.yaml
index 99e6a055..7e3312e4 100644
--- a/next_docs/en/.readthedocs.yaml
+++ b/docs/en/.readthedocs.yaml
@@ -10,7 +10,7 @@ formats:
python:
install:
- - requirements: next_docs/requirements.txt
+ - requirements: docs/requirements.txt
sphinx:
- configuration: next_docs/en/conf.py
+ configuration: docs/en/conf.py
diff --git a/next_docs/en/Makefile b/docs/en/Makefile
similarity index 100%
rename from next_docs/en/Makefile
rename to docs/en/Makefile
diff --git a/docs/images/MinerU-logo-hq.png b/docs/en/_static/image/MinerU-logo-hq.png
similarity index 100%
rename from docs/images/MinerU-logo-hq.png
rename to docs/en/_static/image/MinerU-logo-hq.png
diff --git a/docs/images/MinerU-logo.png b/docs/en/_static/image/MinerU-logo.png
similarity index 100%
rename from docs/images/MinerU-logo.png
rename to docs/en/_static/image/MinerU-logo.png
diff --git a/docs/images/datalab_logo.png b/docs/en/_static/image/datalab_logo.png
similarity index 100%
rename from docs/images/datalab_logo.png
rename to docs/en/_static/image/datalab_logo.png
diff --git a/docs/images/flowchart_en.png b/docs/en/_static/image/flowchart_en.png
similarity index 100%
rename from docs/images/flowchart_en.png
rename to docs/en/_static/image/flowchart_en.png
diff --git a/docs/images/flowchart_zh_cn.png b/docs/en/_static/image/flowchart_zh_cn.png
similarity index 100%
rename from docs/images/flowchart_zh_cn.png
rename to docs/en/_static/image/flowchart_zh_cn.png
diff --git a/docs/images/layout_example.png b/docs/en/_static/image/layout_example.png
similarity index 100%
rename from docs/images/layout_example.png
rename to docs/en/_static/image/layout_example.png
diff --git a/next_docs/en/_static/image/logo.png b/docs/en/_static/image/logo.png
similarity index 100%
rename from next_docs/en/_static/image/logo.png
rename to docs/en/_static/image/logo.png
diff --git a/docs/images/poly.png b/docs/en/_static/image/poly.png
similarity index 100%
rename from docs/images/poly.png
rename to docs/en/_static/image/poly.png
diff --git a/docs/images/project_panorama_en.png b/docs/en/_static/image/project_panorama_en.png
similarity index 100%
rename from docs/images/project_panorama_en.png
rename to docs/en/_static/image/project_panorama_en.png
diff --git a/docs/images/project_panorama_zh_cn.png b/docs/en/_static/image/project_panorama_zh_cn.png
similarity index 100%
rename from docs/images/project_panorama_zh_cn.png
rename to docs/en/_static/image/project_panorama_zh_cn.png
diff --git a/docs/images/spans_example.png b/docs/en/_static/image/spans_example.png
similarity index 100%
rename from docs/images/spans_example.png
rename to docs/en/_static/image/spans_example.png
diff --git a/docs/images/web_demo_1.png b/docs/en/_static/image/web_demo_1.png
similarity index 100%
rename from docs/images/web_demo_1.png
rename to docs/en/_static/image/web_demo_1.png
diff --git a/next_docs/en/additional_notes/faq.rst b/docs/en/additional_notes/faq.rst
similarity index 100%
rename from next_docs/en/additional_notes/faq.rst
rename to docs/en/additional_notes/faq.rst
diff --git a/next_docs/en/additional_notes/glossary.rst b/docs/en/additional_notes/glossary.rst
similarity index 100%
rename from next_docs/en/additional_notes/glossary.rst
rename to docs/en/additional_notes/glossary.rst
diff --git a/next_docs/en/additional_notes/known_issues.rst b/docs/en/additional_notes/known_issues.rst
similarity index 100%
rename from next_docs/en/additional_notes/known_issues.rst
rename to docs/en/additional_notes/known_issues.rst
diff --git a/next_docs/en/api.rst b/docs/en/api.rst
similarity index 100%
rename from next_docs/en/api.rst
rename to docs/en/api.rst
diff --git a/next_docs/en/api/classes.rst b/docs/en/api/classes.rst
similarity index 100%
rename from next_docs/en/api/classes.rst
rename to docs/en/api/classes.rst
diff --git a/next_docs/en/api/data_reader_writer.rst b/docs/en/api/data_reader_writer.rst
similarity index 100%
rename from next_docs/en/api/data_reader_writer.rst
rename to docs/en/api/data_reader_writer.rst
diff --git a/next_docs/en/api/dataset.rst b/docs/en/api/dataset.rst
similarity index 100%
rename from next_docs/en/api/dataset.rst
rename to docs/en/api/dataset.rst
diff --git a/next_docs/en/api/io.rst b/docs/en/api/io.rst
similarity index 100%
rename from next_docs/en/api/io.rst
rename to docs/en/api/io.rst
diff --git a/next_docs/en/api/read_api.rst b/docs/en/api/read_api.rst
similarity index 100%
rename from next_docs/en/api/read_api.rst
rename to docs/en/api/read_api.rst
diff --git a/next_docs/en/api/schemas.rst b/docs/en/api/schemas.rst
similarity index 100%
rename from next_docs/en/api/schemas.rst
rename to docs/en/api/schemas.rst
diff --git a/next_docs/en/conf.py b/docs/en/conf.py
similarity index 100%
rename from next_docs/en/conf.py
rename to docs/en/conf.py
diff --git a/next_docs/en/index.rst b/docs/en/index.rst
similarity index 100%
rename from next_docs/en/index.rst
rename to docs/en/index.rst
diff --git a/next_docs/en/make.bat b/docs/en/make.bat
similarity index 100%
rename from next_docs/en/make.bat
rename to docs/en/make.bat
diff --git a/next_docs/en/user_guide.rst b/docs/en/user_guide.rst
similarity index 100%
rename from next_docs/en/user_guide.rst
rename to docs/en/user_guide.rst
diff --git a/next_docs/en/user_guide/data.rst b/docs/en/user_guide/data.rst
similarity index 100%
rename from next_docs/en/user_guide/data.rst
rename to docs/en/user_guide/data.rst
diff --git a/next_docs/en/user_guide/data/data_reader_writer.rst b/docs/en/user_guide/data/data_reader_writer.rst
similarity index 100%
rename from next_docs/en/user_guide/data/data_reader_writer.rst
rename to docs/en/user_guide/data/data_reader_writer.rst
diff --git a/next_docs/en/user_guide/data/dataset.rst b/docs/en/user_guide/data/dataset.rst
similarity index 100%
rename from next_docs/en/user_guide/data/dataset.rst
rename to docs/en/user_guide/data/dataset.rst
diff --git a/next_docs/en/user_guide/data/io.rst b/docs/en/user_guide/data/io.rst
similarity index 100%
rename from next_docs/en/user_guide/data/io.rst
rename to docs/en/user_guide/data/io.rst
diff --git a/next_docs/en/user_guide/data/read_api.rst b/docs/en/user_guide/data/read_api.rst
similarity index 100%
rename from next_docs/en/user_guide/data/read_api.rst
rename to docs/en/user_guide/data/read_api.rst
diff --git a/next_docs/en/user_guide/install.rst b/docs/en/user_guide/install.rst
similarity index 100%
rename from next_docs/en/user_guide/install.rst
rename to docs/en/user_guide/install.rst
diff --git a/next_docs/en/user_guide/install/boost_with_cuda.rst b/docs/en/user_guide/install/boost_with_cuda.rst
similarity index 100%
rename from next_docs/en/user_guide/install/boost_with_cuda.rst
rename to docs/en/user_guide/install/boost_with_cuda.rst
diff --git a/next_docs/en/user_guide/install/download_model_weight_files.rst b/docs/en/user_guide/install/download_model_weight_files.rst
similarity index 100%
rename from next_docs/en/user_guide/install/download_model_weight_files.rst
rename to docs/en/user_guide/install/download_model_weight_files.rst
diff --git a/next_docs/en/user_guide/install/install.rst b/docs/en/user_guide/install/install.rst
similarity index 96%
rename from next_docs/en/user_guide/install/install.rst
rename to docs/en/user_guide/install/install.rst
index becb4235..c5302ead 100644
--- a/next_docs/en/user_guide/install/install.rst
+++ b/docs/en/user_guide/install/install.rst
@@ -1,9 +1,8 @@
Install
===============================================================
-If you encounter any installation issues, please first consult the FAQ.
-If the parsing results are not as expected, refer to the Known Issues.
-There are three different ways to experience MinerU
+If you encounter any installation issues, please first consult the :doc:`../../additional_notes/faq`.
+If the parsing results are not as expected, refer to the :doc:`../../additional_notes/known_issues`.
Pre-installation Notice—Hardware and Software Environment Support
------------------------------------------------------------------
diff --git a/next_docs/en/user_guide/quick_start.rst b/docs/en/user_guide/quick_start.rst
similarity index 100%
rename from next_docs/en/user_guide/quick_start.rst
rename to docs/en/user_guide/quick_start.rst
diff --git a/next_docs/en/user_guide/quick_start/command_line.rst b/docs/en/user_guide/quick_start/command_line.rst
similarity index 94%
rename from next_docs/en/user_guide/quick_start/command_line.rst
rename to docs/en/user_guide/quick_start/command_line.rst
index 548c5855..071b18f7 100644
--- a/next_docs/en/user_guide/quick_start/command_line.rst
+++ b/docs/en/user_guide/quick_start/command_line.rst
@@ -55,5 +55,8 @@ directory. The output file list is as follows:
├── some_pdf_spans.pdf # smallest granularity bbox position information diagram
└── some_pdf_content_list.json # Rich text JSON arranged in reading order
-For more information about the output files, please refer to the :doc:`../tutorial/output_file_description`
+.. admonition:: Tip
+ :class: tip
+
+ For more information about the output files, please refer to the :doc:`../tutorial/output_file_description`
diff --git a/next_docs/en/user_guide/quick_start/to_markdown.rst b/docs/en/user_guide/quick_start/to_markdown.rst
similarity index 100%
rename from next_docs/en/user_guide/quick_start/to_markdown.rst
rename to docs/en/user_guide/quick_start/to_markdown.rst
diff --git a/next_docs/en/user_guide/tutorial.rst b/docs/en/user_guide/tutorial.rst
similarity index 100%
rename from next_docs/en/user_guide/tutorial.rst
rename to docs/en/user_guide/tutorial.rst
diff --git a/next_docs/en/user_guide/tutorial/output_file_description.rst b/docs/en/user_guide/tutorial/output_file_description.rst
similarity index 100%
rename from next_docs/en/user_guide/tutorial/output_file_description.rst
rename to docs/en/user_guide/tutorial/output_file_description.rst
diff --git a/next_docs/requirements.txt b/docs/requirements.txt
similarity index 100%
rename from next_docs/requirements.txt
rename to docs/requirements.txt
diff --git a/next_docs/zh_cn/.readthedocs.yaml b/docs/zh_cn/.readthedocs.yaml
similarity index 56%
rename from next_docs/zh_cn/.readthedocs.yaml
rename to docs/zh_cn/.readthedocs.yaml
index 5df2ecff..1f93a4d7 100644
--- a/next_docs/zh_cn/.readthedocs.yaml
+++ b/docs/zh_cn/.readthedocs.yaml
@@ -10,7 +10,7 @@ formats:
python:
install:
- - requirements: next_docs/requirements.txt
+ - requirements: docs/requirements.txt
sphinx:
- configuration: next_docs/zh_cn/conf.py
+ configuration: docs/zh_cn/conf.py
diff --git a/next_docs/zh_cn/Makefile b/docs/zh_cn/Makefile
similarity index 100%
rename from next_docs/zh_cn/Makefile
rename to docs/zh_cn/Makefile
diff --git a/next_docs/en/_static/image/MinerU-logo-hq.png b/docs/zh_cn/_static/image/MinerU-logo-hq.png
similarity index 100%
rename from next_docs/en/_static/image/MinerU-logo-hq.png
rename to docs/zh_cn/_static/image/MinerU-logo-hq.png
diff --git a/next_docs/en/_static/image/MinerU-logo.png b/docs/zh_cn/_static/image/MinerU-logo.png
similarity index 100%
rename from next_docs/en/_static/image/MinerU-logo.png
rename to docs/zh_cn/_static/image/MinerU-logo.png
diff --git a/next_docs/en/_static/image/datalab_logo.png b/docs/zh_cn/_static/image/datalab_logo.png
similarity index 100%
rename from next_docs/en/_static/image/datalab_logo.png
rename to docs/zh_cn/_static/image/datalab_logo.png
diff --git a/next_docs/en/_static/image/flowchart_en.png b/docs/zh_cn/_static/image/flowchart_en.png
similarity index 100%
rename from next_docs/en/_static/image/flowchart_en.png
rename to docs/zh_cn/_static/image/flowchart_en.png
diff --git a/next_docs/en/_static/image/flowchart_zh_cn.png b/docs/zh_cn/_static/image/flowchart_zh_cn.png
similarity index 100%
rename from next_docs/en/_static/image/flowchart_zh_cn.png
rename to docs/zh_cn/_static/image/flowchart_zh_cn.png
diff --git a/next_docs/en/_static/image/layout_example.png b/docs/zh_cn/_static/image/layout_example.png
similarity index 100%
rename from next_docs/en/_static/image/layout_example.png
rename to docs/zh_cn/_static/image/layout_example.png
diff --git a/next_docs/zh_cn/_static/image/logo.png b/docs/zh_cn/_static/image/logo.png
similarity index 100%
rename from next_docs/zh_cn/_static/image/logo.png
rename to docs/zh_cn/_static/image/logo.png
diff --git a/next_docs/en/_static/image/poly.png b/docs/zh_cn/_static/image/poly.png
similarity index 100%
rename from next_docs/en/_static/image/poly.png
rename to docs/zh_cn/_static/image/poly.png
diff --git a/next_docs/en/_static/image/project_panorama_en.png b/docs/zh_cn/_static/image/project_panorama_en.png
similarity index 100%
rename from next_docs/en/_static/image/project_panorama_en.png
rename to docs/zh_cn/_static/image/project_panorama_en.png
diff --git a/next_docs/en/_static/image/project_panorama_zh_cn.png b/docs/zh_cn/_static/image/project_panorama_zh_cn.png
similarity index 100%
rename from next_docs/en/_static/image/project_panorama_zh_cn.png
rename to docs/zh_cn/_static/image/project_panorama_zh_cn.png
diff --git a/next_docs/en/_static/image/spans_example.png b/docs/zh_cn/_static/image/spans_example.png
similarity index 100%
rename from next_docs/en/_static/image/spans_example.png
rename to docs/zh_cn/_static/image/spans_example.png
diff --git a/next_docs/en/_static/image/web_demo_1.png b/docs/zh_cn/_static/image/web_demo_1.png
similarity index 100%
rename from next_docs/en/_static/image/web_demo_1.png
rename to docs/zh_cn/_static/image/web_demo_1.png
diff --git a/docs/zh_cn/additional_notes/faq.rst b/docs/zh_cn/additional_notes/faq.rst
new file mode 100644
index 00000000..fba7bd71
--- /dev/null
+++ b/docs/zh_cn/additional_notes/faq.rst
@@ -0,0 +1,78 @@
+常见问题解答
+============
+
+1.在较新版本的mac上使用命令安装pip install magic-pdf[full] zsh: no matches found: magic-pdf[full]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+在 macOS 上，默认的 shell 从 Bash 切换到了 Z shell，而 Z shell
+对于某些类型的字符串匹配有特殊的处理逻辑，这可能导致no matches
+found错误。 可以通过在命令行禁用globbing特性，再尝试运行安装命令
+
+.. code:: bash
+
+ setopt no_nomatch
+ pip install magic-pdf[full]
+
+2.使用过程中遇到_pickle.UnpicklingError: invalid load key, ‘v’.错误
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+可能是由于模型文件未下载完整导致，可尝试重新下载模型文件后再试
+参考：https://github.com/opendatalab/MinerU/issues/143
+
+3.模型文件应该下载到哪里/models-dir的配置应该怎么填
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+模型文件的路径输入是在”magic-pdf.json”中通过
+
+.. code:: json
+
+ {
+ "models-dir": "/tmp/models"
+ }
+
+进行配置的。
+这个路径是绝对路径而不是相对路径，绝对路径的获取可在models目录中通过命令
+“pwd” 获取。
+参考：https://github.com/opendatalab/MinerU/issues/155#issuecomment-2230216874
+
+4.在WSL2的Ubuntu22.04中遇到报错\ ``ImportError: libGL.so.1: cannot open shared object file: No such file or directory``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+WSL2的Ubuntu22.04中缺少\ ``libgl``\ 库，可通过以下命令安装\ ``libgl``\ 库解决：
+
+.. code:: bash
+
+ sudo apt-get install libgl1-mesa-glx
+
+参考：https://github.com/opendatalab/MinerU/issues/388
+
+5.遇到报错 ``ModuleNotFoundError : Nomodulenamed 'fairscale'``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+需要卸载该模块并重新安装
+
+.. code:: bash
+
+ pip uninstall fairscale
+ pip install fairscale
+
+参考：https://github.com/opendatalab/MinerU/issues/411
+
+6.在部分较新的设备如H100上，使用CUDA加速OCR时解析出的文字乱码。
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+cuda11对新显卡的兼容性不好，需要升级paddle使用的cuda版本
+
+.. code:: bash
+
+ pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu123/
+
+参考：https://github.com/opendatalab/MinerU/issues/558
+
+7.在部分Linux服务器上，程序一运行就报错 ``非法指令 (核心已转储)`` 或 ``Illegal instruction (core dumped)``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+可能是因为服务器CPU不支持AVX/AVX2指令集，或cpu本身支持但被运维禁用了，可以尝试联系运维解除限制或更换服务器。
+
+参考：https://github.com/opendatalab/MinerU/issues/591 ，
+https://github.com/opendatalab/MinerU/issues/736
diff --git a/docs/zh_cn/additional_notes/glossary.rst b/docs/zh_cn/additional_notes/glossary.rst
new file mode 100644
index 00000000..cc2c5822
--- /dev/null
+++ b/docs/zh_cn/additional_notes/glossary.rst
@@ -0,0 +1,11 @@
+
+
+名词解释
+===========
+
+1. jsonl
+ TODO: add description
+
+2. magic-pdf.json
+ TODO: add description
+
diff --git a/docs/zh_cn/additional_notes/known_issues.rst b/docs/zh_cn/additional_notes/known_issues.rst
new file mode 100644
index 00000000..68b6d39c
--- /dev/null
+++ b/docs/zh_cn/additional_notes/known_issues.rst
@@ -0,0 +1,13 @@
+已知问题
+============
+
+- 阅读顺序基于模型对可阅读内容在空间中的分布进行排序，在极端复杂的排版下可能会部分区域乱序
+- 不支持竖排文字
+- 目录和列表通过规则进行识别，少部分不常见的列表形式可能无法识别
+- 标题只有一级，目前不支持标题分级
+- 代码块在layout模型里还没有支持
+- 漫画书、艺术图册、小学教材、习题尚不能很好解析
+- 表格识别在复杂表格上可能会出现行/列识别错误
+- 在小语种PDF上，OCR识别可能会出现字符不准确的情况（如拉丁文的重音符号、阿拉伯文易混淆字符等）
+- 部分公式可能会无法在markdown中渲染
+
diff --git a/next_docs/zh_cn/conf.py b/docs/zh_cn/conf.py
similarity index 77%
rename from next_docs/zh_cn/conf.py
rename to docs/zh_cn/conf.py
index 4eccd497..ac68167f 100644
--- a/next_docs/zh_cn/conf.py
+++ b/docs/zh_cn/conf.py
@@ -15,7 +15,8 @@ import subprocess
import sys
from sphinx.ext import autodoc
-
+from docutils import nodes
+from docutils.parsers.rst import Directive
def install(package):
subprocess.check_call([sys.executable, '-m', 'pip', 'install', package])
@@ -33,8 +34,8 @@ sys.path.insert(0, os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
project = 'MinerU'
-copyright = '2024, OpenDataLab'
-author = 'MinerU Contributors'
+copyright = '2024, MinerU Contributors'
+author = 'OpenDataLab'
# The full version, including alpha/beta/rc tags
version_file = '../../magic_pdf/libs/version.py'
@@ -58,10 +59,20 @@ extensions = [
'sphinx_copybutton',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
+ 'sphinx.ext.inheritance_diagram',
'myst_parser',
'sphinxarg.ext',
+ 'sphinxcontrib.autodoc_pydantic',
]
+# class hierarchy diagram
+inheritance_graph_attrs = dict(rankdir="LR", size='"8.0, 12.0"', fontsize=14, ratio='compress')
+inheritance_node_attrs = dict(shape='ellipse', fontsize=14, height=0.75)
+inheritance_edge_attrs = dict(arrow='vee')
+
+autodoc_pydantic_model_show_json = True
+autodoc_pydantic_model_show_config_summary = False
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -120,3 +131,21 @@ class MockedClassDocumenter(autodoc.ClassDocumenter):
autodoc.ClassDocumenter = MockedClassDocumenter
navigation_with_keys = False
+
+
+# add custom directive
+
+
+class VideoDirective(Directive):
+ required_arguments = 1
+ optional_arguments = 0
+ final_argument_whitespace = True
+ option_spec = {}
+
+ def run(self):
+ url = self.arguments[0]
+ video_node = nodes.raw('', f'