Przeglądaj źródła

refactor(readme): optimize detectron2 installation guide

Reorganize the installation instructions for Magic-PDF to clarify the dependency on
detectron2 and provide a more straightforward installation process. The update includes
separating the dependency installation from the package installation and adding a note
about precompiled wheels for Python 3.10.

BREAKING CHANGE: The installation guide now assumes basic familiarity with detectron2
installation requirements. Users who need to compile detectron2 from source should refer
to the official detectron2 documentation.
myhloli 1 rok temu
rodzic
commit
69ce578cd8
3 zmienionych plików z 33 dodań i 25 usunięć
  1. 11 9
      README.md
  2. 11 9
      README_ja-JP.md
  3. 11 7
      README_zh-CN.md

+ 11 - 9
README.md

@@ -100,7 +100,17 @@ conda activate MinerU
 
 #### 1. Install Magic-PDF
 
-Install the full-feature package with pip:
+**1.Install dependencies**
+
+The full-feature package depends on detectron2, which requires a compilation installation.   
+If you need to compile it yourself, please refer to https://github.com/facebookresearch/detectron2/issues/5114  
+Alternatively, you can directly use our precompiled whl package (limited to Python 3.10):
+
+```bash
+pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/
+```
+
+**2.Install the full-feature package with pip**
 >Note: The pip-installed package supports CPU-only and is ideal for quick tests.
 >
 >For CUDA/MPS acceleration in production, see [Acceleration Using CUDA or MPS](#4-Acceleration-Using-CUDA-or-MPS).
@@ -114,14 +124,6 @@ pip install magic-pdf[full]==0.6.2b1
 > pip install magic-pdf[full-cpu]==0.6.1
 > ```
 
- 
-The full-feature package depends on detectron2, which requires a compilation installation.   
-If you need to compile it yourself, please refer to https://github.com/facebookresearch/detectron2/issues/5114  
-Alternatively, you can directly use our precompiled whl package (limited to Python 3.10):
-
-```bash
-pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/
-```
 
 
 #### 2. Downloading model weights files

+ 11 - 9
README_ja-JP.md

@@ -100,7 +100,17 @@ conda activate MinerU
 
 #### 1. Magic-PDFのインストール
 
-pipを使用してフル機能パッケージをインストールします:
+**1.依存パッケージのインストール**
+
+フル機能パッケージはdetectron2に依存しており、コンパイルインストールが必要です。   
+自分でコンパイルする必要がある場合は、https://github.com/facebookresearch/detectron2/issues/5114 を参照してください。  
+または、私たちの事前コンパイルされたwhlパッケージを直接使用できます(Python 3.10に限定):
+
+```bash
+pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/
+```
+
+**2.pipを使用してフル機能パッケージをインストールします**
 >注意:pipでインストールされたパッケージはCPUのみをサポートし、クイックテストに最適です。
 >
 >CUDA/MPSによる加速については、[CUDAまたはMPSによる加速](#4-CUDAまたはMPSによる加速)を参照してください。
@@ -115,14 +125,6 @@ pip install magic-pdf[full]==0.6.2b1
 > pip install magic-pdf[full-cpu]==0.6.1
 > ```
 
-フル機能パッケージはdetectron2に依存しており、コンパイルインストールが必要です。   
-自分でコンパイルする必要がある場合は、https://github.com/facebookresearch/detectron2/issues/5114 を参照してください。  
-または、私たちの事前コンパイルされたwhlパッケージを直接使用できます(Python 3.10に限定):
-
-```bash
-pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/
-```
-
 
 #### 2. モデルの重みファイルのダウンロード
 

+ 11 - 7
README_zh-CN.md

@@ -94,7 +94,16 @@ conda activate MinerU
 
 #### 1. 安装Magic-PDF
 
-使用pip安装完整功能包:
+**1.安装依赖**
+
+完整功能包依赖detectron2,该库需要编译安装,如需自行编译,请参考 https://github.com/facebookresearch/detectron2/issues/5114  
+或是直接使用我们预编译的whl包:
+> ❗️预编译版本仅支持64位系统(windows/linux/macOS)+pyton 3.10平台;不支持任何32位系统和非mac的arm平台,如系统不支持请自行编译安装。
+```bash
+pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/ -i https://pypi.tuna.tsinghua.edu.cn/simple 
+```
+
+**2.使用pip安装完整功能包**
 > 受pypi限制,pip安装的完整功能包仅支持cpu推理,建议只用于快速测试解析能力。
 >
 > 如需在生产环境使用CUDA/MPS加速请参考[使用CUDA或MPS加速推理](#4-使用CUDA或MPS加速推理)
@@ -107,12 +116,7 @@ pip install magic-pdf[full]==0.6.2b1 -i https://mirrors.aliyun.com/pypi/simple/
 > pip install magic-pdf[full-cpu]==0.6.1
 > ```
 
-完整功能包依赖detectron2,该库需要编译安装,如需自行编译,请参考 https://github.com/facebookresearch/detectron2/issues/5114  
-或是直接使用我们预编译的whl包:
-> ❗️预编译版本仅支持64位系统(windows/linux/macOS)+pyton 3.10平台;不支持任何32位系统和非mac的arm平台,如系统不支持请自行编译安装。
-```bash
-pip install detectron2 --extra-index-url https://myhloli.github.io/wheels/ -i https://pypi.tuna.tsinghua.edu.cn/simple 
-```
+
 
 #### 2. 下载模型权重文件