Skip to content

End to end, Offline, high speed, and privately self-host free version of Google Translate - 低占用速度快可私有部署的离线版 Google 翻译

License

Notifications You must be signed in to change notification settings

xxnuo/MTranServer

Repository files navigation

请暂勿更新最新版,暂时使用 2.1.1 手动下载模型的版本 最新版使用跨平台运行时在批量翻译时内存占用较高 本提示去除后说明修复完成

MTranServer

English | 中文

MTran

一个超低资源消耗超快的离线翻译服务器,无需显卡。单个请求平均响应时间 50 毫秒。支持全世界主要语言的翻译。

翻译质量与 Google 翻译相当。

注意本模型专注于速度和多种设备私有部署,所以翻译质量肯定是不如大模型翻译的效果。需要高质量的翻译建议使用在线大模型 API。

Demo

即将上线

同类项目效果(CPU,英译中)

项目名称 内存占用 并发性能 翻译效果 速度 其他信息
facebook/nllb 很高 一般 Android 移植版的 RTranslator 有很多优化,但占用仍然高,速度也不快
LibreTranslate 很高 一般 一般 中等 中端 CPU 每秒处理 3 句,高端 CPU 每秒处理 15-20 句。详情
OPUS-MT 一般 略差 性能测试
其他大模型 超高 动态 非常好 很慢 32B 及以上参数的模型效果不错,但是对硬件要求很高
MTranServer(本项目) 一般 极快 单个请求平均响应时间 50ms

表中数据仅供参考,非严格测试,非量化版本对比。

更新日志

更新日志

桌面端

即将发布桌面端软件,敬请期待。

服务器部署

对普通用户来说有难度,建议使用桌面端。

1.1 环境要求

  • Docker
  • Docker Compose(可选)

1.2 镜像版本

  • 默认无内置模型翻译时自动下载:xxnuo/mtranserver:latest
  • 内置中英互译模型:xxnuo/mtranserver:latest-zh
  • 内置日英互译模型:xxnuo/mtranserver:latest-ja

1.3 Docker 部署

复制下面的命令,在终端执行。

docker run -d --name mtranserver -p 8989:8989 -e API_TOKEN=your_token xxnuo/mtranserver:latest

1.4 Docker Compose 部署

服务器准备一个存放配置的文件夹,打开终端执行以下命令

mkdir mtranserver
cd mtranserver
touch compose.yml

用编辑器打开 compose.yml 文件,写入以下内容。

  1. 修改下面的 your_token 为你自己设置的一个密码,使用英文大小写和数字。自己内网可以不设置,如果是云服务器强烈建议设置一个密码,保护服务以免被扫到、攻击、滥用

  2. 如果需要更改端口,修改 ports 的值,比如修改为 9999:8989 表示将服务端口映射到本机 9999 端口。

  3. 建议使用 API_TOKEN 设置密码,旧版本的 CORE_API_TOKEN 也还可以生效。

services:
  mtranserver:
    image: xxnuo/mtranserver:latest
    container_name: mtranserver
    restart: unless-stopped
    ports:
      - "8989:8989"
    environment:
      - API_TOKEN=your_token

先启动测试,确保 8989 端口没被占用。

docker compose up

正常输出示例:

HTTP Service URL: http://0.0.0.0:8989
Swagger UI: http://0.0.0.0:8989/docs

然后按 Ctrl+C 停止服务运行,然后正式启动服务器

docker compose up -d

这时候服务器就在后台运行了。

准备模型

⚠️ 注意:第一次请求翻译 API 时会在后台自动下载模型,无需手动下载。

模型自动下载功能需要连接网络(中国大陆不需要代理),后续翻译及其他功能均无需联网完全离线

所以第一次翻译不是秒回,要等待一会儿!

可在 Docker 日志处观察进度。下载速度取决于网络速度,一般在 10s 内能完成一个语言模型的下载。如果下载超时/失败,请检查容器是否能正常联网。

如果属于内网机器无法访问互联网可按照下文指导手动下载模型。

API 使用

下面表格内的 localhost 可以替换为你的服务器地址或 Docker 容器名。

下面表格内的 8989 端口可以替换为你在 compose.yml 文件中设置的端口值。

如果未设置环境变量 API_TOKENCORE_API_TOKEN 或者设置为空,翻译插件使用无密码的 API。

如果设置了 API_TOKENCORE_API_TOKEN,翻译插件使用有密码的 API。

下面表格中的 your_token 替换为你在环境变量中设置的 API_TOKEN 值。

翻译插件接口

注:

  • 沉浸式翻译设置页面,开发者模式中启用Beta特性,即可在翻译服务中看到自定义 API 设置(官方图文教程)。然后将自定义 API 设置每秒最大请求数拉高以充分发挥服务器性能准备体验飞一般的感觉。我设置的是每秒最大请求数5000每次请求最大段落数10。你可以根据自己服务器配置设置。

  • 简约翻译设置页面,接口设置中滚动到下面,即可看到自定义接口 Custom。同理,设置最大请求并发数量每次请求间隔时间以充分发挥服务器性能。我设置的是最大请求并发数量100每次请求间隔时间1。你可以根据自己服务器配置设置。

接下来按下表的设置方法设置插件的自定义接口地址。注意第一次请求会慢一些,因为需要加载模型。以后的请求会很快。

名称 URL 插件设置
沉浸式翻译无密码 http://localhost:8989/imme 自定义API 设置 - API URL
沉浸式翻译有密码 http://localhost:8989/imme?token=your_token 同上,需要更改 URL 尾部的 your_token 为你的 API_TOKENCORE_API_TOKEN
简约翻译无密码 http://localhost:8989/kiss 接口设置 - Custom - URL
简约翻译有密码 http://localhost:8989/kiss 同上,需要 KEYyour_token

普通用户参照表格内容设置好插件使用的接口地址就可以使用了。

保持更新

cd mtranserver
docker pull xxnuo/mtranserver:latest
docker compose up -d

开发者接口

Base URL: http://localhost:8989

在 v3.0.0 及以上版本中,API 文档可通过访问 http://localhost:8989/docs 查看完整 Swagger 文档

名称 URL 请求格式 返回格式 认证头
服务版本 /version {"version": "v3.0.0"}
支持的语言列表 /languages {"languages":["en","zh","ja","ko"...]} Authorization: your_token
普通翻译接口 /translate {"from": "en", "to": "zh", "text": "Hello, world!"} {"result": "你好,世界!"} Authorization: your_token
批量翻译接口 /translate/batch {"from": "en", "to": "zh", "texts": ["Hello, world!", "Hello, world!"]} {"results": ["你好,世界!", "你好,世界!"]} Authorization: your_token
健康检查 /health {"status": "ok"}
心跳检查 /__heartbeat__ Ready
负载均衡心跳检查 /__lbheartbeat__ Ready
谷歌翻译兼容接口 1 /language/translate/v2 {"q": "The Great Pyramid of Giza", "source": "en", "target": "zh", "format": "text"} {"data": {"translations": [{"translatedText": "吉萨大金字塔"}]}} Authorization: your_token

开发者高级设置请参考 CONFIG.md

贡献者

Lv Meiyang
Lv Meiyang
Leo
Leo

Star History

Star History Chart

Thanks

Bergamot Project for awesome idea of local translation.

Mozilla for the models.

About

End to end, Offline, high speed, and privately self-host free version of Google Translate - 低占用速度快可私有部署的离线版 Google 翻译

Resources

License

Stars

Watchers

Forks

Packages