INSTRUCTIONS.TXT

# INSTRUCTIONS

## 1. Requisitos

- Docker instalado na máquina (Para instalar e configurar, siga as instruções no site oficial do Docker: https://docs.docker.com/get-docker/)
- Arquivo CSV contendo os textos a serem rotulados
- Criar um arquivo `.env` baseado no `.env.example` fornecido

## 2. Preparando Ambiente

Na pasta 'porttagger-DANTE' faça o seguinte:

1. Crie uma pasta chamada `data` e adicione dentro dela os arquivos .csv que se deseja rotular.
2. Crie uma pasta `output` (nela será armazenada a saída do rotulador).

## 3. Configuração do .env

1. Copie o arquivo `.env.example` para um novo arquivo chamado `.env`
2. Abra o arquivo `.env` e configure as variáveis conforme a necessidade. Abaixo é como o arquivo está antes de ser configurado:

```
DEFAULT_MODEL=Nome do modelo aqui (News / Tweets (stock market) / Oil and Gas (academic texts) / Multigenre)
ID_COLUMN=nome da coluna com os ids dos tweets
CONTENT_COLUMN=nome da coluna com o conteudo dos tweets
PREFIX=prefixo para adicionar ao id dos tweets
DATA_PATH=caminho para o arquivo .csv dos tweets
OUTPUT_PATH=caminho para o arquivo de saída .conllu
KEEP_REPLACE_CONTRACTION=Se a forma original das contrações deve ser mantida (True/False)
```

## 4. Configuração do Container Docker

No terminal, navegue até o diretório onde o Dockerfile está localizado e execute os comandos abaixo em ordem:

1. Construir a imagem Docker:

```
docker build -t porttaggerdante .
```

2. Executar o container Docker:

```
docker run -v "caminho/pro/arquivo/de/saida:/app/output" porttaggerdante
```

Nota: Substitua `caminho/pro/arquivo/de/saida` pelo caminho completo onde você deseja salvar o arquivo de saída `.conllu`.

## 5. Exemplos de Uso

### Exemplo 1: Configuração do arquivo `.env`

```
DEFAULT_MODEL=Tweets (stock market)
ID_COLUMN=ID_Tweet
CONTENT_COLUMN=Content
PREFIX=dante_02_
DATA_PATH=data/tweets.csv
OUTPUT_PATH=output/tweets.conllu
KEEP_REPLACE_CONTRACTION=True
```

### Exemplo 2: Comandos Docker

1. Construir a imagem Docker:

```
docker build -t porttaggerdante .
```

2. Executar o container Docker e mapear a saída:

```
docker run -v "C:/emanuel/desktop/porttagger-DANTE/output:/app/output" porttaggerdante
```

## 6. Contato

Para dúvidas, sugestões ou reportar problemas, entre em contato com:

- Nome: Norton Trevisan Roman
- Email: norton@usp.br