* 优化快速使用文档的展示

This commit is contained in:
maxmon 2021-06-21 04:08:25 +08:00 committed by GitHub
parent 2bafab2a36
commit 070235efef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 16 deletions

View File

@ -1,24 +1,24 @@
1、开启be
进入be目录通过【python3 run.py】开启后台。
2、开启fe
进入fe目录通过【npm run start】开启前端。
3、打开网页
## 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、创建项目
## 4、创建项目
点击【新建项目】创建一个名称为【demo01】的项目类型选择【命名实体识别】然后点击底部的【提交】完成新建。
5、添加标签
## 5、添加标签
点击项目的【配置】按钮进入配置页。在【新增标签】处输入【人名】,点击右侧的【提交】。在生成标签左侧点击画板可以切换颜色。随后还可以再输入【地名】、【组织】、【日期】等。全部标签录入好以后,点击底部的【提交】更新配置。
6、下载/处理示例文件
## 6、下载/处理示例文件
可以去【https://luge.ai/】下载一些示例文件,切割成一个一个的文本文件。
7、导入示例文件
## 7、导入示例文件
将文本文件拖入【be/app/projets/demo01/】中。单机版local分支可直接在release中下载可直接将文件列表拖入标注页左侧的文件列表。
8、标注
## 8、标注
点击【开始标注】进入标注页面。默认选中了第一个标签,可以点击标签来切换。在文本处按下鼠标、移动、松开鼠标,可以完成一次标注。右键文本可以取消标注。
9、切换文件
## 9、切换文件
点击左侧的文件名,或者点击底部的【上一个】、【下一个】可以切换需要标注的文件。如果文件过多,左侧列表会分页,点击【上一页】、【下一页】可以看到更多。
10、设置快捷键
## 10、设置快捷键
将鼠标移动到标签、底部【上一个】、底部【下一个】按键盘任意按钮设置快捷键按键盘上的【Esc】取消。可在鼠标进入标注区域时使用刚刚设置的快捷键。
11、导出标注
## 11、导出标注
点击左下角的【导出json结果】获取本次的标注内容内容示例如下历史所有标注内容在【be/app/projets/demo01/anno.json】中有记录格式略有不同。
```javascript
[
@ -28,19 +28,19 @@
"entity": [
{
"name": "小明",
"type": "person1",
"type": "人名",
"start": 0,
"end": 2
},
{
"name": "北京工业大学",
"type": "organiztion",
"type": "组织",
"start": 5,
"end": 11
},
{
"name": "北京",
"type": "location",
"type": "地名",
"start": 5,
"end": 7
}