-
Notifications
You must be signed in to change notification settings - Fork 0
/
prepare_AOC.py
422 lines (348 loc) · 14.1 KB
/
prepare_AOC.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
"""
The AOC dataset is grouped by HIT (i.e.: 12 annotations for each row).
This script explodes the dataset such that each row is a single annotation.
Since annotators are given the option to provide their information only once,
the script also adds the annotator's information to each row.
"""
import os
import re
import math
import random
import statistics
import pandas as pd
from tqdm import tqdm
from pathlib import Path
from itertools import groupby
from collections import Counter
tqdm.pandas()
from urllib.request import urlretrieve
import argparse
BASE_DATASET_DIR = "data/AOC"
RAW_DATASET_FILE = str(Path(BASE_DATASET_DIR, "dialectid_data.tsv"))
DATASET_URL = (
"https://github.com/sjeblee/AOC/master/"
+ "stuff-from-omar/annotated-aoc-data/dialectid_data.tsv"
)
def download_AOC():
# Create the dataset directory
os.makedirs(BASE_DATASET_DIR, exist_ok=True)
# Retrieve the dataset
urlretrieve(DATASET_URL, RAW_DATASET_FILE)
def explode_AOC():
"""Explode HIT annotation rows into single annotation ones."""
# Loading the dataset using pandas causes issues
# TODO: Is that a reason of " within some lines?
with open(RAW_DATASET_FILE, "r") as f:
lines = [l.strip() for l in f]
fields = [l.split("\t") for l in tqdm(lines)]
assert len(set([len(f) == 100 for f in fields]))
df = pd.DataFrame(data=fields[1:], columns=fields[0])
# Columns repeated 12 times per HIT
columns = ["Sentence", "DClass", "DLevel", "source", "document", "part", "segment"]
dfs = []
for i in range(1, 13):
columns_names = [
"HIT_info",
"HIT-ID",
"AID",
"AssignmentID",
"HITStatus",
"WorkerIP",
"WorkerCountry",
"WorkerCity",
"country_live",
"native_arabic",
"native_dialect",
"years_speaking",
"StartTime_str",
"EndTime_str",
"WorkTime",
"comment",
]
columns_names += [f"{c}{i}" for c in columns]
dfs.append(df[columns_names].copy())
dfs[-1].columns = [re.sub("\d+$", "", c) for c in columns_names]
dfs[-1]["segment_order_in_page"] = i
concat_df = pd.concat(dfs)
# Infer information about the annotators
# Steps:
# 1) Group information by AID
# 2) Find the most common value for country_live, native_arabic, native_dialect, years_speaking
# 3) Generate a dictionary for the most common values for each column per annotator
# 4) Use the dictionary to populate the exploded version of the dataset
annotator_information_columns = [
"country_live",
"native_arabic",
"native_dialect",
"years_speaking",
]
annotator_information_dict = {}
for AID, gdf in concat_df.groupby("AID"):
annotator_information_dict[AID] = {"# annotations": gdf.shape[0]}
for col in annotator_information_columns:
# TODO: Ignore annotators having contradictions in the information?
# Find the most common value per column
col_values = [
v
for v in gdf[col].tolist()
if not (v == "prompt" or (type(v) == float and math.isnan(v)))
]
most_common_value = statistics.mode(col_values) if col_values else None
annotator_information_dict[AID][col] = most_common_value
# Use the inferred annotator information
for col in annotator_information_columns:
concat_df[col] = concat_df.progress_apply(
lambda row: annotator_information_dict[row["AID"]][col], axis=1
)
concat_df["is_control_sentence"] = concat_df["source"].apply(
lambda s: str(s).endswith("_a")
)
# Make sure samples with Level set to "msa" or "junk" do not have a dialect label
for level_label in ["msa", "junk"]:
assert sorted(
[
str(v)
for v in concat_df.loc[concat_df["DLevel"] == level_label, "DClass"]
.unique()
.tolist()
]
) == [
"N/A",
"prompt",
]
# Assign "level_label" as the dialect
concat_df.loc[concat_df["DLevel"] == level_label, "DClass"] = level_label
# Replace "null" and "prompt" values in labels with "missing"
MISSING_LABEL = "missing"
for column in ["DClass", "DLevel"]:
concat_df.loc[concat_df[column].isin(["prompt", "N/A"]), column] = MISSING_LABEL
return concat_df
def augment_AOC_cols(df):
"""Augment the columns of the dataframe.
Args:
df: A dataframe of AOC samples.
Returns:
An augmented version of the dataframe.
"""
df["#_tokens"] = df["Sentence"].apply(lambda s: len(str(s).split()))
df["length"] = df["#_tokens"].apply(
lambda n: "short" if n < 5 else "long" if n > 27 else "medium"
)
# Generate an ID for each sentence to refer to it later
sentences_count = Counter(df["Sentence"])
sentences_id = {s: i for i, (s, c) in enumerate(sentences_count.most_common())}
df["SENTENCE_ID"] = df["Sentence"].apply(lambda s: sentences_id[s])
df["document"] = df["document"].apply(
lambda d: int(d) if str(d) != "nan" else "nan"
)
# Generate an ID for each comment as the source, document ID, and sentence ID
df["COMMENT_ID"] = df.apply(
lambda row: f"{row['source']}_{row['document']}_{row['SENTENCE_ID']}", axis=1
)
# Map the categorical dialectness levels to numeric values
dialectness_level_map = {"most": 1, "mixed": 2 / 3, "little": 1 / 3, "msa": 0}
df["dialectness_level"] = df["DLevel"].apply(
lambda l: dialectness_level_map.get(l, None)
)
return df
def group_annotations_by_sentence_id(df):
"""Group annotations into rows (one for each sentence)
Args:
df: A dataframe of single annotation per row
Returns:
A grouped dataframe of annotations
"""
# Form the annotations df - grouped by the generated comment id
annotations = []
df.sort_values(by="COMMENT_ID", inplace=True)
for comment_id, group in groupby(
[row for i, row in df.iterrows()],
key=lambda row: row["COMMENT_ID"],
):
group_items = list(group)
group_items = sorted(group_items, key=lambda d: d["AID"])
assert len(set([item["Sentence"] for item in group_items])) == 1
sentence = group_items[0]["Sentence"]
comment_id = group_items[0]["COMMENT_ID"]
dialect_level = [str(group_item["DLevel"]) for group_item in group_items]
dialect_class = [group_item["DClass"] for group_item in group_items]
native_dialect = [
str(group_item["native_dialect"]) for group_item in group_items
]
native_arabic_speaker = [
str(group_item["native_arabic"]) for group_item in group_items
]
annotator_residence = [group_item["country_live"] for group_item in group_items]
annotator_city_from_IP = [
group_item["WorkerCity"] for group_item in group_items
]
annotator_country_from_IP = [
group_item["WorkerCountry"] for group_item in group_items
]
dialectness_level = [
group_item["dialectness_level"] for group_item in group_items
]
non_nan_dialectness_level = [
l for l in dialectness_level if l in [0, 1 / 3, 2 / 3, 1]
]
annotations.append(
{
"annotator_city_from_IP": annotator_city_from_IP,
"annotator_country_from_IP": annotator_country_from_IP,
"annotator_dialect": native_dialect,
"annotator_id": [group_item["AID"] for group_item in group_items],
"annotator_residence": annotator_residence,
"annotator_native_arabic_speaker": native_arabic_speaker,
# TODO: Fix this!
"average_dialectness_level": (
sum(non_nan_dialectness_level) / len(non_nan_dialectness_level)
)
if non_nan_dialectness_level
else None,
"comment_id": comment_id,
"dialect_level": dialect_level,
"dialect": dialect_class,
"dialectness_level": dialectness_level,
"document": group_items[0]["document"],
"ratio_junk_or_missing": sum(
[l in ["missing", "junk"] for l in dialect_level]
)
/ len(dialect_level),
"length": group_items[0]["length"],
"number_annotations": len(dialect_level),
"same_label": len(set(dialectness_level)) == 1,
"same_polarity": all([s == 0 for s in dialectness_level])
or all([s != 0 for s in dialectness_level]),
"sentence": sentence,
"source": group_items[0]["source"],
}
)
annotations_df = pd.DataFrame(annotations)
return annotations_df
def generate_sliced_df(df, percentage_within):
"""Find the part of the dataset covering at least "percentage_within"% of the dataset.
Args:
df: The dataframe to slice.
percentage_within: The percentage of the dataframe to slice.
Returns:
A dataframe of the required percentage size.
"""
n_required = int(percentage_within * df.shape[0])
documents = df["document"].tolist()
n_comments_per_document = Counter(documents)
sorted_doc_comments_counts = []
last_doc = None
for doc in documents:
if doc != last_doc:
sorted_doc_comments_counts.append(n_comments_per_document[doc])
last_doc = doc
doc_cum_counts = sorted_doc_comments_counts
for i in range(1, len(doc_cum_counts)):
doc_cum_counts[i] += doc_cum_counts[i - 1]
if doc_cum_counts[i] >= n_required:
return df.iloc[: doc_cum_counts[i]]
return df
def main():
parser = argparse.ArgumentParser("Form AOC data splits.")
parser.add_argument(
"--train_size",
default=0.8,
help="Percentage of the dataset to be used for the training split.",
)
parser.add_argument(
"--dev_size",
default=0.1,
help="Percentage of the dataset to be used for the development split.",
)
args = parser.parse_args()
train_size = args.train_size
dev_size = args.dev_size
download_AOC()
df = explode_AOC()
df.to_csv(str(Path(BASE_DATASET_DIR, "1_AOC_exploded.tsv")), index=False, sep="\t")
df = augment_AOC_cols(df)
df.to_csv(str(Path(BASE_DATASET_DIR, "2_AOC_augmented.tsv")), index=False, sep="\t")
annotations_df = group_annotations_by_sentence_id(df)
annotations_df.to_csv(
str(Path(BASE_DATASET_DIR, "3_AOC_aggregated.tsv")), index=False, sep="\t"
)
# Filter out samples having majority of dialectness level annotations as junk or missing
annotations_df[annotations_df["ratio_junk_or_missing"] >= 2 / 3].to_csv(
str(Path(BASE_DATASET_DIR, "4a_AOC_aggregated_junk_samples.tsv")),
index=False,
sep="\t",
)
annotations_df = annotations_df[annotations_df["ratio_junk_or_missing"] < 2 / 3]
annotations_df.to_csv(
str(Path(BASE_DATASET_DIR, "4_AOC_aggregated_discard_junk_samples.tsv")),
index=False,
sep="\t",
)
# Find the number of comments for each document in the corpus
comments_per_document = (
annotations_df["document"]
.value_counts()
.reset_index()
.to_dict(orient="records")
)
comments_per_document = {d["index"]: d["document"] for d in comments_per_document}
annotations_df["comments_per_document"] = annotations_df["document"].apply(
lambda d: comments_per_document[d]
)
annotations_df.sort_values(
by=["comments_per_document", "document"], inplace=True, ascending=False
)
train_dfs, dev_dfs, test_dfs = [], [], []
# Perform the sampling for each source independently
for source in ["youm7", "alghad", "alriyadh"]:
source_annotations_df = annotations_df[
annotations_df["source"].isin([f"{source}_c", f"{source}_a"])
]
# Shuffle the documents but making sure comments to the same document are not split
unique_documents_ids = list(set(source_annotations_df["document"].tolist()))
random.seed(42)
random.shuffle(unique_documents_ids)
shuffled_docs_annotations_df = pd.concat(
[
source_annotations_df.loc[
source_annotations_df["document"] == document_id, :
]
for document_id in tqdm(unique_documents_ids)
]
)
train_df = generate_sliced_df(shuffled_docs_annotations_df, train_size)
train_dfs.append(train_df)
dev_df = generate_sliced_df(
shuffled_docs_annotations_df, train_size + dev_size
).iloc[train_df.shape[0] :]
dev_dfs.append(dev_df)
test_df = shuffled_docs_annotations_df.iloc[
train_df.shape[0] + dev_df.shape[0] :
]
test_dfs.append(test_df)
train_df = pd.concat(train_dfs)
dev_df = pd.concat(dev_dfs)
test_df = pd.concat(test_dfs)
assert annotations_df.shape[0] == (
train_df.shape[0] + dev_df.shape[0] + test_df.shape[0]
)
train_df_docs = set(
train_df.apply(
lambda row: f"{row['source']}_{row['document']}", axis=1
).tolist()
)
dev_df_docs = set(
dev_df.apply(lambda row: f"{row['source']}_{row['document']}", axis=1).tolist()
)
test_df_docs = set(
test_df.apply(lambda row: f"{row['source']}_{row['document']}", axis=1).tolist()
)
# Make sure the document ids are not shared between the splits
assert train_df_docs.intersection(dev_df_docs) == set()
assert dev_df_docs.intersection(test_df_docs) == set()
assert train_df_docs.intersection(test_df_docs) == set()
train_df.to_csv(str(Path(BASE_DATASET_DIR, f"train.tsv")), index=False, sep="\t")
dev_df.to_csv(str(Path(BASE_DATASET_DIR, f"dev.tsv")), index=False, sep="\t")
test_df.to_csv(str(Path(BASE_DATASET_DIR, f"test.tsv")), index=False, sep="\t")
if __name__ == "__main__":
main()