doccano

doccano 是一个开源的人工文本标注工具。它提供了文本分类、序列标注和序列到序列任务的标注功能。你可以创建用于情感分析、命名实体识别、文本摘要等任务的标注数据。只需创建项目、上传数据并开始标注。你可以在几个小时内构建一个数据集。

演示

尝试标注演示。

演示图片

文档

阅读文档请访问 https://doccano.github.io/doccano/。

特性

协作标注
多语言支持
移动设备支持
表情符号 :smile: 支持
深色主题
RESTful API

使用方法

运行 doccano 有三种选择：

pip（Python 3.8+）
Docker
Docker Compose

pip

安装 doccano，运行：

pip install doccano

默认情况下，使用 SQLite 3 作为默认数据库。如果你想使用 PostgreSQL，请安装额外的依赖：

pip install 'doccano[postgresql]'

并根据你的 PostgreSQL 凭据设置 DATABASE_URL 环境变量：

DATABASE_URL="postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}?sslmode=disable"

安装后，运行以下命令：

# 初始化数据库
doccano init
# 创建超级用户
doccano createuser --username admin --password pass
# 启动 Web 服务器
doccano webserver --port 8000

在另一个终端中，运行以下命令：

# 启动任务队列以处理文件上传/下载
doccano task

访问 http://127.0.0.1:8000/。

Docker

作为一次性设置，按如下方式创建 Docker 容器：

docker pull doccano/doccano
docker container create --name doccano \
  -e "ADMIN_USERNAME=admin" \
  -e "ADMIN_EMAIL=admin@example.com" \
  -e "ADMIN_PASSWORD=password" \
  -v doccano-db:/data \
  -p 8000:8000 doccano/doccano

接下来，通过运行容器启动 doccano：

docker container start doccano

访问 http://127.0.0.1:8000/。

要停止容器，运行 docker container stop doccano -t 5。容器中创建的所有数据将在重新启动后保持不变。

如果你想使用最新功能，请指定 nightly 标签：

docker pull doccano/doccano:nightly

Docker Compose

你需要安装 Git 并克隆仓库：

git clone https://github.com/doccano/doccano.git
cd doccano

Windows 开发者注意： 请确保正确配置 git 以处理行尾，否则在未来的步骤中运行服务时可能会遇到 status code 127 错误。使用以下 git 配置选项运行将确保你的 git 目录正确处理行尾。

git clone https://github.com/doccano/doccano.git --config core.autocrlf=input

然后，创建一个 .env 文件，其中包含以下格式的变量（参见 ./docker/.env.example）：

# 平台设置
ADMIN_USERNAME=admin
ADMIN_PASSWORD=password
ADMIN_EMAIL=admin@example.com

# RabbitMQ 设置
RABBITMQ_DEFAULT_USER=doccano
RABBITMQ_DEFAULT_PASS=doccano

# 数据库设置
POSTGRES_USER=doccano
POSTGRES_PASSWORD=doccano
POSTGRES_DB=doccano

运行以下命令后，访问 http://127.0.0.1/。

docker-compose -f docker/docker-compose.prod.yml --env-file .env up

一键部署

服务	按钮
AWS¹
Heroku

常见问题

详情请参阅文档。

贡献

与任何软件一样，doccano 也在不断开发中。如果你有功能请求，请提交一个描述你请求的 issue。另外，如果你想看到某个特定功能的工作进展，欢迎通过实现它来做出贡献。标准流程是 fork 仓库，添加功能，修复 bug，然后提交一个 pull request，说明你的更改应该合并到主仓库并包含在下一个版本中。

这里有一些可能有帮助的提示。如何为 Doccano 项目做贡献

引用

@misc{doccano,
  title={{doccano}: Text Annotation Tool for Human},
  url={https://github.com/doccano/doccano},
  note={Software available from https://github.com/doccano/doccano},
  author={
    Hiroki Nakayama and
    Takahiro Kubo and
    Junya Kamura and
    Yasufumi Taniguchi and
    Xu Liang},
  year={2018},
}