diff --git a/README.md b/README.md index 14e9e80..e32f978 100644 --- a/README.md +++ b/README.md @@ -11,37 +11,22 @@ https://tekii.cn/ner - CV:todo ## 快速开始 -### 1.环境配置 -#### 下载所需软件 -##### Python 3 +### 环境配置 +#### Python 3 经测试whaleAnno后端代码可在Python 3.7.9上运行,您也可以测试其他版本,一般建议安装最新版 -##### Node.js -经测试whaleAnno前端代码可在Node.js v12.16.3上运行,在Node.js v8.10.0安装本地调试工具失败,您也可以测试其他版本,一般建议安装最新版 - -#### 克隆项目 +### 克隆项目 ```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 # 进入后端目录 @@ -49,20 +34,10 @@ cd ./be # 启动后端脚本 python3 ./run.py ``` -此时项目的后端会被启动在http://localhost:9060 +此时项目会被启动在http://localhost:9060/index.html -#### 启动前端 -用上述方法,打开一个新的命令行 -```shell -# 进入前端 -cd ./fe -# 启动前端页面 -npm run start -``` -此时项目的前端会被启动在http://localhost:8080 - -### 3.开始使用 -打开上述前端页面地址( http://localhost:8080 ),然后点击[这里](https://www.bilibili.com/video/BV1v64y197iA?p=2)查看使用教程。此外,我们还提供了一个用于临时标注少量数据的单机版本(目前仅支持Windows),点击[这里](https://github.com/datawhalechina/whale-anno/releases)去下载,点击[这里](https://www.bilibili.com/video/BV1v64y197iA?p=1)查看单机版使用教程 +### 开始使用 +打开上述地址,然后点击[这里](https://www.bilibili.com/video/BV1v64y197iA?p=2)查看使用教程。此外,我们还提供了一个用于临时标注少量数据的单机版本(目前仅支持Windows),点击[这里](https://github.com/datawhalechina/whale-anno/releases)去下载,点击[这里](https://www.bilibili.com/video/BV1v64y197iA?p=1)查看单机版使用教程 ## 开发团队 diff --git a/be/app/projects/demo5/config.json b/be/app/projects/demo5/config.json index 3b333c3..f5c99a5 100644 --- a/be/app/projects/demo5/config.json +++ b/be/app/projects/demo5/config.json @@ -1 +1 @@ -{"projectName": "demo5", "projectType": "NLP标注", "entityTypes": "[{\"type\":\"person1\",\"color\":\"#e61490\"},{\"type\":\"location\",\"color\":\"#0aab8a\"},{\"type\":\"organiztion\",\"color\":\"#2770cd\"},{\"type\":\"123\",\"color\":\"#1c7a82\"}]"} \ No newline at end of file +{"projectName": "demo5", "projectType": "命名实体识别", "entityTypes": "[{\"type\":\"person1\",\"color\":\"#e61490\"},{\"type\":\"location\",\"color\":\"#0aab8a\"},{\"type\":\"organiztion\",\"color\":\"#2770cd\"},{\"type\":\"123\",\"color\":\"#1c7a82\"}]"} \ No newline at end of file diff --git a/doc/README.md b/doc/README.md index fad3843..ce98e41 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,26 +1,20 @@ # 使用说明 ## 视频教程 -[whaleAnno使用说明](./quickuse.mp4) +https://www.bilibili.com/video/BV1v64y197iA?p=2 -## 1、开启后端 - 进入be目录,通过【python3 run.py】开启后台。(开始前请先参考[快速开始](./doc/doc_ch/quickstart.md)做好环境配置) -## 2、开启前端 - 进入fe目录,通过【npm run start】开启前端。(开始前请先参考[快速开始](./doc/doc_ch/quickstart.md)做好环境配置) -## 3、打开网页 - 通过Chrome访问【 http://127.0.0.1:8080/ 】来进入前端页面。 -## 4、创建项目 +## 创建项目 点击【新建项目】创建一个名称为【demo01】的项目,类型选择【命名实体识别】,然后点击底部的【提交】完成新建。 -## 5、添加标签 +## 添加标签 点击项目的【配置】按钮进入配置页。在【新增标签】处输入【人名】,点击右侧的【提交】。在生成标签左侧点击画板可以切换颜色。随后还可以再输入【地名】、【组织】、【日期】等。全部标签录入好以后,点击底部的【提交】更新配置。 -## 6、导入文本文件 +## 导入文本文件 将文本文件放置进【be/app/projets/demo01/】中。(单机版(local分支,可直接在release中下载)可直接将文件列表拖入标注页左侧的文件列表。) -## 7、标注 +## 标注 点击【开始标注】进入标注页面。默认选中了第一个标签,可以点击标签来切换。在文本处按下鼠标、移动、松开鼠标,可以完成一次标注。右键文本可以取消标注。 -## 8、切换文件 +## 切换文件 点击左侧的文件名,或者点击底部的【上一个】、【下一个】可以切换需要标注的文件。如果文件过多,左侧列表会分页,点击【上页】、【下页】可以看到更多。 -## 9、设置快捷键 +## 设置快捷键 将鼠标移动到标签、底部【上一个】、底部【下一个】,按键盘任意按钮设置快捷键,按键盘上的【Esc】取消。可在鼠标进入标注区域时使用刚刚设置的快捷键。 -## 10、导出标注 +## 导出标注 点击左下角的【导出json结果】获取本次的标注内容,内容示例如下:(历史所有标注内容在【be/app/projets/demo01/anno.json】中有记录,格式略有不同。) ```javascript [