PDFMathTranslate

PDFMathTranslate

Enables AI to translate PDF scientific papers with formulas and charts while preserving original layout

Translation Language by Byaidu AGPL-3.0
🔗 GitHub
📚 중급 Difficulty
⭐ 24.6K GitHub Stars
🚀 v1.9.10 Release

📖 README

PDF scientific paper translation and bilingual comparison.

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

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

Updates

  • [May 9, 2025] pdf2zh 2.0 Preview Version #586: The Windows ZIP file and Docker image are now available.

ℹ️ Note

2.0 Moved to a new repository under the organization: PDFMathTranslate/PDFMathTranslate-next

Version 2.0 official release has been published.

  • [Mar. 3, 2025] Experimental support for the new backend BabelDOC WebUI added as an experimental option (by @awwaawwa)
  • [Feb. 22 2025] Better release CI and well-packaged windows-amd64 exe (by @awwaawwa)
  • [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:

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. UV install

  1. Python installed (3.10 <= version <= 3.12)

  2. Install our package:

    pip install uv
uv tool install --python 3.12 pdf2zh

  3. Execute translation, files generated in current working directory:

    pdf2zh document.pdf
2. Windows exe

  1. Download pdf2zh-version-win64.zip from release page

  2. Unzip and double-click pdf2zh.exe to run.

3. Graphic user interface

  1. Python installed (3.10 <= version <= 3.12)

  2. Install our package:

pip install pdf2zh

  1. Start using in browser:

    pdf2zh -i

  2. If your browser has not been started automatically, goto

    http://localhost:7860/

See documentation for GUI for more details.

4. Docker

  1. Pull and run:

    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 for more details.

6. Commandline

  1. Python installed (3.10 <= version <= 3.12)

  2. Install our package:

    pip install pdf2zh

  3. Execute translation, files generated in current working directory:

    pdf2zh document.pdf

💡 Tip

docker pull ghcr.io/byaidu/pdfmathtranslate
docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate

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.

cmd

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
--skip-subset-fonts Skip font subset pdf2zh example.pdf --skip-subset-fonts
--ignore-cache Ignore translate cache pdf2zh example.pdf --ignore-cache
--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
--babeldoc Use Experimental backend BabelDOC to translate pdf2zh --babeldoc -s openai example.pdf
--mcp Enable MCP STDIO mode pdf2zh --mcp
--sse Enable MCP SSE mode pdf2zh --mcp --sse

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 further 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

Contributors

Alt

Star History

 Star History Chart