pip install potato-annotation

git clone https://github.com/davidjurgens/potato.git
cd potato
pip install -e .

# For audio annotation support
pip install potato-annotation[audio]
 
# For all optional features
pip install potato-annotation[all]

task_name: "My First Annotation Task"
 
server:
  port: 8000
 
data_files:
  - path: data.json
    text_field: text
 
annotation_schemes:
  - annotation_type: radio
    name: sentiment
    description: "What is the sentiment?"
    labels:
      - Positive
      - Negative
      - Neutral
 
output:
  path: annotations/

[
  {"id": "1", "text": "I love this product!"},
  {"id": "2", "text": "This is terrible."},
  {"id": "3", "text": "It's okay, nothing special."}
]

potato start config.yaml

potato start config.yaml --reload

potato start config.yaml --debug

potato start config.yaml --verbose

potato validate config.yaml

potato start config.yaml --preview

potato generate-data --count 10 --output test_data.json

# Use a different port
potato start config.yaml --port 8080
 
# Or in config.yaml
server:
  port: 8080

# If data is in subdirectory
data_files:
  - path: data/main.json
 
# Or use absolute path
data_files:
  - path: /full/path/to/data.json

chmod 755 annotations/
chmod 644 data/*.json

allow_all_users: true
url_user_id_param: user_id

# Remove annotation files
rm -rf annotations/*
 
# Restart server
potato start config.yaml

export POTATO_PORT=8000
export POTATO_DEBUG=true
export POTATO_DATA_PATH=/path/to/data
 
potato start config.yaml

python -m venv potato-env
source potato-env/bin/activate  # Linux/Mac
potato-env\Scripts\activate     # Windows
pip install potato-annotation

conda create -n potato python=3.10
conda activate potato
pip install potato-annotation

// settings.json
{
  "yaml.schemas": {
    "https://potato-annotation.com/schema.json": "config.yaml"
  }
}