From 2fd630a23832b29a3467b9cc7fc07acaf1516147 Mon Sep 17 00:00:00 2001 From: Kerry <54252779+xxnuo@users.noreply.github.com> Date: Mon, 10 Mar 2025 00:39:59 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 16 ++-- README_en.md | 16 ++-- README_ja.md | 14 +++- 5 files changed, 234 insertions(+), 14 deletions(-) create mode 100644 LICENSE diff --git a/.gitignore b/.gitignore index 474b823..fd63c89 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ core /example/models/enzh /example/models/zhen +*.psd diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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. \ No newline at end of file diff --git a/README.md b/README.md index 9677174..3bf669e 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,8 @@ docker load -i mtranserver.image.tar ### 2. 下载模型 +> 持续更新模型中 + 中国大陆下载地址(内含 Docker 镜像下载) 模型在`下载模型文件夹内` 国际下载地址 @@ -213,15 +215,19 @@ docker pull xxnuo/mtranserver:latest docker compose up -d ``` -## 其他 +## 源码仓库 -Windows、Mac 和 Linux 独立客户端软件版 [MTranServerCore](https://github.com/xxnuo/MTranServerCore) 在开发中,请耐心等待。 +Windows、Mac 和 Linux 独立客户端软件版 [MTranServerClient](https://github.com/xxnuo/MTranServerClient) (未开发完成,请耐心等待) -也可以在电脑上安装 `Docker Desktop` 后,按上面的指南使用 `Docker Compose` 部署尝鲜。 +服务端 API 服务源码仓库: [MTranServerCore](https://github.com/xxnuo/MTranServerCore) -服务端翻译推理框架使用的是 C++ 编写的 [marian-nmt](https://github.com/marian-nmt/marian-dev) 框架。 +## 感谢 -服务端 API 源码仓库: [MTranServerCore](https://github.com/xxnuo/MTranServerCore) (暂未完成,请耐心等待) +推理框架: C++ [Marian-NMT](https://marian-nmt.github.io) 框架 + +翻译模型: [firefox-translations-models](https://github.com/mozilla/firefox-translations-models) + +> Join us: [https://www.mozilla.org/zh-CN/contribute/](https://www.mozilla.org/zh-CN/contribute/) ## 赞助我 diff --git a/README_en.md b/README_en.md index 28c346d..4303b0d 100644 --- a/README_en.md +++ b/README_en.md @@ -92,6 +92,8 @@ Then proceed normally to the next step to download models. ### 2. Download Models +> Models are being updated continuously + Mainland China Download Link (includes Docker image) Models are in the `Download Models` folder International Download Link @@ -218,15 +220,19 @@ docker compose up -d ## Other Information -Windows, Mac, and Linux standalone client software version [MTranServerCore](https://github.com/xxnuo/MTranServerCore) is under development, please be patient. +Windows, Mac, and Linux standalone client software version [MTranServerClient](https://github.com/xxnuo/MTranServerClient) (under development, please be patient) -You can also try it out by installing `Docker Desktop` on your computer and following the guide above to deploy with `Docker Compose`. +Server API source code repository: [MTranServerCore](https://github.com/xxnuo/MTranServerCore) -The server-side translation inference framework uses the C++-written [marian-nmt](https://github.com/marian-nmt/marian-dev) framework. +## Thanks -Server API source code repository: [MTranServerCore](https://github.com/xxnuo/MTranServerCore) (not yet complete, please be patient) +Inference Framework: C++ [Marian-NMT](https://marian-nmt.github.io) Framework -## Support the Project +Translation Models: [firefox-translations-models](https://github.com/mozilla/firefox-translations-models) + +> Join us: [https://www.mozilla.org/zh-CN/contribute/](https://www.mozilla.org/zh-CN/contribute/) + +## Support Me [Buy me a coffee ☕️](https://www.creem.io/payment/prod_3QOnrHlGyrtTaKHsOw9Vs1) diff --git a/README_ja.md b/README_ja.md index 02e56a8..fa7f7da 100644 --- a/README_ja.md +++ b/README_ja.md @@ -92,6 +92,8 @@ docker load -i mtranserver.image.tar ### 2. モデルのダウンロード +> モデルは継続的に更新中 + 中国本土ダウンロードリンク(Dockerイメージを含む) モデルは`モデルダウンロード`フォルダにあります 国際ダウンロードリンク @@ -218,13 +220,17 @@ docker compose up -d ## その他の情報 -Windows、Mac、Linuxのスタンドアロンクライアントソフトウェアバージョン[MTranServerCore](https://github.com/xxnuo/MTranServerCore)は開発中です。しばらくお待ちください。 +Windows、Mac、Linuxのスタンドアロンクライアントソフトウェアバージョン [MTranServerClient](https://github.com/xxnuo/MTranServerClient) (開発中、しばらくお待ちください) -コンピュータに`Docker Desktop`をインストールし、上記のガイドに従って`Docker Compose`でデプロイすることもできます。 +サーバーAPIのソースコードリポジトリ:[MTranServerCore](https://github.com/xxnuo/MTranServerCore) -サーバーサイドの翻訳推論フレームワークには、C++で書かれた[marian-nmt](https://github.com/marian-nmt/marian-dev)フレームワークを使用しています。 +## 謝辞 -サーバーAPIのソースコードリポジトリ:[MTranServerCore](https://github.com/xxnuo/MTranServerCore)(まだ完成していません。しばらくお待ちください) +推論フレームワーク:C++ [Marian-NMT](https://marian-nmt.github.io) フレームワーク + +翻訳モデル:[firefox-translations-models](https://github.com/mozilla/firefox-translations-models) + +> Join us: [https://www.mozilla.org/zh-CN/contribute/](https://www.mozilla.org/zh-CN/contribute/) ## サポート