Commit 820e625f authored by myhloli's avatar myhloli
Browse files

feat(README): add MPS acceleration support for Apple silicon

- Added information about MPS acceleration support for Apple silicon chips- Updated README files to include MPS-related content and configuration instructions
- Improved language and formatting consistency across both English and Chinese README files
parent 203b8f90
...@@ -139,7 +139,7 @@ https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c ...@@ -139,7 +139,7 @@ https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c
- OCR supports detection and recognition of 84 languages. - OCR supports detection and recognition of 84 languages.
- Supports multiple output formats, such as multimodal and NLP Markdown, JSON sorted by reading order, and rich intermediate formats. - Supports multiple output formats, such as multimodal and NLP Markdown, JSON sorted by reading order, and rich intermediate formats.
- Supports various visualization results, including layout visualization and span visualization, for efficient confirmation of output quality. - Supports various visualization results, including layout visualization and span visualization, for efficient confirmation of output quality.
- Supports running in a pure CPU environment, and also supports GPU/NPU acceleration - Supports running in a pure CPU environment, and also supports GPU(CUDA)/NPU(CANN)/MPS acceleration
- Compatible with Windows, Linux, and Mac platforms. - Compatible with Windows, Linux, and Mac platforms.
## Quick Start ## Quick Start
...@@ -150,9 +150,10 @@ There are three different ways to experience MinerU: ...@@ -150,9 +150,10 @@ There are three different ways to experience MinerU:
- [Online Demo (No Installation Required)](#online-demo) - [Online Demo (No Installation Required)](#online-demo)
- [Quick CPU Demo (Windows, Linux, Mac)](#quick-cpu-demo) - [Quick CPU Demo (Windows, Linux, Mac)](#quick-cpu-demo)
- Accelerate inference by using CUDA/CANN - Accelerate inference by using CUDA/CANN/MPS
- [Linux/Windows + CUDA](#Using-GPU) - [Linux/Windows + CUDA](#Using-GPU)
- [Linux + CANN](#using-npu) - [Linux + CANN](#using-npu)
- [MacOS + MPS](#using-mps)
> [!WARNING] > [!WARNING]
> **Pre-installation Notice—Hardware and Software Environment Support** > **Pre-installation Notice—Hardware and Software Environment Support**
...@@ -301,6 +302,24 @@ If your device has NPU acceleration hardware, you can follow the tutorial below ...@@ -301,6 +302,24 @@ If your device has NPU acceleration hardware, you can follow the tutorial below
[Ascend NPU Acceleration](docs/README_Ascend_NPU_Acceleration_zh_CN.md) [Ascend NPU Acceleration](docs/README_Ascend_NPU_Acceleration_zh_CN.md)
### Using MPS
If your device uses Apple silicon chips, you can enable MPS acceleration for certain supported tasks (such as layout detection and formula detection).
You can enable MPS acceleration by setting the `device-mode` parameter to `mps` in the `magic-pdf.json` configuration file.
```json
{
// other config
"device-mode": "mps"
}
```
> [!TIP]
> Since the formula recognition task cannot utilize MPS acceleration, you can disable the formula recognition feature in tasks where it is not needed to achieve optimal performance.
>
> You can disable the formula recognition feature by setting the `enable` parameter in the `formula-config` section to `false`.
## Usage ## Usage
### Command Line ### Command Line
......
...@@ -139,7 +139,7 @@ https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c ...@@ -139,7 +139,7 @@ https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c
- OCR支持84种语言的检测与识别 - OCR支持84种语言的检测与识别
- 支持多种输出格式,如多模态与NLP的Markdown、按阅读顺序排序的JSON、含有丰富信息的中间格式等 - 支持多种输出格式,如多模态与NLP的Markdown、按阅读顺序排序的JSON、含有丰富信息的中间格式等
- 支持多种可视化结果,包括layout可视化、span可视化等,便于高效确认输出效果与质检 - 支持多种可视化结果,包括layout可视化、span可视化等,便于高效确认输出效果与质检
- 支持纯CPU环境运行,并支持GPU/NPU加速 - 支持纯CPU环境运行,并支持 GPU(CUDA)/NPU(CANN)/MPS 加速
- 兼容Windows、Linux和Mac平台 - 兼容Windows、Linux和Mac平台
## 快速开始 ## 快速开始
...@@ -152,7 +152,8 @@ https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c ...@@ -152,7 +152,8 @@ https://github.com/user-attachments/assets/4bea02c9-6d54-4cd6-97ed-dff14340982c
- [使用CPU快速体验(Windows,Linux,Mac)](#使用cpu快速体验) - [使用CPU快速体验(Windows,Linux,Mac)](#使用cpu快速体验)
- 使用 CUDA/CANN 加速推理 - 使用 CUDA/CANN 加速推理
- [Linux/Windows + CUDA](#使用gpu) - [Linux/Windows + CUDA](#使用gpu)
- [Linux + CANN](#使用NPU) - [Linux + CANN](#使用npu)
- [MacOS + MPS](#使用mps)
> [!WARNING] > [!WARNING]
...@@ -305,6 +306,24 @@ pip install -U magic-pdf[full] --extra-index-url https://wheels.myhloli.com -i h ...@@ -305,6 +306,24 @@ pip install -U magic-pdf[full] --extra-index-url https://wheels.myhloli.com -i h
[NPU加速教程](docs/README_Ascend_NPU_Acceleration_zh_CN.md) [NPU加速教程](docs/README_Ascend_NPU_Acceleration_zh_CN.md)
### 使用MPS
如果您的设备使用Apple silicon 芯片,您可以在部分支持的任务(layout检测/公式检测)中开启mps加速:
您可以通过在 `magic-pdf.json` 配置文件中将 `device-mode` 参数设置为 `mps` 来启用 MPS 加速。
```json
{
// other config
"device-mode": "mps"
}
```
> [!TIP]
> 由于公式识别任务无法开启mps加速,您可在不需要识别公式的任务关闭公式识别功能以获得最佳性能。
>
> 您可以通过将 `formula-config` 部分中的 `enable` 参数设置为 `false` 来禁用公式识别功能。
## 使用 ## 使用
### 命令行 ### 命令行
......
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