MCPcopy Index your code
hub / github.com/PDFMathTranslate/PDFMathTranslate

github.com/PDFMathTranslate/PDFMathTranslate @v1.9.11 sqlite

repository ↗ · DeepWiki ↗ · release v1.9.11 ↗
255 symbols 934 edges 16 files 62 documented · 24% 9 cross-repo links
README

English | 简体中文 | 繁體中文 | 日本語 | 한국어

PDF2ZH

PDFMathTranslate

Featured|HelloGitHub

Byaidu%2FPDFMathTranslate | Trendshift

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

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

  3. Install our package:

bash pip install uv uv tool install --python 3.12 pdf2zh

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

bash pdf2zh document.pdf

  1. Windows exe

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

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

  4. Graphic user interface

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

  6. Install our package:

pip install pdf2zh
  1. Start using in browser:

bash pdf2zh -i

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

bash http://localhost:7860/

See documentation for GUI for more details.

  1. Docker

  2. Pull and run:

bash docker pull byaidu/pdf2zh docker run -d -p 7860:7860 byaidu/pdf2zh

  1. Open in browser:

http://localhost:7860/

For docker deployment on cloud service:

Deploy Deploy to Koyeb Deploy on Zeabur Deploy on Sealos Deploy to Koyeb

  1. Zotero Plugin

See Zotero PDF2zh for more details.

  1. Commandline

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

  3. Install our package:

bash pip install pdf2zh

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

bash pdf2zh document.pdf

[!TIP]

  • If you're using Windows and cannot open the file after downloading, please install vc_redist.x64.exe and try again.

  • If you cannot access Docker Hub, please try the image on GitHub Container Registry. bash 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

Core symbols most depended-on inside this repo

get
called by 43
pdf2zh/config.py
set_envs
called by 19
pdf2zh/translator.py
translate
called by 14
pdf2zh/translator.py
add_cache_impact_parameters
called by 13
pdf2zh/translator.py
prompt
called by 13
pdf2zh/translator.py
get
called by 13
pdf2zh/cache.py
set
called by 13
pdf2zh/cache.py
_save_config
called by 11
pdf2zh/config.py

Shape

Method 160
Class 48
Function 41
Route 6

Languages

Python100%

Modules by API surface

pdf2zh/translator.py77 symbols
pdf2zh/pdfinterp.py21 symbols
pdf2zh/converter.py18 symbols
test/test_translator.py17 symbols
pdf2zh/doclayout.py17 symbols
pdf2zh/config.py17 symbols
pdf2zh/gui.py13 symbols
pdf2zh/cache.py13 symbols
pdf2zh/backend.py13 symbols
test/test_doclayout.py11 symbols
test/test_converter.py11 symbols
test/test_cache.py11 symbols

Dependencies from manifests, versioned

azure-ai-translation-text1.0.1 · 1×
deepl
fontTools
gradio_pdf0.0.21 · 1×
onnx
onnxruntime
openai1.0.0 · 1×
opencv-python-headless
pdfminer-six20250416 · 1×

For agents

$ claude mcp add PDFMathTranslate \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact