This repository houses the Stanford Word Substitution (Swords) benchmark. Swords ⚔️ is a benchmark for the task of lexical substitution, the task of finding appropriate substitutes for a target word in a context. For example:
Context:
My favorite thing about her is her straightforward honesty.Target word:
straightforwardSubstitutes:
sincere, genuine, frank, candid, direct, forthright, ...
Additionally, this repository houses the Swords library that offers:
- A common format (JSON) for Swords ⚔️ and prior lexical substitution benchmarks
- Reimplementations of several common lexical substitution methods
- A standardized evaluation pipeline
The Swords library was designed with a high standard of reproducibility. All processing steps between downloading raw data off the web and evaluating model results are preserved in the library. Docker is our weapon of choice for ensuring that these pipelines can be reproduced in the long term.
While Docker is great for reproducibility, it can be cumbersome for prototyping. Hence, we made sure our benchmark format for Swords ⚔️ and past benchmarks is portable, allowing you to easily develop your lexical substitution strategies outside of both Docker and Swords library.
Table of Contents
- Downloading the Swords benchmark
- Getting started with the Swords library
- Evaluating new lexical substitution methods on Swords
- Citation
- Have questions?
The Swords ⚔️ dev and test sets can be downloaded from the following links:
Swords ⚔️ is published under the permissive CC-BY-3.0-US license. The benchmark includes content from the CoInCo benchmark and the MASC corpus, which are both distributed under the same license.
The benchmark is distributed in a simple JSON format, containing all contexts, targets, and substitutes as keys in a single JSON object. Each context/target/substitute is associated with a unique ID, which is a SHA1 hash of its contents. The contents are as follows:
- Each context contains:
context: the context as plain textextra: extra benchmark-specific information about this context
- Each target contains:
context_id: the ID of the context that this target is fromtarget: the target word as plain textoffset: the character-level integer offset for this target in its context (helpful when the target occurs multiple times)pos: the part of speech for this target; can be fed to lexical substitution methods as inputextra: extra benchmark-specific information about this target
- Each substitute contains:
target_id: the ID of the target that this substitute is forsubstitute: the substitute word as plain textextra: extra benchmark-specific information about this substitute
Labels for each substitute ID are found in the substitute_labels key.
Some example Python code for reading this format follows:
from collections import defaultdict
import gzip
import json
# Load benchmark
with gzip.open('swords-v1.1_dev.json.gz', 'r') as f:
swords = json.load(f)
# Gather substitutes by target
tid_to_sids = defaultdict(list)
for sid, substitute in swords['substitutes'].items():
tid_to_sids[substitute['target_id']].append(sid)
# Iterate through targets
for tid, target in swords['targets'].items():
context = swords['contexts'][target['context_id']]
substitutes = [swords['substitutes'][sid] for sid in tid_to_sids[tid]]
labels = [swords['substitute_labels'][sid] for sid in tid_to_sids[tid]]
scores = [l.count('TRUE') / len(l) for l in labels]
print('-' * 80)
print(context['context'])
print('-' * 20)
print('{} ({})'.format(target['target'], target['pos']))
print(', '.join(['{} ({}%)'.format(substitute['substitute'], round(score * 100)) for substitute, score in sorted(zip(substitutes, scores), key=lambda x: -x[1])]))
breakThis should print out:
--------------------------------------------------------------------------------
Kim:
I have completed the invoices for April, May and June and we owe
Pasadena each month for a total of $3,615,910.62. I am waiting to hear
back from Patti on May and June to make sure they are okay with her.
--------------------
total (NOUN)
amount (80%), sum (80%), sum total (60%), price (60%), balance (60%), gross (60%), figure (50%), cost (50%), full amount (40%), whole (30%), number (30%), quantum (10%), aggregate (10%), bill (10%), all (0%), entirety (0%), bulk (0%), flat out (0%), final (0%), body (0%), jackpot (0%), tale (0%), totality (0%), worth (0%), result (0%), allotment (0%), quantity (0%), budget (0%), mass (0%), the works (0%)
For convenience, we package previous lexical substitution benchmarks in the same JSON format which we designed for distributing Swords ⚔️. The CoInCo benchmark (Kremer et al. 2014) can be downloaded in this format here:
Other benchmarks such as SemEval07 (McCarthy and Navigli 2007) and TWSI (Biemann 2012) can be easily created by running the following scripts:
Note that past benchmarks collected substitutes by asking humans to think of them off the top of their heads. Hence, the labels for substitutes in these benchmarks are marked as TRUE_IMPLICIT (as opposed to TRUE in Swords ⚔️), and the quantity of TRUE_IMPLICIT labels represents the number of independent annotators who thought of that substitute. Additionally, targets contain a number of substitutes marked with FALSE_IMPLICIT labels (substitutes which were not produced by annotators) and are used for the ranking setting (see Thater et al. 2010 for more details).
It is highly recommend that you use the Swords benchmark through Docker. Hence, to get started, please install Docker if you do not already have it.
Next, navigate to the docker directory and run ./run.sh which will download and host the Swords Docker image in the background.
Once the Docker image is running via run.sh, you can interact with the command line interface (CLI) via the cli.sh script. A few examples:
- Download the required files for creating the SemEval07 benchmark:
./cli.sh assets semeval07 - Parse the SemEval07 benchmark into common JSON format:
./cli.sh parse semeval07 - Run BERT-based Lexical Substitution (Zhou et al. 2019) on the Swords ⚔️ development set (GPU recommended):
./cli.sh run swords-v1.1_dev --generator bert-based-ls --output_result_json_fp notebooks/swords_dev_bbls.result.json - Download the required files for evaluating traditional lexical substitution metrics:
./cli.sh assets semeval07; ./cli.sh assets eval - Evaluate the result from the previous step:
./cli.sh eval swords-v1.1_dev --result_json_fp notebooks/swords_dev_bbls.result.json --output_metrics_json_fp notebooks/swords_dev_bbls.metrics.json
You can also run ./shell.sh to launch an interactive bash shell in the Docker container, or ./notebook.sh to launch a Jupyter notebook server with all dependencies pre-configured.
Here we provide start-to-finish examples for evaluating new lexical substitution methods on Swords ⚔️, facilitating direct comparison with results from our paper. While our file format makes it straightforward to run lexical substitution inference on Swords ⚔️ outside of Docker (examples below), we strongly recommend that evaluation be run inside Docker for fair comparison.
In the generative setting, lexical substitution methods must output a ranked list of substitute candidates for a given target. Below is a standalone example of a method which outputs 10 common verbs with random ordering, and saves the results into the format expected by our evaluation script:
import gzip
import json
import random
import warnings
with gzip.open('swords-v1.1_dev.json.gz', 'r') as f:
swords = json.load(f)
def generate(
context,
target,
target_offset,
target_pos=None):
"""Produces _substitutes_ for _target_ span within _context_
Args:
context: A text context, e.g. "My favorite thing about her is her straightforward honesty.".
target: The target word, e.g. "straightforward"
target_offset: The character offset of the target word in context, e.g. 35
target_pos: The UD part-of-speech (https://universaldependencies.org/u/pos/) for the target, e.g. "ADJ"
Returns:
A list of substitutes and scores e.g. [(sincere, 80.), (genuine, 80.), (frank, 70), ...]
"""
# TODO: Your method here; placeholder outputs 10 common verbs
substitutes = ['be', 'have', 'do', 'say', 'get', 'make', 'go', 'know', 'take', 'see']
scores = [random.random() for _ in substitutes]
return list(zip(substitutes, scores))
# NOTE: 'substitutes_lemmatized' should be True if your method produces lemmas (e.g. "run") or False if your method produces wordforms (e.g. "ran")
result = {'substitutes_lemmatized': True, 'substitutes': {}}
errors = 0
for tid, target in swords['targets'].items():
context = swords['contexts'][target['context_id']]
try:
result['substitutes'][tid] = generate(
context['context'],
target['target'],
target['offset'],
target_pos=target.get('pos'))
except:
errors += 1
continue
if errors > 0:
warnings.warn(f'{errors} targets were not evaluated due to errors')
with open('swords-v1.1_dev_mygenerator.lsr.json', 'w') as f:
f.write(json.dumps(result))In the ranking setting, lexical substitution methods must rank the ground truth list of candidates from the benchmark based on their contextual relevance for a given target. Below is a standalone example of a method which randomly ranks candidates, and saves the results into the format expected by our evaluation script:
import gzip
import json
import random
import warnings
with gzip.open('swords-v1.1_dev.json.gz', 'r') as f:
swords = json.load(f)
def score(
context,
target,
target_offset,
substitute,
target_pos=None):
"""Scores a _substitute_ for _target_ span within _context_
Args:
context: A text context, e.g. "My favorite thing about her is her straightforward honesty.".
target: The target word, e.g. "straightforward"
target_offset: The character offset of the target word in context, e.g. 35
substitute: A substitute word, e.g. "sincere"
target_pos: The UD part-of-speech (https://universaldependencies.org/u/pos/) for the target, e.g. "ADJ"
Returns:
A score for this substitute, e.g. 80
"""
# TODO: Your method here; placeholder outputs random score
return random.random()
# NOTE: 'substitutes_lemmatized' should be True if your method produces lemmas (e.g. "run") or False if your method produces wordforms (e.g. "ran")
result = {'substitutes_lemmatized': True, 'substitutes': {}}
errors = 0
for sid, substitute in swords['substitutes'].items():
tid = substitute['target_id']
target = swords['targets'][tid]
context = swords['contexts'][target['context_id']]
if tid not in result['substitutes']:
result['substitutes'][tid] = []
try:
substitute_score = score(
context['context'],
target['target'],
target['offset'],
substitute['substitute'],
target_pos=target.get('pos'))
result['substitutes'][tid].append((substitute['substitute'], substitute_score))
except:
errors += 1
continue
if errors > 0:
warnings.warn(f'{errors} substitutes were not evaluated due to errors')
with open('swords-v1.1_dev_myranker.lsr.json', 'w') as f:
f.write(json.dumps(result))To evaluate the example generator above, copy swords-v1.1_dev_mygenerator.lsr.json into the notebooks directory (to transfer it to Docker) and run: ./cli.sh eval swords-v1.1_dev --result_json_fp notebooks/swords-v1.1_dev_mygenerator.lsr.json --output_metrics_json_fp notebooks/mygenerator.metrics.json
To evaluate the example ranker above, copy swords-v1.1_dev_myranker.lsr.json into the notebooks directory and run: ./cli.sh eval swords-v1.1_dev --result_json_fp notebooks/swords-v1.1_dev_myranker.lsr.json --output_metrics_json_fp notebooks/myranker.metrics.json --metrics gap_rat
We highly recommend running our evaluation script within Docker, as subtle differences in Python dependency versions can result in unreproducible numbers. However, if you cannot run Docker, you can try to reproduce our evaluation environment via virtualenv as follows:
git clone [email protected]:p-lambda/swords.git
cd swords
virtualenv venv
source venv/bin/active
pip install nltk==3.5
python -m nltk.downloader wordnet
pip install requests==2.25.1
pip install numpy==1.19.5
pip install -e .
python -m swords.cli eval swords-v1.1_dev --result_json_fp <YOUR_RESULTS_FILE>If you use Swords ⚔️ in your work, please consider citing our paper:
Mina Lee*, Chris Donahue*, Robin Jia, Alexander Iyabor, and Percy Liang. NAACL 2021. Swords: A Benchmark for Lexical Substitution with Improved Data Coverage and Quality.
@inproceedings{lee-etal-2021-swords,
title = "Swords: A Benchmark for Lexical Substitution with Improved Data Coverage and Quality",
author = "Lee, Mina and
Donahue, Chris and
Jia, Robin and
Iyabor, Alexander and
Liang, Percy",
booktitle = "Proceedings of the 2021 Conference of the North American Chapter of the Association for Computational Linguistics: Human Language Technologies",
month = jun,
year = "2021",
address = "Online",
publisher = "Association for Computational Linguistics",
url = "https://arxiv.org/abs/2106.04102",
pages = "4362--4379"
}
If you have any questions, you can reach out to us at [email protected] or [email protected]. If you find an issue in our benchmark or source code, we also invite you to create a pull request and contribute to the benchmark!