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)
pip install potato-annotationDal sorgente
git clone https://github.com/davidjurgens/potato.git
cd potato
pip install -e .Con dipendenze opzionali
# 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:
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:
[
{"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
potato start config.yaml4. Accedi all'interfaccia
Apri il tuo browser su http://localhost:8000
Modalità di sviluppo
Hot Reloading
Abilita il riavvio automatico quando la configurazione cambia:
potato start config.yaml --reloadModalità debug
Abilita la registrazione dettagliata:
potato start config.yaml --debugOutput dettagliato
Visualizza tutta l'attività del server:
potato start config.yaml --verboseStruttura delle directory
Layout di progetto consigliato:
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:
potato validate config.yamlModalità anteprima
Avvia senza salvare le annotazioni:
potato start config.yaml --previewTest con dati di esempio
Genera dati di test:
potato generate-data --count 10 --output test_data.jsonProblemi comuni
Porta già in uso
# Use a different port
potato start config.yaml --port 8080
# Or in config.yaml
server:
port: 8080File di dati non trovato
Assicurati che i percorsi siano relativi alla posizione del file di configurazione:
# If data is in subdirectory
data_files:
- path: data/main.json
# Or use absolute path
data_files:
- path: /full/path/to/data.jsonPermesso negato
Controlla i permessi dei file:
chmod 755 annotations/
chmod 644 data/*.jsonPiù utenti in locale
Per testare scenari multi-utente:
allow_all_users: true
url_user_id_param: user_idAccedi con utenti diversi:
http://localhost:8000/?user_id=annotator1http://localhost:8000/?user_id=annotator2
Reimposta le annotazioni
Cancella tutte le annotazioni e ricomincia da capo:
# Remove annotation files
rm -rf annotations/*
# Restart server
potato start config.yamlVariabili d'ambiente
Configura tramite l'ambiente:
export POTATO_PORT=8000
export POTATO_DEBUG=true
export POTATO_DATA_PATH=/path/to/data
potato start config.yamlUtilizzo con ambienti virtuali
venv
python -m venv potato-env
source potato-env/bin/activate # Linux/Mac
potato-env\Scripts\activate # Windows
pip install potato-annotationConda
conda create -n potato python=3.10
conda activate potato
pip install potato-annotationIntegrazione IDE
VS Code
Installa l'estensione YAML per il supporto dei file di configurazione:
// 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