Repository files navigation

Documentation •Features & Uses •Usage Examples •Attack Models •Toolkit Design

OpenAttack is an open-source Python-based textual adversarial attack toolkit, which handles the whole process of textual adversarial attacking, including preprocessing text, accessing the victim model, generating adversarial examples and evaluation.

⭐️Support for all attack types. OpenAttack supports all types of attacks including sentence-/word-/character-level perturbations and gradient-/score-/decision-based/blind attack models;

⭐️Multilinguality. OpenAttack supports English and Chinese now. Its extensible design enables quick support for more languages;

⭐️Parallel processing. OpenAttack provides support for multi-process running of attack models to improve attack efficiency;

⭐️Compatibility with 🤗 Hugging Face. OpenAttack is fully integrated with 🤗Transformers andDatasets libraries;

⭐️Great extensibility. You can easily attack a customized victim model on any customized dataset or develop and evaluate a customized attack model.

✅ Providing various handybaselines for attack models;

✅ Comprehensivelyevaluating attack models using its thorough evaluation metrics;

✅ Assisting in quick development ofnew attack models with the help of its common attack components;

✅ Evaluating therobustness of a machine learning model against various adversarial attacks;

✅ Conductingadversarial training to improve robustness of a machine learning model by enriching the training data with generated adversarial examples.

pip install OpenAttack

git clone https://github.com/thunlp/OpenAttack.gitcd OpenAttackpython setup.py install

After installation, you can try runningdemo.py to check if OpenAttack works well:

python demo.py

OpenAttack builds in some commonly used NLP models like BERT (Devlin et al. 2018) and RoBERTa (Liu et al. 2019) that have been fine-tuned on some commonly used datasets (such asSST-2). You can effortlessly conduct adversarial attacks against these built-in victim models.

The following code snippet shows how to use PWWS, a greedy algorithm-based attack model (Ren et al., 2019), to attack BERT on the SST-2 dataset (the complete executable code ishere).

importOpenAttackasoaimportdatasets# use the Hugging Face's datasets library# change the SST dataset into 2-classdefdataset_mapping(x):return {"x":x["sentence"],"y":1ifx["label"]>0.5else0,    }# choose a trained victim classification modelvictim=oa.DataManager.loadVictim("BERT.SST")# choose 20 examples from SST-2 as the evaluation datadataset=datasets.load_dataset("sst",split="train[:20]").map(function=dataset_mapping)# choose PWWS as the attacker and initialize it with default parametersattacker=oa.attackers.PWWSAttacker()# prepare for attackingattack_eval=OpenAttack.AttackEval(attacker,victim)# launch attacks and print attack resultsattack_eval.eval(dataset,visualize=True)

importOpenAttackasoaimportnumpyasnpimportdatasetsimportnltkfromnltk.sentiment.vaderimportSentimentIntensityAnalyzer# configure access interface of the customized victim model by extending OpenAttack.Classifier.classMyClassifier(oa.Classifier):def__init__(self):# nltk.sentiment.vader.SentimentIntensityAnalyzer is a traditional sentiment classification model.nltk.download('vader_lexicon')self.model=SentimentIntensityAnalyzer()defget_pred(self,input_):returnself.get_prob(input_).argmax(axis=1)# access to the classification probability scores with respect input sentencesdefget_prob(self,input_):ret= []forsentininput_:# SentimentIntensityAnalyzer calculates scores of “neg” and “pos” for each instanceres=self.model.polarity_scores(sent)# we use 𝑠𝑜𝑐𝑟𝑒_𝑝𝑜𝑠 / (𝑠𝑐𝑜𝑟𝑒_𝑛𝑒𝑔 + 𝑠𝑐𝑜𝑟𝑒_𝑝𝑜𝑠) to represent the probability of positive sentiment# Adding 10^−6 is a trick to avoid dividing by zero.prob= (res["pos"]+1e-6)/ (res["neg"]+res["pos"]+2e-6)ret.append(np.array([1-prob,prob]))# The get_prob method finally returns a np.ndarray of shape (len(input_), 2). See Classifier for detail.returnnp.array(ret)defdataset_mapping(x):return {"x":x["sentence"],"y":1ifx["label"]>0.5else0,    }# load some examples of SST-2 for evaluationdataset=datasets.load_dataset("sst",split="train[:20]").map(function=dataset_mapping)# choose the costomized classifier as the victim modelvictim=MyClassifier()# choose PWWS as the attacker and initialize it with default parametersattacker=oa.attackers.PWWSAttacker()# prepare for attackingattack_eval=oa.AttackEval(attacker,victim)# launch attacks and print attack resultsattack_eval.eval(dataset,visualize=True)

importOpenAttackasoaimporttransformersimportdatasets# load a fine-tuned sentiment analysis model from Transformers (you can also use our fine-tuned Victim.BERT.SST)tokenizer=transformers.AutoTokenizer.from_pretrained("echarlaix/bert-base-uncased-sst2-acc91.1-d37-hybrid")model=transformers.AutoModelForSequenceClassification.from_pretrained("echarlaix/bert-base-uncased-sst2-acc91.1-d37-hybrid",num_labels=2,output_hidden_states=False)victim=oa.classifiers.TransformersClassifier(model,tokenizer,model.bert.embeddings.word_embeddings)# choose PWWS as the attacker and initialize it with default parametersattacker=oa.attackers.PWWSAttacker()# create your customized datasetdataset=datasets.Dataset.from_dict({"x": ["I hate this movie.","I like this apple."    ],"y": [0,# 0 for negative1,# 1 for positive    ]})# prepare for attackingattack_eval=oa.AttackEval(attacker,victim,metrics= [oa.metric.EditDistance(),oa.metric.ModificationRate()])# launch attacks and print attack resultsattack_eval.eval(dataset,visualize=True)

importOpenAttackasoaimportdatasetsdefdataset_mapping(x):return {"x":x["sentence"],"y":1ifx["label"]>0.5else0,    }victim=oa.loadVictim("BERT.SST")dataset=datasets.load_dataset("sst",split="train[:20]").map(function=dataset_mapping)attacker=oa.attackers.GeneticAttacker()attack_eval=oa.AttackEval(attacker,victim)# Using multiprocessing simply by specify num_workersattack_eval.eval(dataset,visualize=True,num_workers=4)

According to the level of perturbations imposed on original input, textual adversarial attack models can be categorized into sentence-level, word-level, character-level attack models.

According to the accessibility to the victim model, textual adversarial attack models can be categorized intogradient-based,score-based,decision-based andblind attack models.

TAADPapers is a paper list which summarizes almost all the papers concerning textual adversarial attack and defense. You can have a look at this list to find more attack models.

Currently OpenAttack includes 15 typical attack models against text classification models that coverall attack types.

Here is the list of currently involved attack models.

• Sentence-level
  • (SEA)Semantically Equivalent Adversarial Rules for Debugging NLP Models.Marco Tulio Ribeiro, Sameer Singh, Carlos Guestrin. ACL 2018.decision [pdf] [code]
  • (SCPN)Adversarial Example Generation with Syntactically Controlled Paraphrase Networks.Mohit Iyyer, John Wieting, Kevin Gimpel, Luke Zettlemoyer. NAACL-HLT 2018.blind [pdf] [code&data]
  • (GAN)Generating Natural Adversarial Examples.Zhengli Zhao, Dheeru Dua, Sameer Singh. ICLR 2018.decision [pdf] [code]
