1
0
mirror of https://github.com/QData/TextAttack.git synced 2021-10-13 00:05:06 +03:00
Files
textattack-nlp-transformer/textattack/constraints/grammaticality/language_models/language_model_constraint.py
2020-07-03 16:17:47 -04:00

56 lines
2.0 KiB
Python

from abc import ABC, abstractmethod
from textattack.constraints import Constraint
class LanguageModelConstraint(Constraint, ABC):
"""
Determines if two sentences have a swapped word that has a similar
probability according to a language model.
Args:
max_log_prob_diff (float): the maximum decrease in log-probability
in swapped words from x to x_adv
compare_against_original (bool): whether to compare against the original
text or the most recent
"""
def __init__(self, max_log_prob_diff=None, compare_against_original=True):
if max_log_prob_diff is None:
raise ValueError("Must set max_log_prob_diff")
self.max_log_prob_diff = max_log_prob_diff
self.compare_against_original = compare_against_original
@abstractmethod
def get_log_probs_at_index(self, text_list, word_index):
""" Gets the log-probability of items in `text_list` at index
`word_index` according to a language model.
"""
raise NotImplementedError()
def _check_constraint(self, transformed_text, current_text, original_text=None):
if self.compare_against_original:
current_text = original_text
try:
indices = transformed_text.attack_attrs["newly_modified_indices"]
except KeyError:
raise KeyError(
"Cannot apply language model constraint without `newly_modified_indices`"
)
for i in indices:
probs = self.get_log_probs_at_index((current_text, transformed_text), i)
if len(probs) != 2:
raise ValueError(
f"Error: get_log_probs_at_index returned {len(probs)} values for 2 inputs"
)
cur_prob, transformed_prob = probs
if transformed_prob <= cur_prob - self.max_log_prob_diff:
return False
return True
def extra_repr_keys(self):
return ["max_log_prob_diff"]