UIS-QA / scripts /README.md
UIS-Digger's picture
Upload uis_qa.tsv
ef97f79
# Scripts: encryption & key request
For full dataset description and evaluation, see the [main README](../README.md).
## Decryption key (evaluators)
Obtain the decryption key via the **[UIS-QA Decryption Key Request](https://script.google.com/macros/s/AKfycbwi7wA78QvD0MO-AbdjSFMsbbbvJCK1A_15pRPyfBTBynUzqR9pY5piy3cHhxC1T_5c/exec)** form (reCAPTCHA verification). The key is sent to your email after submission. Then decrypt locally:
```bash
pip install cryptography
python scripts/decrypt_answers.py <encrypted.tsv> -o <decrypted.tsv> --key-file <key.txt>
```
Use the decrypted file only for **local evaluation**. Do not redistribute the key or decrypted answers.
## Maintainers: encrypt & key distribution
Encrypt the TSV and save the key (do not commit `.decryption_key.txt`):
```bash
pip install cryptography
python scripts/encrypt_answers.py test/uis_qa.tsv -o test/uis_qa_encrypted.tsv --key-out .decryption_key.txt
```
To distribute the key via the same Web App form, see [GOOGLE_FORM_KEY_REQUEST.md](GOOGLE_FORM_KEY_REQUEST.md). Optional: use `--password "..."` for password-based encryption; evaluators then use `--password "..."` to decrypt.