pdf2zh

English | [简体中文](docs/README_zh-CN.md) | [繁體中文](docs/README_zh-TW.md) | [日本語](docs/README_ja-JP.md) | [한국어](docs/README_ko-KR.md)

PDFMathTranslate

PDF scientific paper translation and bilingual comparison.

• 📊 Preserve formulas, charts, table of contents, and annotations (preview).
• 🌐 Support multiple languages, and diverse translation services.
• 🤖 Provides commandline tool, interactive user interface, and Docker

Feel free to provide feedback in GitHub Issues or Telegram Group.

For details on how to contribute, please consult the Contribution Guide.

Updates

• [Dec. 24 2024] The translator now supports local models on Xinference (by @imClumsyPanda)
• [Dec. 19 2024] Non-PDF/A documents are now supported using -cp (by @reycn)
• [Dec. 13 2024] Additional support for backend by (by @YadominJinta)
• [Dec. 10 2024] The translator now supports OpenAI models on Azure (by @yidasanqian)

Preview

Online Service 🌟

You can try our application out using either of the following demos:

• Public free service online without installation (recommended).
• Demo hosted on HuggingFace
• Demo hosted on ModelScope without installation.

Note that the computing resources of the demo are limited, so please avoid abusing them.

Installation and Usage

Methods

For different use cases, we provide distinct methods to use our program:

1. Commandline

1. Python installed (3.8 <= version <= 3.12) 2. Install our package: ```bash pip install pdf2zh ``` 3. Execute translation, files generated in [current working directory](https://chatgpt.com/share/6745ed36-9acc-800e-8a90-59204bd134): ```bash pdf2zh document.pdf ```

2. Portable (w/o Python installed)

1. Download [setup.bat](https://raw.githubusercontent.com/Byaidu/PDFMathTranslate/refs/heads/main/script/setup.bat) 2. Double-click to run. ```shell # 使用 setup.bat 是通过 python便携版安装库，便携版相比完整版会少一些 VC++ 依赖，导致错误：ImportError: DLL load failed while importing _extra: 找不到指定的模块 # 通过conda 安装的 python 环境，看到搜索路径 right path: ['J:\\code\\pdf2zh_fuck\\PDFMathTranslate', 'G:\\program\\micromamba\\envs\\pdf\\python312.zip', 'G:\\program\\micromamba\\envs\\pdf\\DLLs', 'G:\\program\\micromamba\\envs\\pdf\\Lib', 'G:\\program\\micromamba\\envs\\pdf', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages\\win32', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages\\win32\\lib', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages\\Pythonwin', 'G:\\program\\micromamba\\envs\\pdf\\Lib\\site-packages'] # 通过便携版安装的 python 环境，搜索路径 wrong path: ['J:\\code\\pdf2zh_fuck\\pdf2zh_dist', 'J:\\code\\pdf2zh_fuck\\pdf2zh_dist\\python312.zip', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages\\win32', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages\\win32\\lib', 'C:\\Users\\mg\\AppData\\Roaming\\Python\\Python312\\site-packages\\Pythonwin', 'J:\\code\\pdf2zh_fuck\\pdf2zh_dist\\Lib\\site-packages'] ```

3. Graphic user interface

1. Python installed (3.8 <= version <= 3.12) 2. Install our package: ```bash pip install pdf2zh ``` 3. Start using in browser: ```bash pdf2zh -i ``` 4. If your browswer has not been started automatically, goto ```bash http://localhost:7860/ ``` See [documentation for GUI](./docs/README_GUI.md) for more details.

4. Docker

1. Pull and run: ```bash docker pull byaidu/pdf2zh docker run -d -p 7860:7860 byaidu/pdf2zh ``` 2. Open in browser: ``` http://localhost:7860/ ``` For docker deployment on cloud service:

5. Zotero Plugin

See [Zotero PDF2zh](https://github.com/guaguastandup/zotero-pdf2zh) for more details.

6. conda package

```shell conda create -n pdf_env python==3.12 -y conda activate pdf_env uv pip install . python -m pdf2zh.pdf2zh -i --config config.json --onnx .\onnx\doclayout_yolo_docstructbench_imgsz1024.onnx conda activate base conda install -c conda-forge conda-pack -y conda pack -n pdf_env -o pdf_env.tar.gz mkdir -p pdf_env tar -xzf pdf_env.tar.gz -C pdf_env .\pdf_env\Scripts\activate.bat pdf2zh exzample.pdf Remove-Item -Path pdf_env.tar.gz # Compress-Archive -Path run_gui.bat, pdf2zh, pdf_env, onnx, config.json -DestinationPath pdf_translator.zip 7z a -tzip pdf_translator.zip run_gui.bat pdf2zh pdf_env onnx config.json conda env remove --name pdf_env -y ```

Unable to install?

The present program needs an AI model(wybxc/DocLayout-YOLO-DocStructBench-onnx) before working and some users are not able to download due to network issues. If you have a problem with downloading this model, we provide a workaround using the following environment variable:

set HF_ENDPOINT=https://hf-mirror.com

For PowerShell user:

$env:HF_ENDPOINT = https://hf-mirror.com

If the solution does not work to you / you encountered other issues, please refer to frequently asked questions.

Advanced Options

Execute the translation command in the command line to generate the translated document example-mono.pdf and the bilingual document example-dual.pdf in the current working directory. Use Google as the default translation service. More support translation services can find HERE.

In the following table, we list all advanced options for reference:

Option	Function	Example
files	Local files	pdf2zh ~/local.pdf
links	Online files	pdf2zh http://arxiv.org/paper.pdf
-i	Enter GUI	pdf2zh -i
-p	Partial document translation	pdf2zh example.pdf -p 1
-li	Source language	pdf2zh example.pdf -li en
-lo	Target language	pdf2zh example.pdf -lo zh
-s	Translation service	pdf2zh example.pdf -s deepl
-t	Multi-threads	pdf2zh example.pdf -t 1
-o	Output dir	pdf2zh example.pdf -o output
-f, -c	Exceptions	pdf2zh example.pdf -f "(MS.*)"
-cp	Compatibility Mode	pdf2zh example.pdf --compatible
--share	Public link	pdf2zh -i --share
--authorized	Authorization	pdf2zh -i --authorized users.txt [auth.html]
--prompt	Custom Prompt	pdf2zh --prompt [prompt.txt]
--onnx	[Use Custom DocLayout-YOLO ONNX model]	pdf2zh --onnx [onnx/model/path]
--serverport	[Use Custom WebUI port]	pdf2zh --serverport 7860
--dir	[batch translate]	pdf2zh --dir /path/to/translate/
--config	configuration file	pdf2zh --config /path/to/config/config.json
--serverport	[custom gradio server port]	pdf2zh --serverport 7860

For detailed explanations, please refer to our document about Advanced Usage for a full list of each option.

Secondary Development (APIs)

For downstream applications, please refer to our document about API Details for futher information about:

• Python API, how to use the program in other Python programs
• HTTP API, how to communicate with a server with the program installed

TODOs

• [ ] Parse layout with DocLayNet based models, PaddleX, PaperMage, SAM2

• [ ] Fix page rotation, table of contents, format of lists

• [ ] Fix pixel formula in old papers

• [ ] Async retry except KeyboardInterrupt

• [ ] Knuth–Plass algorithm for western languages

• [ ] Support non-PDF/A files

• [ ] Plugins of Zotero and Obsidian

Acknowledgements

• Document merging: PyMuPDF

• Document parsing: Pdfminer.six

• Document extraction: MinerU

• Document Preview: Gradio PDF

• Multi-threaded translation: MathTranslate

• Layout parsing: DocLayout-YOLO

• Document standard: PDF Explained, PDF Cheat Sheets

• Multilingual Font: Go Noto Universal

Contributors

Star History

Development

根据 pyproject.toml 字段 [build-system] 得知，作者是用 hatch 开发本项目， https://github.com/pypa/hatch

不过为了使用习惯，我使用 poetry 开发本项目。

# 安装 python 环境
pyenv install 3.12.0
# 或者使用 mamba 安装
mamba create -n pdf python=3.12 -y
mamba activate pdf
# 如果系统没有 poetry ，请先安装 poetry 。推荐全局安装 https://python-poetry.org/docs/#installing-with-the-official-installer
# 或者使用 pip 安装，仅在当前环境生效
pip install poetry
# 根据 pyproject.toml 安装依赖
poetry install
# 启动
poetry run pdf2zh
# 根据配置文件启动 GUI 
poetry run pdf2zh -i --config .\config.json