PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译，支持 Google/DeepL/Ollama/OpenAI 等服务，提供 CLI/GUI/Docker

English | 简体中文

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, Telegram Group or QQ Group.

• [Nov. 26 2024] CLI now supports online file(s) (by @reycn)
• [Nov. 24 2024] ONNX support to reduce dependency sizes (by @Wybxc)
• [Nov. 23 2024] 🌟 Public Service online! (by @Byaidu)
• [Nov. 23 2024] Firewall for preventing web bots (by @Byaidu)
• [Nov. 22 2024] GUI now supports Italian, and has been improved (by @Byaidu, @reycn)
• [Nov. 22 2024] You can now share your deployed service to others (by @Zxis233)
• [Nov. 22 2024] Now supports Tencent Translation (by @hellofinch)
• [Nov. 21 2024] GUI now supports downloading dual-document (by @reycn)
• [Nov. 20 2024] 🌟 Demo online! (by @reycn)

You can try our public service online without installation.

You can try our demo on HuggingFace without installation. Note that the computing resources of the demo are limited, so please avoid abusing them.

We provide three methods for using this project: Commandline, Portable, GUI, and Docker.

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

2. Install our package:

   pip install pdf2zh

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

   pdf2zh document.pdf

No need to pre-install Python environment

Download setup.bat and double-click to run

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

2. Install our package:

   pip install pdf2zh

3. Start using in browser:

   pdf2zh -i

4. If your browswer has not been started automatically, goto

   http://localhost:7860/

   

See documentation for GUI for more details.

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:

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.

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

• Entire document

  pdf2zh example.pdf

• Part of the document

  pdf2zh example.pdf -p 1-3,5

See Google Languages Codes, DeepL Languages Codes

pdf2zh example.pdf -li en -lo ja

The table below outlines the required environment variables for each translation service. Make sure to set them before using the respective service.

Use -s service or -s service:model to specify service:

pdf2zh example.pdf -s openai:gpt-4o-mini

Or specify model with environment variables:

set OPENAI_MODEL=gpt-4o-mini
pdf2zh example.pdf -s openai

Use regex to specify formula fonts and characters that need to be preserved:

pdf2zh example.pdf -f "(CM[^RT].*|MS.*|.*Ital)" -c "(\(|\||\)|\+|=|\d|[\u0080-\ufaff])"

Use -t to specify how many threads to use in translation:

pdf2zh example.pdf -t 1

from pdf2zh import translate, translate_stream

params = {"lang_in": "en", "lang_out": "zh", "service": "google", "thread": 4}
file_mono, file_dual = translate(files=["example.pdf"], **params)[0]
with open("example.pdf", "rb") as f:
    stream_mono, stream_dual = translate_stream(stream=f.read(), **params)

pip install pdf2zh[backend]
pdf2zh --flask
pdf2zh --celery worker

curl http://localhost:11008/v1/translate -F "file=@example.pdf" -F "data={\"lang_in\":\"en\",\"l
ang_out\":\"zh\",\"service\":\"google\",\"thread\":4}"
{"id":"d9894125-2f4e-45ea-9d93-1a9068d2045a"}

curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a
{"info":{"n":13,"total":506},"state":"PROGRESS"}

curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a
{"state":"SUCCESS"}

curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a/mono --output example-mono.pdf

curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a/dual --output example-dual.pdf

curl http://localhost:11008/v1/translate/d9894125-2f4e-45ea-9d93-1a9068d2045a -X DELETE

• 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

• Document merging: PyMuPDF

• Document parsing: Pdfminer.six

• Document extraction: MinerU

• Multi-threaded translation: MathTranslate

• Layout parsing: DocLayout-YOLO

• Document standard: PDF Explained, PDF Cheat Sheets

• Multilingual Font: Go Noto Universal