Docs/Getting Started

Quick Start

Get up and running with Potato in under 5 minutes.

Quick Start

Get Potato running in just a few steps. This guide will have you annotating data in under 5 minutes.

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Installation

Install Potato using pip:

pip install potato-annotation

Create Your First Project

1. Create a project directory

mkdir my-annotation-task
cd my-annotation-task

2. Create your data file

Create a data folder and add a file called data.json with your data to annotate:

mkdir data
[
  {"id": "1", "text": "I love this product! It's amazing."},
  {"id": "2", "text": "This is the worst experience ever."},
  {"id": "3", "text": "It's okay, nothing special."}
]

3. Create your configuration

Create a file called config.yaml in your project directory:

Important: Your configuration file must be located within the project directory. This is a security requirement in Potato 2.0.

port: 8000
server_name: localhost
task_name: "Sentiment Analysis"
 
# Task directory (current directory)
task_dir: "."
 
# Data configuration
data_files:
  - "data/data.json"
 
item_properties:
  id_key: id
  text_key: text
 
# Output configuration
output_annotation_dir: "output/"
output_annotation_format: "json"
 
# Annotation scheme
annotation_schemes:
  - annotation_type: radio
    name: sentiment
    description: "What is the sentiment of this text?"
    labels:
      - Positive
      - Negative
      - Neutral
 
# Allow anyone to annotate
allow_all_users: true

4. Start the server

python -m potato start config.yaml -p 8000

Or using the shorthand:

potato start config.yaml

5. Open your browser

Navigate to http://localhost:8000 and start annotating!

Project Structure

Your project should look like this:

my-annotation-task/
├── config.yaml
├── data/
│   └── data.json
└── output/          # Created automatically
    └── annotations.json

What's Next?

NextInstallation