PDF scientific paper translation and bilingual comparison.
- đ Retain formulas and charts.
- đ Preserve table of contents.
- đ Support multiple translation services.
Feel free to provide feedback in [issues](https://github.com/Byaidu/PDFMathTranslate/issues) or [user group](https://t.me/+Z9_SgnxmsmA5NzBl).
## Installation
Require Python version >=3.8, <=3.12
```bash
pip install pdf2zh
```
## Usage
Execute the translation command in the command line to generate the translated document `example-zh.pdf` and the bilingual document `example-dual.pdf` in the current directory. Use Google as the default translation service.
Please refer to [ChatGPT](https://chatgpt.com/share/6734a83d-9d48-800e-8a46-f57ca6e8bcb4) for how to set environment variables.
### Full / partial document translation
- Entire document
```bash
pdf2zh example.pdf
```
- Part of the document
```bash
pdf2zh example.pdf -p 1-3,5
```
### Specify source and target languages
See [Google Languages Codes](https://developers.google.com/admin-sdk/directory/v1/languages), [DeepL Languages Codes](https://developers.deepl.com/docs/resources/supported-languages)
```bash
pdf2zh example.pdf -li en -lo ja
```
### Translate with Different Services
- **DeepL**
See [DeepL](https://support.deepl.com/hc/en-us/articles/360020695820-API-Key-for-DeepL-s-API)
Set ENVs to construct an endpoint like: `{DEEPL_SERVER_URL}/translate`
- `DEEPL_SERVER_URL` (Optional), e.g., `export DEEPL_SERVER_URL=https://api.deepl.com`
- `DEEPL_AUTH_KEY`, e.g., `export DEEPL_AUTH_KEY=xxx`
```bash
pdf2zh example.pdf -s deepl
```
- **DeepLX**
See [DeepLX](https://github.com/OwO-Network/DeepLX)
Set ENVs to construct an endpoint like: `{DEEPL_SERVER_URL}/translate`
- `DEEPLX_SERVER_URL` (Optional), e.g., `export DEEPLX_SERVER_URL=https://api.deeplx.org`
- `DEEPLX_AUTH_KEY`, e.g., `export DEEPLX_AUTH_KEY=xxx`
```bash
pdf2zh example.pdf -s deeplx
```
- **Ollama**
See [Ollama](https://github.com/ollama/ollama)
Set ENVs to construct an endpoint like: `{OLLAMA_HOST}/api/chat`
- `OLLAMA_HOST` (Optional), e.g., `export OLLAMA_HOST=https://localhost:11434`
```bash
pdf2zh example.pdf -s ollama:gemma2
```
- **LLM with OpenAI compatible schemas (OpenAI / SiliconCloud / Zhipu)**
See [SiliconCloud](https://docs.siliconflow.cn/quickstart), [Zhipu](https://open.bigmodel.cn/dev/api/thirdparty-frame/openai-sdk)
Set ENVs to construct an endpoint like: `{OPENAI_BASE_URL}/chat/completions`
- `OPENAI_BASE_URL` (Optional), e.g., `export OPENAI_BASE_URL=https://api.openai.com/v1`
- `OPENAI_API_KEY`, e.g., `export OPENAI_API_KEY=xxx`
```bash
pdf2zh example.pdf -s openai:gpt-4o
```
- **Azure**
See [Azure Text Translation](https://docs.azure.cn/en-us/ai-services/translator/text-translation-overview)
Following ENVs are required:
- `AZURE_APIKEY`, e.g., `export AZURE_APIKEY=xxx`
- `AZURE_ENDPOINT`, e.g, `export AZURE_ENDPOINT=https://api.translator.azure.cn/`
- `AZURE_REGION`, e.g., `export AZURE_REGION=chinaeast2`
```bash
pdf2zh example.pdf -s azure
```
### Translate wih exceptions
Use regex to specify formula fonts and characters that need to be preserved.
```bash
pdf2zh example.pdf -f "(CM[^RT].*|MS.*|.*Ital)" -c "(\(|\||\)|\+|=|\d|[\u0080-\ufaff])"
```
### Interact with GUI
```bash
pdf2zh -i
```
See [documentation for GUI](./docs/README_GUI.md) for more details.
## Preview
## Acknowledgement
Document merging: [PyMuPDF](https://github.com/pymupdf/PyMuPDF)
Document parsing: [Pdfminer.six](https://github.com/pdfminer/pdfminer.six)
Document extraction: [MinerU](https://github.com/opendatalab/MinerU)
Multi-threaded translation: [MathTranslate](https://github.com/SUSYUSTC/MathTranslate)
Layout parsing: [DocLayout-YOLO](https://github.com/opendatalab/DocLayout-YOLO)
Document standard: [PDF Explained](https://zxyle.github.io/PDF-Explained/), [PDF Cheat Sheets](https://pdfa.org/resource/pdf-cheat-sheets/)
## Contributors
## Star History