هذه الصفحة غير متوفرة بلغتك بعد. يتم عرض النسخة الإنجليزية.

Sviluppo locale

Configura Potato per lo sviluppo e il test locali.

Sviluppo locale

Metti in funzione Potato sulla tua macchina locale per lo sviluppo e il testing.

Prerequisiti

Python 3.7 o superiore
Gestore di pacchetti pip
Git (opzionale, per clonare esempi)

Installazione

Con pip (Consigliato)

bash

pip install potato-annotation

Dal sorgente

bash

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

Con dipendenze opzionali

bash

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

Avvio rapido

1. Crea un file di configurazione

Crea config.yaml:

yaml

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/

2. Prepara dati di esempio

Crea data.json:

json

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

3. Avvia il server

bash

potato start config.yaml

4. Accedi all'interfaccia

Apri il tuo browser su http://localhost:8000

Modalità di sviluppo

Hot Reloading

Abilita il riavvio automatico quando la configurazione cambia:

bash

potato start config.yaml --reload

Modalità debug

Abilita la registrazione dettagliata:

bash

potato start config.yaml --debug

Output dettagliato

Visualizza tutta l'attività del server:

bash

potato start config.yaml --verbose

Struttura delle directory

Layout di progetto consigliato:

text

my-annotation-project/
├── config.yaml           # Main configuration
├── data/
│   ├── train.json        # Training data
│   └── main.json         # Annotation data
├── annotations/          # Output directory
├── templates/            # Custom HTML templates
└── static/               # Custom CSS/JS

Testare la tua configurazione

Valida la configurazione

Controlla gli errori di sintassi:

bash

potato validate config.yaml

Modalità anteprima

Avvia senza salvare le annotazioni:

bash

potato start config.yaml --preview

Test con dati di esempio

Genera dati di test:

bash

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

Problemi comuni

Porta già in uso

bash

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

File di dati non trovato

Assicurati che i percorsi siano relativi alla posizione del file di configurazione:

yaml

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

Permesso negato

Controlla i permessi dei file:

bash

chmod 755 annotations/
chmod 644 data/*.json

Più utenti in locale

Per testare scenari multi-utente:

yaml

allow_all_users: true
url_user_id_param: user_id

Accedi con utenti diversi:

http://localhost:8000/?user_id=annotator1
http://localhost:8000/?user_id=annotator2

Reimposta le annotazioni

Cancella tutte le annotazioni e ricomincia da capo:

bash

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

Variabili d'ambiente

Configura tramite l'ambiente:

bash

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

Utilizzo con ambienti virtuali

venv

bash

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

Conda

bash

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

Integrazione IDE

VS Code

Installa l'estensione YAML per il supporto dei file di configurazione:

json

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

PyCharm

Configura una configurazione di esecuzione:

Aggiungi → Python
Script: potato
Parametri: start config.yaml
Directory di lavoro: il percorso del tuo progetto

Prossimi passi

Configuration Basics - Scopri tutte le opzioni di configurazione
Data Formats - Comprendi la struttura dei dati
Production Setup - Distribuisci per uso reale