| 文档版本号 | 修订人 | 修订日期 | 变更内容 | 备注 |
|---|---|---|---|---|
| 1.0 | Kathleen-Xu | 2022/01/04 | 新增 | 使用说明 |
本项目使用 React + Material UI + Django 框架进行开发。
数据库使用 mysql，已部署在远程服务器上。
图片的存储使用 七牛云。
运行该项目前请确保你已经安装 Yarn，以及 Django（开发环境的 Django 版本为 3.2.9）
1. 克隆仓库到本地，或使用邮件中所发送的代码
2. 进入项目文件夹
$ cd LetsLabel
$ cd Code3. 运行前端
- 进入前端文件夹根目录
$ cd front-end- 安装依赖
$ yarn【关于组件中的BUG】安装依赖包后，请将 node_modules/react-image-annotate/RegionLabel/index.js 中129行起的 OnChange 函数修改为：
onChange: function onChange(newTags) {
return _onChange(_objectSpread({}, region, {
tags: newTags ? newTags.map(function (t) {
return t.value;
}) : undefined,
}));
},- 运行前端
$ yarn start4. 运行后端（如果有没有安装的模块，请根据报错提示进行pip install）
$ cd ../backEnd
$ django manage.py runserver本网站除了查看任务广场外，其余所有操作（包括标注、发布、提交、复核等）都需要用户登录后才有权限进行操作。用户应先进行注册和登录。
注册使用邮箱进行注册，用户和密码需要6字节以上，用户名仅包含且必须包含数字和字母6-20位，密码仅包含且必须同时包含数字和字母6-20位。
点击“我的发布”，点击新建，即可进行任务的创建和发布。
通过“上传图片”和“上传视频”两个标签进行上传文件类型的切换，其中视频仅支持MP4格式。
-
支持批量上传图片
- 上传的图片会被添加到上传框的下方进行显示
-
支持批量上传视频
- 上传的视频会先在后台进行帧提取（间隔为10s），请耐心等待至出现提取成功的提示，提取获得的帧转换成图片，与上传图片类似地添加到上传框的下面进行显示
点击上传框下方的图片，被点击的图片会添加至左侧任务发布面板中（同一张图多次点击会进行重复添加）。
在填写任务名称，选择图片后，点击发布，耐心等待至出现发布成功的提示，任务即发布成功。
如果需要重新选择图片，请点击重置。
在首页“任务广场”，可以看到所有发布的任务。
每一条任务卡片中都包含了任务的基本信息，如任务名、发布人、发布时间以及是否已经有人提交任务、复核是否通过等情况。
单击一条任务，卡片展开，显示任务所携带的图片栏。
任务一般有3种状态：
- 尚无标注方案：所有用户都可以尝试标注。
- 已有标注方案但发布者尚未复核：发布者可以进行复核；所有用户可以进行导出。
- 已有标注方案且发布者已经复核：所有用户可以看到复核结果，也可以进行导出。
如果任务尚未有人提交标注方案，任务卡片中会显示**标注**按钮，点击标注，即可进入标注页面。
首先为标注面板添加标注所需用到的Class和Tag。请注意：一经点击开始标注，Class和Tag将无法追加。
点击开始标注，进入标注面板。
-
左侧侧边栏前四个按键分别为：选择 / 拖动 / 缩放 / 显示或隐藏标签（进行添加Class和Tag时，下拉框可能超出面板，可以通过将图片向上拖动的方式，让下拉框完整地显示）
-
可以使用 矩形框 进行标注，并为该标注选择Class，添加Tag
-
可以通过右侧Regions中的列表选中已经做好的标注，对其进行删除或修改操作
-
右上角的 PREV 和 NEXT 支持切换图片
-
右上角的 SAVE 为暂存按钮，在提交之前必须先进行保存
-
在所有图片都标注完毕后，才可以点击 确定提交
【由于本项目选择的组件有一些小问题，目前并不支持右上角的CLONE/SETTINGS，和右下角的History。此外，在为删除标注的Tag至0个时，组件会因为报错而卡顿。如遇此种情况，可以刷新标注界面，重新进行标注。另一种解决方法涉及到修改依赖包中组件的源代码，已在开头的运行说明中提出。】
先点击 SAVE 进行暂存，最后单击 确认提交。
页面会自动跳转到“我提交的”页面，可以看到提交记录。
在有用户提交了标注方案后，任务发布者可以对该标注方案进行复核，选择通过或者不通过。（本项目暂不支持复现标注信息，用户可以通过导出进行自我判断。）
选择一个任务的标注方案，选择导出格式进行导出。
- COCO：导出为json格式，所有图片都包含在内。
- VOC：标注导出为XML格式，一个图片文件对应一个XML文件，分别存放在image和annotation文件夹下，以压缩包的格式导出。
如有问题，可以联系我：