A favicon of PDFMathTranslate

PDFMathTranslate

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

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

  • [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

image

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 browswer has not been started automatically, goto

    http://localhost:7860/
    
    image

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:

OptionFunctionExample
filesLocal filespdf2zh ~/local.pdf
linksOnline filespdf2zh http://arxiv.org/paper.pdf
-iEnter GUIpdf2zh -i
-pPartial document translationpdf2zh example.pdf -p 1
-liSource languagepdf2zh example.pdf -li en
-loTarget languagepdf2zh example.pdf -lo zh
-sTranslation servicepdf2zh example.pdf -s deepl
-tMulti-threadspdf2zh example.pdf -t 1
-oOutput dirpdf2zh example.pdf -o output
-f, -cExceptionspdf2zh example.pdf -f "(MS.*)"
-cpCompatibility Modepdf2zh example.pdf --compatible
--skip-subset-fontsSkip font subsetpdf2zh example.pdf --skip-subset-fonts
--ignore-cacheIgnore translate cachepdf2zh example.pdf --ignore-cache
--sharePublic linkpdf2zh -i --share
--authorizedAuthorizationpdf2zh -i --authorized users.txt [auth.html]
--promptCustom Promptpdf2zh --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/
--configconfiguration filepdf2zh --config /path/to/config/config.json
--serverport[custom gradio server port]pdf2zh --serverport 7860
--babeldocUse Experimental backend BabelDOC to translatepdf2zh --babeldoc -s openai example.pdf

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

Secondary Development (APIs)

The current pdf2zh API is temporarily deprecated. The API will be provided again after pdf2zh 2.0 is released. For users who need programmatic access, please use the babeldoc.high_level.async_translate function of BabelDOC.

This API being temporarily deprecated means: the relevant code will not be removed for now, but no technical support will be provided, and no bug fixes will be made.

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

image

Alt

Star History

Star History Chart
Share:
Details:
  • Stars


    0
  • Forks


    0
  • Last commit


    1 month ago
  • Repository age


    1 month
  • License


    AGPL-3.0
View Repository

Auto-fetched from GitHub .

MCP servers similar to PDFMathTranslate:

 

 
 
  • Stars


  • Forks


  • Last commit


 

 
 
  • Stars


  • Forks


  • Last commit


 

 
 
  • Stars


  • Forks


  • Last commit