Source code for OpenAttack.attack_assist.substitute.word.english_counterfit

from .embed_based import EmbedBasedSubstitute
from ....data_manager import DataManager
from ....tags import TAG_English
import torch

class CounterFittedSubstitute(EmbedBasedSubstitute):

    TAGS = { TAG_English }

    def __init__(self, cosine : bool = False, k : int = 50, threshold : float = 0.5, device = None):
        """
        English word substitute based on Counter-fitting word vectors.
        `[pdf] <https://www.aclweb.org/anthology/N16-1018.pdf>`__

        Args:
            cosine: If `true` then the cosine distance is used, otherwise the Euclidian distance is used.
            threshold: Distance threshold. Default: 0.5
            k: Top-k results to return. If k is `None`, all results will be returned. Default: 50
            device: A pytocrh device for computing distances. Default: "cpu"
        
        :Data Requirements: :py:data:`.AttackAssist.CounterFit`
        :Language: english
        
        """

        wordvec = DataManager.load("AttackAssist.CounterFit")

        super().__init__(
            wordvec.word2id,
            torch.from_numpy(wordvec.embedding),
            cosine = cosine,
            k = k,
            threshold = threshold,
            device = device
        )