task/example/README.md

# Task Example

This folder provides an example of the structure of task outputs produced by [GroTE](https://github.com/gsarti/grote).

## Folder Structure

```shell
example/
├── inputs/
│   └── eng-ita/
│       ├── example_eng-ita_doc1_input.txt
│       └── ... # GroTE input files with tags and ||| source-target separator
├── outputs/
│   └── eng-ita/
│       ├── logs/
│       │   └── example_eng-ita_t0_logs.csv # GroTE logs
│       ├── example_eng-ita_doc1_t0_output.txt
│       └── ... # GroTE output files (one edited target per line)
├── doc_id_map.json # Source and doc name maps
└── README.md
```

## Inputs

This example uses the same files of `pretask`, with highlights in the `supervised` modality produced by XCOMET-XXL. The `doc_id_map.json` file shows the mapping between `{{DOC_ID}}` and the original filename found in the `source_path`. Input files for the task have names using the format:

```python
"{{TASK_ID}}_{{TRANSLATION_DIRECTION}}_{{DOC_ID}}_input.txt"
```

Sentences use the FastAlign format `{{SOURCE}} ||| {{TARGET}}`, with source and target being regular texts without special tokenization. `<minor>...</minor>` and  `<major>...</major>` tags are used to mark potential errors to be highlighted in the editing interface.

## Outputs

Files in `outputs/{{TRANSLATION_DIRECTION}}` contain post-edited outputs (one per line, matching inputs) using format:

```python
"{{TASK_ID}}_{{TRANSLATION_DIRECTION}}_{{DOC_ID}}_{{TRANSLATOR_ID}}_output.txt"
```

The contents of `outputs/{{TRANSLATION_DIRECTION}}/logs` can be used to analyze editing behavior at a granular scale. Each log file has format:

```python
"{{TASK_ID}}_{{TRANSLATION_DIRECTION}}_{{TRANSLATOR_ID}}_logs.csv"
```

Refer to [GroTE](https://github.com/gsarti/grote) documentation for more information about the logs.