Desenvolvimento Local

Instale e execute o Potato localmente para desenvolvimento e testes. Aborda a instalação via pip, a configuração, a inicialização do servidor de desenvolvimento e a depuração de problemas comuns de inicialização.

Coloque o Potato em execução na sua máquina local para desenvolvimento e testes.

Pré-requisitos

Python 3.7 ou superior
Gerenciador de pacotes pip
Git (opcional, para clonar exemplos)

Instalação

Usando pip (recomendado)

bash

pip install potato-annotation

A partir do código-fonte

bash

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

Com dependências opcionais

bash

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

Início rápido

1. Crie um arquivo de configuração

Crie 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. Prepare dados de exemplo

Crie 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. Inicie o servidor

bash

potato start config.yaml

4. Acesse a interface

Abra seu navegador em http://localhost:8000

Modo de desenvolvimento

Recarregamento automático

Habilite a reinicialização automática quando a configuração mudar:

bash

potato start config.yaml --reload

Modo de depuração

Habilite o registro detalhado em log:

bash

potato start config.yaml --debug

Saída detalhada

Veja toda a atividade do servidor:

bash

potato start config.yaml --verbose

Estrutura de diretórios

Layout de projeto recomendado:

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

Testando sua configuração

Validar a configuração

Verifique se há erros de sintaxe:

bash

potato validate config.yaml

Modo de pré-visualização

Inicie sem salvar anotações:

bash

potato start config.yaml --preview

Teste com dados de exemplo

Gere dados de teste:

bash

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

Problemas comuns

Porta já em uso

bash

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

Arquivo de dados não encontrado

Garanta que os caminhos sejam relativos à localização do arquivo de configuração:

yaml

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

Permissão negada

Verifique as permissões dos arquivos:

bash

chmod 755 annotations/
chmod 644 data/*.json

Vários usuários localmente

Para testar cenários multiusuário:

yaml

allow_all_users: true
url_user_id_param: user_id

Acesse com diferentes usuários:

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

Redefinir anotações

Limpe todas as anotações e comece do zero:

bash

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

Variáveis de ambiente

Configure via ambiente:

bash

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

Usando com ambientes virtuais

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

Integração com IDE

VS Code

Instale a extensão YAML para suporte ao arquivo de configuração:

json

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

PyCharm

Configure uma configuração de execução:

Add → Python
Script: potato
Parâmetros: start config.yaml
Diretório de trabalho: o caminho do seu projeto

Próximos passos

Noções Básicas de Configuração - Conheça todas as opções de configuração
Formatos de Dados - Entenda a estrutura dos dados
Configuração de Produção - Faça a implantação para uso real