/acceptability-prediction-in-context

Primary LanguagePythonApache License 2.0Apache-2.0

Requirements

  • python3.6
  • transformers==3.0.0
  • pytorch-transformers==1.2.0 (for GPT-2)

The exact environment that the code is tested:

boto3==1.14.15
botocore==1.17.15
certifi==2020.6.20
chardet==3.0.4
click==7.1.2
cycler==0.10.0
dataclasses==0.7
docutils==0.15.2
filelock==3.0.12
future==0.18.2
idna==2.10
jmespath==0.10.0
joblib==0.16.0
kiwisolver==1.2.0
matplotlib==3.2.2
numpy==1.19.0
packaging==20.4
pandas==1.0.5
patsy==0.5.1
Pillow==7.2.0
pkg-resources==0.0.0
pyparsing==2.4.7
python-dateutil==2.8.1
pytorch-transformers==1.2.0
pytz==2020.1
regex==2020.6.8
requests==2.24.0
s3transfer==0.3.3
sacremoses==0.0.43
scipy==1.5.0
sentencepiece==0.1.91
six==1.15.0
statsmodels==0.11.1
tokenizers==0.8.0rc4
torch==1.2.0
torchvision==0.4.0
tqdm==4.47.0
transformers==3.0.0
urllib3==1.25.9

TODO

  • update GPT2 to use transformers==3.0.0 (the current code breaks when context is included at test time)

Acceptability Prediction

  • Code for computing the acceptability measures (LP, MeanLP, etc) using the transformer models are under code/
  • To reproduce the results in the paper, use the following scripts under code/:
    • GPT2: run_gpt.sh
    • BERT (cased): run_bert_cased.sh
    • BERT (uncased): run_bert_uncased.sh
    • XLNet(unidirectional context): run_xlnet_unidir.sh
    • XLNet (bidirectional context): run_xlnet_bidir.sh
  • Main program for computing the acceptability measures and assessing them against human ratings is compute_model_score.py
usage: compute_model_score.py [-h] -r HUMAN_RATING_PICKLE -i INPUT_CSV -m
                              MODEL_NAME -u UNIGRAM_PICKLE [-c] [-v]
                              [-d DEVICE] [--xlnet-bidir]

Computes correlation using pytorch transformer models

optional arguments:
  -h, --help            show this help message and exit
  -r HUMAN_RATING_PICKLE, --human-rating-pickle HUMAN_RATING_PICKLE
                        Pickle file containing human ratings
  -i INPUT_CSV, --input-csv INPUT_CSV
                        Mturk input csv file containing sentence data
  -m MODEL_NAME, --model-name MODEL_NAME
                        Pretrained model name (gpt2/gpt2-medium/bert-
                        base-[un]cased/bert-large-[un]cased)
  -u UNIGRAM_PICKLE, --unigram-pickle UNIGRAM_PICKLE
                        Pickle file containing unigram frequencies (used for
                        SLOR and NormLP)
  -c, --use-context     use context at test time for the model
  -v, --verbose         verbose print
  -d DEVICE, --device DEVICE
                        specify the device to use (cpu or cuda:X for gpu);
                        default=cpu
  --xlnet-bidir         bidir for xlnet (sees left and right context)

Human Ratings

  • Collected human ratings without context, with real context and with random context are in the csv files under human-ratings/.
  • These are filtered and preprocessed ratings with outliers removed (detailed in the last paragraph of section 2.1).
  • Column names in the CSV files should be largely self-explanatory
    • translated means whether the sentence has undergone round-trip machine translation, 1 indicates yes and 0 otherwise
    • source-langage is the intermediate language of the round-trip machine translation (always "en" if translated=0)

Publication

Jey Han Lau, Carlos Armendariz, Shalom Lappin, Matthew Purver, and Chang Shu (2020). How Furiously Can Colorless Green Ideas Sleep? Sentence Acceptability in Context. In Transactions of the Association for Computational Linguistics, Vol 8, pages 296—310.