Skip to content
Tutorials1 min read

5分钟上手 Potato

快速指南:从安装到首次标注数据,快速搭建你的第一个标注项目。

Potato Team·

5分钟上手 Potato

准备好开始标注了吗?这个快速教程将让你在5分钟内开始标注数据。我们将创建一个简单的情感分析任务来演示基础功能。

第1步:安装 Potato

首先,使用 pip 安装 Potato:

bash
pip install potato-annotation

验证安装:

bash
potato --version

第2步:创建配置文件

创建一个名为 config.yaml 的文件,包含以下最简配置:

yaml
annotation_task_name: "Quick Start Sentiment Analysis"
 
# Your data file
data_files:
  - data.json
 
# Annotation interface
annotation_schemes:
  - annotation_type: radio
    name: sentiment
    description: "What is the sentiment of this text?"
    labels:
      - Positive
      - Negative
      - Neutral

第3步:创建示例数据

创建 data.json 文件,包含一些示例文本:

json
{"id": "1", "text": "I love this product! It's amazing!"}
{"id": "2", "text": "Terrible experience. Would not recommend."}
{"id": "3", "text": "The weather is partly cloudy today."}
{"id": "4", "text": "Best purchase I've ever made!"}
{"id": "5", "text": "This is the worst service I've encountered."}

第4步:开始标注

启动标注服务器:

bash
potato start config.yaml

在浏览器中打开 http://localhost:8000。你将看到标注界面!

第5步:标注数据

  1. 使用任意用户名登录(Potato 会自动创建账号)
  2. 阅读显示的文本
  3. 选择合适的情感标签
  4. 点击"Submit"保存并进入下一条

第6步:导出标注结果

你的标注会自动保存到 annotation_output/ 文件夹。每个标注者的工作保存在单独的文件中。

查看标注结果:

bash
cat annotation_output/your_username.jsonl

接下来做什么?

恭喜!你已经完成了第一个标注任务。以下是进阶方向:

  • 添加键盘快捷键:用热键加速标注
  • 自定义界面:添加说明、提示和验证
  • 设置多标注者:配置用户管理和质量控制
  • 探索标注类型:尝试 span、复选框、李克特量表等

查看我们的文档获取每个功能的详细指南,或浏览展示区查看完整的配置示例。


遇到问题?查看我们的 FAQ 或在 GitHub 上提交 issue。