Skip to content

Inicio Rápido

Pon en marcha Potato en menos de 5 minutos.

Inicio Rápido

Pon Potato en funcionamiento en solo unos pasos. Esta guía te permitirá anotar datos en menos de 5 minutos.

Requisitos Previos

  • Python 3.7 o superior
  • Gestor de paquetes pip

Instalación

Instala Potato usando pip:

bash
pip install potato-annotation

Crea Tu Primer Proyecto

1. Crea un directorio de proyecto

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

2. Crea tu archivo de datos

Crea una carpeta data y añade un archivo llamado data.json con tus datos para anotar:

bash
mkdir data
json
[
  {"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. Crea tu configuración

Crea un archivo llamado config.yaml en tu directorio de proyecto:

Importante: Tu archivo de configuración debe estar ubicado dentro del directorio del proyecto. Este es un requisito de seguridad en Potato 2.0.

yaml
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. Inicia el servidor

bash
python -m potato start config.yaml -p 8000

O usando la forma abreviada:

bash
potato start config.yaml

5. Abre tu navegador

Navega a http://localhost:8000 y comienza a anotar.

Estructura del Proyecto

Tu proyecto debería verse así:

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

Próximos Pasos

Herramientas y Utilidades

Una vez que estés familiarizado con lo básico, consulta estas herramientas útiles: