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[^1]
Heroku

[^1]: (1) EC2 密钥对无法自动创建，因此请确保您在某个区域已拥有现有的 EC2 密钥对。或者您可以 自行创建。 (2) 如果您希望在 AWS 中通过 HTTPS 访问 doccano，这里有一份 说明。

常见问题解答

• 如何创建用户
• 如何将用户添加到您的项目
• 如何更改密码

更多详细信息请参阅 文档。

贡献

与任何软件一样，doccano 处于持续开发中。如果您有功能需求，请提交一个描述您需求的问题。此外，如果您希望看到某项功能的实现，也欢迎通过参与开发来贡献自己的力量。标准流程是先 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},
}

联系方式

如需帮助或反馈，请随时联系 作者。

Doccano 快速上手指南

Doccano 是一款开源的文本标注工具，支持文本分类、序列标注（如命名实体识别）和序列到序列（如文本摘要）任务。它界面友好，支持多人协作，可帮助开发者在数小时内构建高质量数据集。

环境准备

• 操作系统：Linux、macOS 或 Windows
• Python 版本：3.8 及以上（仅 pip 安装方式需要）
• 前置依赖：
  • 若使用 pip 安装：需安装 Python 3.8+ 和 pip
  • 若使用 Docker：需安装 Docker Engine
  • 若使用 Docker Compose：需安装 Docker 和 Docker Compose，以及 Git
• 网络建议：国内用户推荐使用国内镜像源加速下载（如阿里云、腾讯云镜像）

安装步骤

方式一：使用 pip 安装（推荐轻量使用）

# 可选：配置国内 pip 镜像源（以阿里云为例）
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/

# 安装 doccano
pip install doccano

# 初始化数据库
doccano init

# 创建管理员账户
doccano createuser --username admin --password pass

# 启动 Web 服务
doccano webserver --port 8000

在另一个终端窗口启动任务队列（用于处理文件上传/下载）：

doccano task

访问 http://127.0.0.1:8000/ 即可使用。

如需使用 PostgreSQL 数据库，请执行：

pip install 'doccano[postgresql]'

并设置环境变量 DATABASE_URL。

方式二：使用 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

# 启动容器
docker container start doccano

访问 http://127.0.0.1:8000/。

方式三：使用 Docker Compose（适合团队协作）

# 克隆项目
git clone https://github.com/doccano/doccano.git
cd doccano

# 创建 .env 配置文件
cat > .env <<EOF
ADMIN_USERNAME=admin
ADMIN_PASSWORD=password
ADMIN_EMAIL=admin@example.com
RABBITMQ_DEFAULT_USER=doccano
RABBITMQ_DEFAULT_PASS=doccano
POSTGRES_USER=doccano
POSTGRES_PASSWORD=doccano
POSTGRES_DB=doccano
EOF

# 启动服务
docker-compose -f docker/docker-compose.prod.yml --env-file .env up

访问 http://127.0.0.1/。

基本使用

1. 浏览器打开 http://127.0.0.1:8000/，使用创建的管理员账号登录。
2. 点击 "Create Project" 创建新项目，选择任务类型（文本分类、序列标注或序列到序列）。
3. 进入项目后，点击 "Import Dataset" 上传文本数据（支持 JSONL、CSV 等格式）。
4. 开始标注：选中文本并添加标签，或使用快捷键提高效率。
5. 标注完成后，点击 "Export Dataset" 导出为训练所需格式（如 JSONL、CoNLL 等）。

通过以上步骤，即可快速完成从数据导入到标注导出的全流程。