pdf2zh/README_zh-CN.md

[English](README.md) | 简体中文

PDFMathTranslate

科学 PDF 文档翻译及双语对照工具

• 📊 保留公式、图表、目录和注释 (预览效果)
• 🌐 支持 多种语言，和 诸多翻译服务
• 🤖 提供 命令行工具，图形交互界面，以及 容器化部署

近期更新

• [Nov. 20 2024] 支持容器化部署
• [Nov. 20 2024] 支持多线程翻译、提升速度
• [Nov. 19 2024] 提供了图形用户界面
• [Nov. 18 2024] 支持更多翻译服务 DeepL, DeepLX, 和 Azure

安装

要求 Python 版本 >=3.8, <=3.12

pip install pdf2zh

使用

在命令行中执行翻译命令，生成译文文档 example-zh.pdf 和双语对照文档 example-dual.pdf，默认使用 Google 翻译服务

关于设置环境变量的详细说明，请参考 ChatGPT

全文或部分文档翻译

- **全文翻译** ```bash pdf2zh example.pdf ``` - **部分翻译** ```bash pdf2zh example.pdf -p 1-3,5 ```

指定源语言和目标语言

参考 [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 ```

使用不同的翻译服务

- **DeepL** 参考 [DeepL](https://support.deepl.com/hc/en-us/articles/360020695820-API-Key-for-DeepL-s-API) 设置环境变量构建接入点：`{DEEPL_SERVER_URL}/translate` - `DEEPL_SERVER_URL`（可选）, 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** 参考 [DeepLX](https://github.com/OwO-Network/DeepLX) 设置环境变量构建接入点：`{DEEPLX_SERVER_URL}/translate` - `DEEPLX_SERVER_URL`（可选）, e.g., `export DEEPLX_SERVER_URL=https://api.deepl.com` - `DEEPLX_AUTH_KEY`, e.g., `export DEEPLX_AUTH_KEY=xxx` ```bash pdf2zh example.pdf -s deepl ``` - **Ollama** 参考 [Ollama](https://github.com/ollama/ollama) 设置环境变量构建接入点：`{OLLAMA_HOST}/api/chat` - `OLLAMA_HOST`（可选）, e.g., `export OLLAMA_HOST=https://localhost:11434` ```bash pdf2zh example.pdf -s ollama:gemma2 ``` - **支持 OpenAI 协议的 LLM（如 OpenAI、SiliconCloud、Zhipu）** 参考 [SiliconCloud](https://docs.siliconflow.cn/quickstart), [Zhipu](https://open.bigmodel.cn/dev/api/thirdparty-frame/openai-sdk) 设置环境变量构建接入点：`{OPENAI_BASE_URL}/chat/completions` - `OPENAI_BASE_URL`（可选）, 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** 参考 [Azure Text Translation](https://docs.azure.cn/en-us/ai-services/translator/text-translation-overview) 需设置以下环境变量： - `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 ```

指定例外规则

使用正则表达式指定需保留的公式字体与字符 ```bash pdf2zh example.pdf -f "(CM[^RT].*|MS.*|.*Ital)" -c "(\(|\||\)|\+|=|\d|[\u0080-\ufaff])" ```

图形化交互界面

```bash pdf2zh -i ``` 详见 [GUI 文档](./docs/README_GUI.md)

使用 Docker 部署

```bash docker pull byaidu/pdf2zh docker run -p 7860:7860 byaidu/pdf2zh ``` 在浏览器中打开： ``` http://localhost:7860/ ```

预览

功能请求和错误报告

欢迎在 GitHub Issues 或 Telegram 用户群 中提供反馈。

致谢

• 文档合并：PyMuPDF

• 文档解析：Pdfminer.six

• 文档提取：MinerU

• 多线程翻译：MathTranslate

• 布局解析：DocLayout-YOLO

• 文档标准：PDF Explained, PDF Cheat Sheets

贡献者

Star History