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.
-cp (by @reycn)
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.
For different use cases, we provide distinct methods to use our program:
Python installed (3.10 <= version <= 3.12)
Install our package:
pip install uv
uv tool install --python 3.12 pdf2zh
Execute translation, files generated in current working directory:
pdf2zh document.pdf
Download pdf2zh-version-win64.zip from release page
Unzip and double-click pdf2zh.exe to run.
pip install pdf2zh
Start using in browser:
pdf2zh -i
If your browswer has not been started automatically, goto
http://localhost:7860/
See documentation for GUI for more details.
Pull and run:
docker pull byaidu/pdf2zh
docker run -d -p 7860:7860 byaidu/pdf2zh
Open in browser:
http://localhost:7860/
For docker deployment on cloud service:
Python installed (3.10 <= version <= 3.12)
Install our package:
pip install pdf2zh
Execute translation, files generated in current working directory:
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.
docker pull ghcr.io/byaidu/pdfmathtranslate docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate
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.
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 |
--skip-subset-fonts | Skip font subset | pdf2zh example.pdf --skip-subset-fonts |
--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 |
For detailed explanations, please refer to our document about Advanced Usage for a full list of each option.
For downstream applications, please refer to our document about API Details for futher information about:
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
Immersive Translation sponsors monthly Pro membership redemption codes for active contributors to this project, see details at: CONTRIBUTOR_REWARD.md
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
FAQs
Latex PDF Translator
We found that pdf2zh demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.