克隆/下载
贡献代码
同步代码
chaofanat-chaofanat chaofanat ` 7e50dfd 4个月前
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

项目概述

项目背景

提供本地化的英文翻译服务API。支持单句翻译请求或者批量翻译请求。支持建立查询词汇表。

项目架构

前端:使用原生js,使用MDB作为CSS框架。django模板引擎渲染可视化界面。

后端:使用waitress作为后端服务器。django作为web应用框架。

API:使用django-ninjaAPI实现RESTFUL API服务以及API文档。

数据库:默认使用sqlite。

缓存:使用redis进行缓存数据管理。

异步任务队列:使用celery进行异步任务处理。

反向代理:使用Nginx处理用户请求并完成分发。

项目构建:使用docker进行项目开发部署以及项目生产部署。

项目展示

可视化在线翻译界面

docker启动在80端口,服务启动后,通过http://locahost访问即可

1727344247210

API文档

项目启动后访问http://localhost/api/docs访问API文档

1727344456039

手动部署项目

这是一个基于 Django 的 Web 应用程序。以下是项目的安装和启动步骤。

克隆项目

git clone https://gitee.com/chaofanat/EnToZhAPI.git

安装依赖

确保您已经安装了 Python 和 pip。然后运行以下命令来安装项目所需的依赖:

pip install -r requirements.txt

数据库迁移

运行以下命令来应用数据库迁移:

python manage.py migrate

创建超级用户

运行以下命令来创建一个超级用户: python manage.py createsuperuser

按照提示输入用户名、邮箱和密码。

启动 Celery 工作进程

启动 Celery 工作进程(多线程模式兼容Windows):

celery -A MainConfig worker -l info -P threads

启动 Redis 服务器

启动 Redis 服务器(注意切换redis文件夹):

redis-server

运行项目

最后,运行项目在8080端口:

python run.py

运行说明

  1. 数据库迁移 :确保数据库表结构同步。
  2. 创建超级用户 :用于登录管理后台。
  3. Celery 工作进程 :用于异步任务处理。
  4. Redis 服务器 :作为 Celery 的消息队列。
  5. 运行项目 :启动 Django 开发服务器。

使用docker快速开发部署

git clone https://gitee.com/chaofanat/EnToZhAPI.git

cd EnToZhAPI

docker-compose build

builddocker-compose up -d


使用docker快速启动服务

git clone https://gitee.com/chaofanat/EnToZhAPI.git

cd EnToZhAPI

docker-compose -f docker-compose-finish.yml up -d

注意事项(部署前必看)

模型不在仓库中需要去huggingface下载后放入项目目录。

或者通过百度网盘下载模型 链接: https://pan.baidu.com/s/1T0FMKELADUKI8uf6K3QfyQ?pwd=8svm

下载解压后放入项目文件夹下modelscope/hub文件夹下即可。放到其他位置请修改设置文件,并使用开发部署。

【注意】翻译模型路径配置在MainConfig/settings.py中。

1727333037807

Linux部署命令参考

前提已经安装好docker 、docker-compose

# 下载 Hugging Face 的下载脚本
wget https://hf-mirror.com/hfd/hfd.sh

# 使下载的脚本具有可执行权限
chmod a+x hfd.sh

# 设置 Hugging Face 的镜像端点
export HF_ENDPOINT=https://hf-mirror.com

# 使用 Snap 包管理器安装 aria2c
sudo snap install aria2c

# 使用 APT 包管理器安装 Git LFS (Large File Storage)
sudo apt install git-lfs

# 使用 Hugging Face 的下载脚本下载模型
# 指定使用 aria2c 作为下载工具,并设置最大并发数为 4
./hfd.sh Helsinki-NLP/opus-mt-en-zh --tool aria2c -x 4

# 克隆 Gitee 仓库
git clone https://gitee.com/chaofanat/EnToZhAPI.git

# 切换到克隆的仓库目录
cd EnToZhAPI

# 创建目录 modelscope/hub/opus-mt-en-zh
mkdir -p modelscope/hub/opus-mt-en-zh

# 复制 opus-mt-en-zh 模型到 modelscope/hub/opus-mt-en-zh 目录
cp -r ../opus-mt-en-zh modelscope/hub/opus-mt-en-zh

# 启动 Docker Compose 服务
# 使用指定的 docker-compose 文件启动服务
sudo docker-compose -f docker-compose-finish.yml up -d

# 将 staticfiles 目录及其子目录的所有者设置为 nobody:nogroup
sudo chown -R nobody:nogroup ./staticfiles

# 设置 staticfiles 目录及其子目录的权限为 755(所有者可读写执行,其他人可读执行)
sudo chmod -R 755 ./staticfiles

# 将 media 目录及其子目录的所有者设置为 nobody:nogroup
sudo chown -R nobody:nogroup ./media

# 设置 media 目录及其子目录的权限为 755(所有者可读写执行,其他人可读执行)
sudo chmod -R 755 ./media

联系方式

如有任何问题或建议,请联系 [chaofanat@qq.com] 或 [chaofanat@gmail.com]。


感谢使用本项目!

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

一个基于django-ninja、opus-mt-en-zh 、torch、transformers提供的英文翻译本地服务。 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化