Skip to content

GitLab

Unverified Commit 784c61a2 authored by Xiaomeng Zhao's avatar Xiaomeng Zhao Committed by GitHub
Browse files

Merge pull request #906 from icecraft/feat/add_en_docs 

Feat/add en docs
parents 5f794533 91f8cbe2
Hide whitespace changes
Inline Side-by-side
Showing with 113 additions and 3 deletions
next_docs/en/user_guide/install/install.rst → docs/en/user_guide/install/install.rst
View file @ 784c61a2
Install Install
=============================================================== ===============================================================
If you encounter any installation issues, please first consult the FAQ. 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 Known Issues. If the parsing results are not as expected, refer to the :doc:`../../additional_notes/known_issues`.
There are three different ways to experience MinerU
Pre-installation Notice—Hardware and Software Environment Support Pre-installation Notice—Hardware and Software Environment Support
------------------------------------------------------------------ ------------------------------------------------------------------
...@@ -27,61 +26,62 @@ community feedback to help us gradually expand support. ...@@ -27,61 +26,62 @@ community feedback to help us gradually expand support.
.. raw:: html .. raw:: html
<style> <style>
table, th, td { table, th, td {
border: 1px solid black; border: 1px solid black;
border-collapse: collapse; border-collapse: collapse;
} }
</style> </style>
<table> <table>
<tr> <tr>
<td colspan="3" rowspan="2">Operating System</td> <td colspan="3" rowspan="2">Operating System</td>
</tr> </tr>
<tr> <tr>
<td>Ubuntu 22.04 LTS</td> <td>Ubuntu 22.04 LTS</td>
<td>Windows 10 / 11</td> <td>Windows 10 / 11</td>
<td>macOS 11+</td> <td>macOS 11+</td>
</tr> </tr>
<tr> <tr>
<td colspan="3">CPU</td> <td colspan="3">CPU</td>
<td>x86_64</td> <td>x86_64(unsupported ARM Linux)</td>
<td>x86_64</td> <td>x86_64(unsupported ARM Windows)</td>
<td>x86_64 / arm64</td> <td>x86_64 / arm64</td>
</tr> </tr>
<tr> <tr>
<td colspan="3">Memory</td> <td colspan="3">Memory</td>
<td colspan="3">16GB or more, recommended 32GB+</td> <td colspan="3">16GB or more, recommended 32GB+</td>
</tr> </tr>
<tr> <tr>
<td colspan="3">Python Version</td> <td colspan="3">Python Version</td>
<td colspan="3">3.10</td> <td colspan="3">3.10(Please make sure to create a Python 3.10 virtual environment using conda)</td>
</tr> </tr>
<tr> <tr>
<td colspan="3">Nvidia Driver Version</td> <td colspan="3">Nvidia Driver Version</td>
<td>latest (Proprietary Driver)</td> <td>latest (Proprietary Driver)</td>
<td>latest</td> <td>latest</td>
<td>None</td> <td>None</td>
</tr> </tr>
<tr> <tr>
<td colspan="3">CUDA Environment</td> <td colspan="3">CUDA Environment</td>
<td>Automatic installation [12.1 (pytorch) + 11.8 (paddle)]</td> <td>Automatic installation [12.1 (pytorch) + 11.8 (paddle)]</td>
<td>11.8 (manual installation) + cuDNN v8.7.0 (manual installation)</td> <td>11.8 (manual installation) + cuDNN v8.7.0 (manual installation)</td>
<td>None</td> <td>None</td>
</tr> </tr>
<tr> <tr>
<td rowspan="2">GPU Hardware Support List</td> <td rowspan="2">GPU Hardware Support List</td>
<td colspan="2">Minimum Requirement 8G+ VRAM</td> <td colspan="2">Minimum Requirement 8G+ VRAM</td>
<td colspan="2">3060ti/3070/3080/3080ti/4060/4070/4070ti<br> <td colspan="2">3060ti/3070/4060<br>
8G VRAM enables layout, formula recognition acceleration and OCR acceleration</td> 8G VRAM enables layout, formula recognition acceleration and OCR acceleration</td>
<td rowspan="2">None</td> <td rowspan="2">None</td>
</tr> </tr>
<tr> <tr>
<td colspan="2">Recommended Configuration 16G+ VRAM</td> <td colspan="2">Recommended Configuration 10G+ VRAM</td>
<td colspan="2">3090/3090ti/4070ti super/4080/4090<br> <td colspan="2">3080/3080ti/3090/3090ti/4070/4070ti/4070tisuper/4080/4090<br>
16G VRAM or more can enable layout, formula recognition, OCR acceleration and table recognition acceleration simultaneously 10G VRAM or more can enable layout, formula recognition, OCR acceleration and table recognition acceleration simultaneously
</td> </td>
</tr> </tr>
</table> </table>
Create an environment Create an environment
......
next_docs/en/user_guide/quick_start/command_line.rst → docs/en/user_guide/quick_start/command_line.rst
View file @ 784c61a2
...@@ -55,5 +55,8 @@ directory. The output file list is as follows: ...@@ -55,5 +55,8 @@ directory. The output file list is as follows:
├── some_pdf_spans.pdf # smallest granularity bbox position information diagram ├── some_pdf_spans.pdf # smallest granularity bbox position information diagram
└── some_pdf_content_list.json # Rich text JSON arranged in reading order └── 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`
next_docs/zh_cn/.readthedocs.yaml → docs/zh_cn/.readthedocs.yaml
View file @ 784c61a2
...@@ -10,7 +10,7 @@ formats: ...@@ -10,7 +10,7 @@ formats:
python: python:
install: install:
- requirements: next_docs/requirements.txt - requirements: docs/requirements.txt
sphinx: sphinx:
configuration: next_docs/zh_cn/conf.py configuration: docs/zh_cn/conf.py
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment