selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

PDFMathTranslate logo

Self-host PDFMathTranslate

v1.9.11

Layout-preserving scientific PDF translator with CLI and GUI

ReleaseOpen SourceAGPL-3.0
docker run -d -p 7860:7860 byaidu/pdf2zh
Updated3 weeks ago
LanguagePython
Setup difficultyEasy
Stars
38 291
Port
7860 (Gradio web GUI)
Docker
byaidu/pdf2zh
Web GUI in use: upload a PDF and translate it in the browser

What is PDFMathTranslate?

PDFMathTranslate (package name pdf2zh) translates scientific PDF documents while keeping the original formatting intact, including formulas, charts, tables of contents and annotations. It is aimed at researchers and anyone reading papers in a foreign language, and it produces both a single-language and a bilingual output file per document. You can point it at local files or URLs, choose the source and target language, restrict the page range, batch a whole directory, override the translation prompt for LLMs, and select from many machine-translation or LLM backends configured through environment variables. Running it yourself is straightforward: pip or uv install and call the pdf2zh command, launch the Gradio GUI with pdf2zh -i, download a Windows zip app, or run the byaidu/pdf2zh container and open port 7860; a Docker image is also published on GitHub Container Registry. Scanned-page OCR, the v2 precise layout kernel and the BabelDOC backend are labelled experimental, and the model weights are fetched from Hugging Face on first run, which may need a mirror in restricted regions.

PDFMathTranslate alternatives

Should you self-host PDFMathTranslate?

PDFMathTranslate scores 80/100 on selfhost.directory (how scoring works) and ranks #1 of 11 in Translation. It has 38 291 GitHub stars, +579 in the last 30 days.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available. It is AGPL-3.0-licensed and written mostly in Python.

Its closest alternative on selfhost.directory is LibreTranslate (76/100, 17 314 stars). PDFMathTranslate scores higher overall. See PDFMathTranslate vs LibreTranslate side by side.

Features

  • Batch directory translation
  • Bilingual (dual) output PDF
  • Command-line tool
  • Custom translation promptSystem prompt currently not supported
  • Layout-preserving PDF translation
  • MCP server mode
  • Multiple translation engines
  • Multi-threaded translation
  • OCR of scanned pageslabelled experimental in the changelog
  • Partial page-range translation
  • Python and HTTP API
  • Translation caching
  • Ultrafast layout modeCLI fast mode only; optional pdf2zh[ultrafast] extra
  • Web GUI
  • Web UI user authorization

PDFMathTranslate README


1. What does this do?

Scientific PDF document translation preserving layouts.

2. Recent Updates

  • [October 3, 2026] Translated PDFs automatically add spaces between adjacent CJK and Latin letters, including accented letters, in normal and --ultrafast modes.

  • [October 2, 2026] Added the --ultrafast CLI mode for native-text PDFs. It uses pdf-inspector text positions for heuristic layout and skips ONNX layout and OCR. (by @reycn)

  • [September 8, 2026] Experimental OCR support, with paragraph regrouping and adaptive typesetting. (by @reycn)

  • [March 23, 2026] Experimental support for v2.0 translation kernel using isolated environment (--mode precise). (by @reycn)

  • [March 22, 2026] Supporting MiniMax (PR by @octo-patch)

  • [March 22, 2026] Fixing OpenAI-related issues (PR by @samqin123)

  • [March 22, 2026] Fixing HTTP-related issues (PR by @soukouki)

  • [March 22, 2026] Faster model loading on mac and OONX platforms, GUI starting-up, version printing, and continuous integration.(by @reycn)

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

3. Use 🌟

3.1 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.

3.2 Local Installation

For different use cases, we provide distinct methods to use our program:

3.2.1 Python: Install using uv
  1. Python installed (3.11 <= 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
3.2.2 Python: Install using pip
  1. Python installed (3.11 <= version <= 3.12)

  2. Install our package:

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

    pdf2zh document.pdf
3.3.3 Python: Graphic user interface
  1. Python installed (3.11 <= 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.

3.2.4 Application: On Windows
  1. Download pdf2zh-version-win64.zip from release page

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

[!TIP]

  • If you're using Windows and cannot open the file after downloading, please install vc_redist.x64.exe and try again.
3.2.5 Reference manager: Zotero Plugin

See Zotero PDF2zh for more details.

3.2.6 Docker: Containerized Deployment
  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:

[!TIP]

docker pull ghcr.io/byaidu/pdfmathtranslate
docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate
3.2.* Solutions for network issues in installation

Users in specific regions may encounter network difficulties when loading the AI model. The current program relies on the AI model (wybxc/DocLayout-YOLO-DocStructBench-onnx), and some users are unable to download it due to these network issues.

To address issues with downloading this model, use the following environment variable as a workaround:

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.

4. Technical Details

Experimental automatic OCR (fast mode)

Fast mode automatically runs local OCR on selected image-only pages before translation. Native text, existing OCR layers, and blank pages are skipped; the original pages in dual output remain unchanged. Install with pip install 'pdf2zh[ocr]' (or pip install -e '.[ocr]' from this checkout). The first scanned page downloads the requested language data from Tesseract's tessdata_fast 4.1.0 release into ~/.cache/pdf2zh/tessdata/4.1.0; subsequent runs reuse it offline. Native-text PDFs do not trigger downloads. OCR uses the input language; PDF2ZH_OCR_LANGUAGE=eng+deu overrides it with Tesseract language codes. Set TESSDATA_PREFIX to use your own data without automatic downloads.

PyMuPDF supplies the OCR engine; the optional extra adds Pooch for cached downloads. No separate Tesseract executable is required. OCR words are regrouped into paragraphs within detected layout regions before translation, with wrapped lines and soft hyphens joined. Translated paragraphs start at the median source font size and shrink to fit their original boxes; detected figures, tables, and standalone formulas remain untouched. The initial implementation targets white-background scans: partial scans on pages that already contain text are skipped, and handwritten text or inline equations may be recognized incorrectly. Precise mode is unchanged.

Ultrafast mode

Install the optional pdf-inspector>=1.25.2,<2 dependency with pip install 'pdf2zh[ultrafast]', then run:

pdf2zh example.pdf --ultrafast

--ultrafast uses native PDF text positions from pdf-inspector for heuristic layout. It skips ONNX layout and OCR; pages without native text are preserved without OCR. Its heuristic text grouping retains the usual font and character formula safeguards. It is best suited to PDFs that already contain native text; use normal mode for complex tables or formulas. It is available only in fast CLI mode and cannot be combined with --mode precise, --babeldoc, server or GUI modes, or --onnx. It automatically skips font subsetting, so its output PDFs are larger, while still using BabelDOC font assets as needed. With --ignore-cache, it bypasses both translation-cache reads and writes; normal mode keeps its existing --ignore-cache behavior. Ultrafast uses a shared whole-document paragraph worker pool with 16 workers by default and submits individual paragraph requests; -t overrides this value, while normal mode keeps its default of 4. [ultrafast perf] INFO logs report stage and per-page timings. page_scan is the paragraph-submission scan; translation is the elapsed wait for the whole-document pool to drain, including API retries, so it is not a sum of per-page waits. paragraph_parse covers both passes, typesetting runs after translation completes, and layout_extract is reported separately before font setup. page_processing includes nested layout_mask, paragraph_parse, translation, and typesetting timings, so do not sum the nested values again. This path does not import ONNX or OpenCV.

4.1 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
--ultrafast Use native PDF text positions for heuristic layout; skip ONNX layout and OCR pdf2zh example.pdf --ultrafast
--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
--mode Translation mode: fast (default, v1) or precise (v2, experimental, requires pdf2zh_next submodule) pdf2zh --mode precise example.pdf
--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.

4.2 Downstream Development
For downstream applications, please refer to our document about [API Details](./docs/APIS.md) 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
4.3 Differences between two major forks
  • Byaidu/PDFMathTranslate: The present and the original project for stable release.

  • PDFMathTranslate/PDFMathTranslate-next: A fork with web-ui and additional features. This fork handles a large number of marginal cases, improves PDF compatibility, and optimizes cross-column and cross-page semantic consistency, dynamic scaling, and dynamic scaling consistency, among many other translation quality improvements. However, this fork is intended solely for development and does not address compatibility issues and is not designed for community-contributions.

5. Project Information

5.1 Citation

This work has been accepted by the Proceedings of the 2025 Conference on Empirical Methods in Natural Language Processing: System Demonstrations (EMNLP 2025).

Citation:

@inproceedings{ouyang-etal-2025-pdfmathtranslate,
	    title = "{PDFM}ath{T}ranslate: Scientific Document Translation Preserving Layouts",
	    author = "Ouyang, Rongxin  and
	      Chu, Chang  and
	      Xin, Zhikuang  and
	      Ma, Xiangyao",
	    editor = {Habernal, Ivan  and
	      Schulam, Peter  and
	      Tiedemann, J{\"o}rg},
	    booktitle = "Proceedings of the 2025 Conference on Empirical Methods in Natural Language Processing: System Demonstrations",
	    month = nov,
	    year = "2025",
	    address = "Suzhou, China",
	    publisher = "Association for Computational Linguistics",
	    url = "https://aclanthology.org/2025.emnlp-demos.71/",
	    pages = "918--924",
	    ISBN = "979-8-89176-334-0",
	    abstract = "Language barriers in scientific documents hinder the diffusion and development of science and technologies. However, prior efforts in translating such documents largely overlooked the information in layouts. To bridge the gap, we introduce PDFMathTranslate, the world{'}s first open-source software for translating scientific documents while preserving layouts. Leveraging the most recent advances in large language models and precise layout detection, we contribute to the community with key improvements in precision, flexibility, and efficiency. The work is open-sourced at https://github.com/byaidu/pdfmathtranslate with more than 222k downloads."
	}
5.2 Acknowledgement
5.3 Contributors

Alt

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

5.4 Star History
Star history

How to install PDFMathTranslate

Install PDFMathTranslate with Docker

  1. Pull and run:
docker pull byaidu/pdf2zh
docker run -d -p 7860:7860 byaidu/pdf2zh
  1. Open in browser:
http://localhost:7860/

Also mirrored at ghcr.io/byaidu/pdfmathtranslate if Docker Hub is unreachable.

How to configure PDFMathTranslate

  • OPENAI_BASE_URLhttps://api.openai.com/v1Base URL of the OpenAI-compatible API used by the openai translator.
  • OPENAI_API_KEYAPI key for the OpenAI translation service.
  • OPENAI_MODELgpt-4o-miniModel used by the OpenAI translation service.
  • OPENAI_STOP_TOKENSStop tokens for the OpenAI translator.
  • OPENAI_MAX_TOKENS-1Maximum tokens per request for the OpenAI translator.

PDFMathTranslate releases & version history

@ Every self-hosted release, weekly

One Monday email with the week's stable releases across the directory.

More in Translation

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…