diff --git a/LICENSE b/LICENSE deleted file mode 100644 index ecc7216..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - 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 [Datawhale] [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 61ef67b..86fd147 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,72 @@ -## whale-anno -Datawhale自研数据标注工具,让标注更简单 +# whaleAnno +Datawhale自研数据标注工具 - -## 快速体验 -- PC端: - - 更简单的NER标注工具:https://tekii.cn/ner/ - - 或者直接release中下载[单机版](https://github.com/datawhalechina/whale-anno/releases)(目前只有Windows版本,Mac需要用到Mac机器打包) -- 代码体验:从[快速开始](./doc/doc_ch/quickstart.md)开始 +## Demo +https://tekii.cn/ner/ - -## 许可证书 -本项目的发布受Apache 2.0 license许可认证。 +## 快速开始 +### 1.环境配置 +#### 下载所需软件 +##### Python 3 +经测试whaleAnno后端代码可在Python 3.7.9上运行,您也可以测试其他版本,一般建议安装最新版 - -## 贡献代码 -我们非常欢迎你为whale-anno贡献代码,也十分感谢你的反馈。 +##### Node.js +经测试whaleAnno前端代码可在Node.js v12.16.3上运行,在Node.js v8.10.0安装本地调试工具失败,您也可以测试其他版本,一般建议安装最新版 -- 非常感谢 [谢文睿](https://github.com/Sm1les) 贡献了NER标注工具的概念想法 -- 非常感谢 [马琦钧](https://github.com/Skypow2012) 贡献了NER标注工具的前端代码,并编写了中文文档 -- 非常感谢 付文豪 贡献了NER标注工具的后端代码 +#### 克隆项目 +```shell +git clone https://github.com/datawhalechina/whale-anno.git +``` +#### 下载依赖 +##### 下载后端依赖 +```shell +# 下载后端依赖 +python3 -m pip install flask +``` +后端只依赖了flask这个第三方库 + +##### 下载前端依赖 +```shell +# 进入前端文件夹 +cd ./fe +# 下载前端依赖 +npm install +``` +npm为Node.js安装以后自带的包管理工具 + +### 2.启动项目 +#### 启动后端 +打开终端 +```shell +# 进入后端目录 +cd ./be +# 启动后端脚本 +python3 ./run.py +``` +此时项目的后端会被启动在http://localhost:9060/ + +#### 启动前端 +用上述方法,打开一个新的命令行 +```shell +# 进入前端 +cd ./fe +# 启动前端页面 +npm run start +``` +此时项目的前端会被启动在http://localhost:8080/ + +### 3.开始使用 +打开上述前端页面地址( http://localhost:8080/ ),然后请参考[使用说明](./doc/README.md)开始使用。 + + +## 开发团队 +| 职责 | 名单 | +| :---: | :---: | +| **PM** | [谢文睿](https://github.com/Sm1les) | +| **前端** | [马琦钧](https://github.com/Skypow2012) | +| **后端** | 付文豪 | + +## 关注我们 +
+Datawhale是一个专注AI领域的开源组织,以“for the learner,和学习者一起成长”为愿景,构建对学习者最有价值的开源学习社区。关注我们,一起学习成长。 +
\ No newline at end of file diff --git a/doc/doc_ch/quickuse.md b/doc/README.md similarity index 95% rename from doc/doc_ch/quickuse.md rename to doc/README.md index 4e8e56a..f70467d 100644 --- a/doc/doc_ch/quickuse.md +++ b/doc/README.md @@ -1,3 +1,7 @@ +# 使用说明 +## 视频教程 +[whaleAnno使用说明](./quickuse.mp4) + ## 1、开启后端 进入be目录,通过【python3 run.py】开启后台。(开始前请先参考[快速开始](./doc/doc_ch/quickstart.md)做好环境配置) ## 2、开启前端 diff --git a/doc/doc_ch/installation.md b/doc/doc_ch/installation.md deleted file mode 100644 index 0eac757..0000000 --- a/doc/doc_ch/installation.md +++ /dev/null @@ -1,27 +0,0 @@ -# 环境配置 -## 一、下载所需软件 -### 1、Python 3 -经测试Whale-anno后端代码可在Python 3.7.9上运行,您也可以测试其他版本,一般建议安装最新版 -[Python 3官网下载地址](https://www.python.org/downloads/) -### 2、Node.js -经测试Whale-anno前端代码可在Node.js v12.16.3上运行,在Node.js v8.10.0安装本地调试工具失败,您也可以测试其他版本,一般建议安装最新版 -[Node.js官网下载地址](https://nodejs.org/zh-cn/download/) -## 二、克隆项目 -```shell -git clone https://github.com/datawhalechina/whale-anno.git -``` -## 三、下载依赖 -### 1、下载后端依赖 -```shell -# 下载后端依赖 -python3 -m pip install flask -``` -*后端只依赖了flask这个第三方库* -### 2、下载前端依赖 -```shell -# 进入前端文件夹 -cd ./fe -# 下载前端依赖 -npm install -``` -*npm为Node.js安装以后自带的包管理工具* diff --git a/doc/doc_ch/quickstart.md b/doc/doc_ch/quickstart.md deleted file mode 100644 index cc62915..0000000 --- a/doc/doc_ch/quickstart.md +++ /dev/null @@ -1,24 +0,0 @@ -# 快速开始 -## 一、环境配置 -请参考[环境配置](./installation.md)配置whale-anno运行环境。 -## 二、启动项目 -### 1、启动后端 -打开命令行(Windows中的打开方式:进入项目目录,按住键盘上的shift,然后右键,选择在【在此处打开 PowerShell 窗口(S)】) -```shell -# 进入后端目录 -cd ./be -# 启动后端脚本 -python3 ./run.py -``` -*此时项目的后端会被启动在http://localhost:9060/* -### 2、启动前端 -用上述方法,打开一个新的命令行 -```shell -# 进入前端 -cd ./fe -# 启动前端页面 -npm run start -``` -*此时项目的前端会被启动在http://localhost:8080/* -## 三、开始使用 -打开上述前端页面地址,然后请参考[快速使用](./quickuse.md)。 diff --git a/doc/doc_ch/quickuse.mp4 b/doc/quickuse.mp4 similarity index 100% rename from doc/doc_ch/quickuse.mp4 rename to doc/quickuse.mp4