• Word-level
  • (TextFooler)Is BERT Really Robust? A Strong Baseline for Natural Language Attack on Text Classification and Entailment.Di Jin, Zhijing Jin, Joey Tianyi Zhou, Peter Szolovits. AAAI-20.score [pdf] [code]
  • (PWWS)Generating Natural Language Adversarial Examples through Probability Weighted Word Saliency.Shuhuai Ren, Yihe Deng, Kun He, Wanxiang Che. ACL 2019.score [pdf] [code]
  • (Genetic)Generating Natural Language Adversarial Examples.Moustafa Alzantot, Yash Sharma, Ahmed Elgohary, Bo-Jhang Ho, Mani Srivastava, Kai-Wei Chang. EMNLP 2018.score [pdf] [code]
  • (SememePSO)Word-level Textual Adversarial Attacking as Combinatorial Optimization.Yuan Zang, Fanchao Qi, Chenghao Yang, Zhiyuan Liu, Meng Zhang, Qun Liu and Maosong Sun. ACL 2020.score [pdf] [code]
  • (BERT-ATTACK)BERT-ATTACK: Adversarial Attack Against BERT Using BERT.Linyang Li, Ruotian Ma, Qipeng Guo, Xiangyang Xue, Xipeng Qiu. EMNLP 2020.score [pdf] [code]
  • (BAE)BAE: BERT-based Adversarial Examples for Text Classification.Siddhant Garg, Goutham Ramakrishnan. EMNLP 2020.score [pdf] [code]
  • (FD)Crafting Adversarial Input Sequences For Recurrent Neural Networks.Nicolas Papernot, Patrick McDaniel, Ananthram Swami, Richard Harang. MILCOM 2016.gradient [pdf]
• Word/Char-level
  • (TextBugger)TEXTBUGGER: Generating Adversarial Text Against Real-world Applications.Jinfeng Li, Shouling Ji, Tianyu Du, Bo Li, Ting Wang. NDSS 2019.gradientscore [pdf]
  • (UAT)Universal Adversarial Triggers for Attacking and Analyzing NLP.Eric Wallace, Shi Feng, Nikhil Kandpal, Matt Gardner, Sameer Singh. EMNLP-IJCNLP 2019.gradient [pdf] [code] [website]
  • (HotFlip)HotFlip: White-Box Adversarial Examples for Text Classification.Javid Ebrahimi, Anyi Rao, Daniel Lowd, Dejing Dou. ACL 2018.gradient [pdf] [code]
• Char-level
  • (VIPER)Text Processing Like Humans Do: Visually Attacking and Shielding NLP Systems.Steffen Eger, Gözde Gül ¸Sahin, Andreas Rücklé, Ji-Ung Lee, Claudia Schulz, Mohsen Mesgar, Krishnkant Swarnkar, Edwin Simpson, Iryna Gurevych. NAACL-HLT 2019.score [pdf] [code&data]
  • (DeepWordBug)Black-box Generation of Adversarial Text Sequences to Evade Deep Learning Classifiers.Ji Gao, Jack Lanchantin, Mary Lou Soffa, Yanjun Qi. IEEE SPW 2018.score [pdf] [code]

The following table illustrates the comparison of the attack models.

Considering the significant distinctions among different attack models, we leave considerable freedom for the skeleton design of attack models, and focus more on streamlining the general processing of adversarial attacking and the common components used in attack models.

OpenAttack has 7 main modules:

• TextProcessor: processing the original text sequence to assist attack models in generating adversarial examples;
• Victim: wrapping victim models;
• Attacker: comprising various attack models;
• AttackAssist: packing different word/character substitution methods that are used in word-/character-level attack models and some other components used in sentence-level attack models like the paraphrasing model;
• Metric: providing several adversarial example quality metrics that can serve as either the constraints on the adversarial examples during attacking or evaluation metrics for evaluating adversarial attacks;
• AttackEval: evaluating textual adversarial attacks from attack effectiveness, adversarial example quality and attack efficiency;
• DataManager: managing all data and saved models that are used in other modules.

Please cite ourpaper if you use this toolkit:

@inproceedings{zeng2020openattack,  title={{Openattack: An open-source textual adversarial attack toolkit}},  author={Zeng, Guoyang and Qi, Fanchao and Zhou, Qianrui and Zhang, Tingji and Hou, Bairu and Zang, Yuan and Liu, Zhiyuan and Sun, Maosong},  booktitle={Proceedings of the 59th Annual Meeting of the Association for Computational Linguistics and the 11th International Joint Conference on Natural Language Processing: System Demonstrations},  pages={363--371},  year={2021},  url={https://aclanthology.org/2021.acl-demo.43},  doi={10.18653/v1/2021.acl-demo.43}}

We thank all the contributors to this project. And more contributions are very welcome.