Get Started
textattack augment
textattack attack
textattack train
transformers
textattack eval-model
textattack attack-resume
textattack list
textattack peek-dataset
--help
Recipes
textattack --help
textattack attack --help
textattack attack --recipe [recipe_name]
LSTM
wordCNN
albert-base-v2
bert-base-uncased
distilbert-base-cased
distilbert-base-uncased
roberta-base
xlnet-base-cased
Using TextAttack
Notebook Tutorials
@functools.lru_cache
API User Guide
Attack
Attack.attack()
Attack.cpu_()
Attack.cuda_()
Attack.filter_transformations()
Attack.get_indices_to_order()
Attack.get_transformations()
AttackRecipe
AttackRecipe.build()
Attacker
Attacker.attack_dataset()
Attacker.from_checkpoint()
Attacker.update_attack_args()
AttackArgs
AttackArgs.create_loggers_from_args()
AttackResult
AttackResult.diff_color()
AttackResult.goal_function_result_str()
AttackResult.original_text()
AttackResult.perturbed_text()
AttackResult.str_lines()
SuccessfulAttackResult
FailedAttackResult
FailedAttackResult.goal_function_result_str()
FailedAttackResult.str_lines()
SkippedAttackResult
SkippedAttackResult.goal_function_result_str()
SkippedAttackResult.str_lines()
MaximizedAttackResult
Trainer
Trainer.evaluate()
Trainer.evaluate_step()
Trainer.get_eval_dataloader()
Trainer.get_optimizer_and_scheduler()
Trainer.get_train_dataloader()
Trainer.train()
Trainer.training_step()
TrainingArgs
Dataset
Dataset.__getitem__()
Dataset.__len__()
HuggingFaceDataset
HuggingFaceDataset.__getitem__()
HuggingFaceDataset.__len__()
GoalFunction
GoalFunction.extra_repr_keys()
GoalFunction.get_output()
GoalFunction.get_result()
GoalFunction.get_results()
GoalFunction.init_attack_example()
ClassificationGoalFunction
ClassificationGoalFunction.extra_repr_keys()
TargetedClassification
TargetedClassification.extra_repr_keys()
UntargetedClassification
InputReduction
InputReduction.extra_repr_keys()
TextToTextGoalFunction
MinimizeBleu
MinimizeBleu.extra_repr_keys()
NonOverlappingOutput
Constraint
Constraint.call_many()
Constraint.check_compatibility()
Constraint.extra_repr_keys()
PreTransformationConstraint
PreTransformationConstraint.check_compatibility()
PreTransformationConstraint.extra_repr_keys()
Transformation
CompositeTransformation
SearchMethod
SearchMethod.check_transformation_compatibility()
SearchMethod.perform_search()
SearchMethod.is_black_box
BeamSearch
BeamSearch.extra_repr_keys()
BeamSearch.perform_search()
BeamSearch.is_black_box
GreedySearch
GreedySearch.extra_repr_keys()
GreedyWordSwapWIR
GreedyWordSwapWIR.check_transformation_compatibility()
GreedyWordSwapWIR.extra_repr_keys()
GreedyWordSwapWIR.perform_search()
GreedyWordSwapWIR.is_black_box
AlzantotGeneticAlgorithm
ImprovedGeneticAlgorithm
ImprovedGeneticAlgorithm.extra_repr_keys()
ParticleSwarmOptimization
ParticleSwarmOptimization.check_transformation_compatibility()
ParticleSwarmOptimization.extra_repr_keys()
ParticleSwarmOptimization.perform_search()
ParticleSwarmOptimization.is_black_box
Full Reference
A2TYoo2021
A2TYoo2021.build()
BAEGarg2019
BAEGarg2019.build()
BERTAttackLi2020
BERTAttackLi2020.build()
CheckList2020
CheckList2020.build()
CLARE2020
CLARE2020.build()
DeepWordBugGao2018
DeepWordBugGao2018.build()
FasterGeneticAlgorithmJia2019
FasterGeneticAlgorithmJia2019.build()
GeneticAlgorithmAlzantot2018
GeneticAlgorithmAlzantot2018.build()
HotFlipEbrahimi2017
HotFlipEbrahimi2017.build()
IGAWang2019
IGAWang2019.build()
InputReductionFeng2018
InputReductionFeng2018.build()
Kuleshov2017
Kuleshov2017.build()
MorpheusTan2020
MorpheusTan2020.build()
Pruthi2019
Pruthi2019.build()
PSOZang2020
PSOZang2020.build()
PWWSRen2019
PWWSRen2019.build()
Seq2SickCheng2018BlackBox
Seq2SickCheng2018BlackBox.build()
TextBuggerLi2018
TextBuggerLi2018.build()
TextFoolerJin2019
TextFoolerJin2019.build()
AugmentationResult
AugmentationResult.tempResult
Augmenter
Augmenter.augment()
Augmenter.augment_many()
Augmenter.augment_text_with_ids()
BackTranslationAugmenter
CLAREAugmenter
CharSwapAugmenter
CheckListAugmenter
DeletionAugmenter
EasyDataAugmenter
EasyDataAugmenter.augment()
EmbeddingAugmenter
SwapAugmenter
SynonymInsertionAugmenter
WordNetAugmenter
AttackCommand
AttackCommand.register_subcommand()
AttackCommand.run()
AttackResumeCommand
AttackResumeCommand.register_subcommand()
AttackResumeCommand.run()
AugmentCommand
AugmentCommand.register_subcommand()
AugmentCommand.run()
BenchmarkRecipeCommand
BenchmarkRecipeCommand.register_subcommand()
BenchmarkRecipeCommand.run()
EvalModelCommand
EvalModelCommand.get_preds()
EvalModelCommand.register_subcommand()
EvalModelCommand.run()
EvalModelCommand.test_model_on_dataset()
ModelEvalArgs
ModelEvalArgs.batch_size
ModelEvalArgs.num_examples
ModelEvalArgs.num_examples_offset
ModelEvalArgs.random_seed
ListThingsCommand
ListThingsCommand.register_subcommand()
ListThingsCommand.run()
ListThingsCommand.things()
PeekDatasetCommand
PeekDatasetCommand.register_subcommand()
PeekDatasetCommand.run()
main()
TextAttackCommand
TextAttackCommand.register_subcommand()
TextAttackCommand.run()
TrainModelCommand
TrainModelCommand.register_subcommand()
TrainModelCommand.run()
COLA
LanguageTool
PartOfSpeech
BLEU
chrF
LevenshteinEditDistance
MaxWordsPerturbed
METEOR
InputColumnModification
MaxModificationRate
MaxWordIndexModification
MinWordLength
RepeatModification
StopwordModification
BERTScore
WordEmbeddingDistance
TedMultiTranslationDataset
Dataset.filter_by_labels_()
Dataset.shuffle()
HuggingFaceDataset.filter_by_labels_()
HuggingFaceDataset.shuffle()
get_datasets_dataset_columns()
ClassificationGoalFunctionResult
ClassificationGoalFunctionResult.get_colored_output()
ClassificationGoalFunctionResult.get_text_color_input()
ClassificationGoalFunctionResult.get_text_color_perturbed()
GoalFunctionResult
GoalFunctionResult.get_colored_output()
GoalFunctionResult.get_text_color_input()
GoalFunctionResult.get_text_color_perturbed()
GoalFunctionResultStatus
GoalFunctionResultStatus.MAXIMIZING
GoalFunctionResultStatus.SEARCHING
GoalFunctionResultStatus.SKIPPED
GoalFunctionResultStatus.SUCCEEDED
TextToTextGoalFunctionResult
TextToTextGoalFunctionResult.get_colored_output()
TextToTextGoalFunctionResult.get_text_color_input()
TextToTextGoalFunctionResult.get_text_color_perturbed()
get_bleu()
get_words_cached()
word_difference_score()
GoalFunction.clear_cache()
AttackLogManager
AttackLogManager.add_output_csv()
AttackLogManager.add_output_file()
AttackLogManager.add_output_summary_json()
AttackLogManager.disable_color()
AttackLogManager.enable_stdout()
AttackLogManager.enable_visdom()
AttackLogManager.enable_wandb()
AttackLogManager.flush()
AttackLogManager.log_attack_details()
AttackLogManager.log_result()
AttackLogManager.log_results()
AttackLogManager.log_sep()
AttackLogManager.log_summary()
AttackLogManager.log_summary_rows()
AttackLogManager.metrics
CSVLogger
CSVLogger.close()
CSVLogger.flush()
CSVLogger.log_attack_result()
FileLogger
FileLogger.close()
FileLogger.flush()
FileLogger.log_attack_result()
FileLogger.log_sep()
FileLogger.log_summary_rows()
Logger
Logger.close()
Logger.flush()
Logger.log_attack_result()
Logger.log_hist()
Logger.log_sep()
Logger.log_summary_rows()
VisdomLogger
VisdomLogger.bar()
VisdomLogger.flush()
VisdomLogger.hist()
VisdomLogger.log_attack_result()
VisdomLogger.log_hist()
VisdomLogger.log_summary_rows()
VisdomLogger.table()
VisdomLogger.text()
port_is_open()
WeightsAndBiasesLogger
WeightsAndBiasesLogger.log_attack_result()
WeightsAndBiasesLogger.log_sep()
WeightsAndBiasesLogger.log_summary_rows()
AttackQueries
AttackSuccessRate
WordsPerturbed
Perplexity
USEMetric
Metric
Metric.calculate()
EmbeddingLayer
GloveEmbeddingLayer
LSTMForClassification
T5ForTextToText
load_cached_state_dict()
CNNTextLayer
WordCNNForClassification
GloveTokenizer
WordLevelTokenizer
T5Tokenizer
HuggingFaceModelWrapper
ModelWrapper
PyTorchModelWrapper
SklearnModelWrapper
TensorFlowModelWrapper
GeneticAlgorithm
GeneticAlgorithm.check_transformation_compatibility()
GeneticAlgorithm.extra_repr_keys()
GeneticAlgorithm.perform_search()
GeneticAlgorithm.is_black_box
normalize()
PopulationBasedSearch
PopulationMember
PopulationMember.num_words
PopulationMember.score
PopulationMember.words
SearchMethod.get_victim_model()
LazyLoader
load_module_from_file()
download_from_s3()
download_from_url()
http_get()
path_in_cache()
s3_url()
set_cache_dir()
unzip_file()
get_textattack_model_num_labels()
hashable()
html_style_from_dict()
html_table_from_rows()
load_textattack_model_from_path()
set_seed()
sigmoid()
ANSI_ESCAPE_CODES
ReprMixin
TextAttackFlairTokenizer
add_indent()
check_if_punctuations()
check_if_subword()
color_from_label()
color_from_output()
color_text()
default_class_repr()
flair_tag()
has_letter()
is_one_word()
process_label_name()
strip_BPE_artifacts()
words_from_text()
zip_flair_result()
zip_stanza_result()
batch_model_predict()
AttackedText
AttackedText.align_with_model_tokens()
AttackedText.all_words_diff()
AttackedText.convert_from_original_idxs()
AttackedText.delete_word_at_index()
AttackedText.first_word_diff()
AttackedText.first_word_diff_index()
AttackedText.free_memory()
AttackedText.generate_new_attacked_text()
AttackedText.get_deletion_indices()
AttackedText.insert_text_after_word_index()
AttackedText.insert_text_before_word_index()
AttackedText.ith_word_diff()
AttackedText.ner_of_word_index()
AttackedText.pos_of_word_index()
AttackedText.printable_text()
AttackedText.replace_word_at_index()
AttackedText.replace_words_at_indices()
AttackedText.text_after_word_index()
AttackedText.text_until_word_index()
AttackedText.text_window_around_index()
AttackedText.words_diff_num()
AttackedText.words_diff_ratio()
AttackedText.SPLIT_TOKEN
AttackedText.column_labels
AttackedText.newly_swapped_words
AttackedText.num_words
AttackedText.text
AttackedText.tokenizer_input
AttackedText.words
AttackedText.words_per_input
AttackCheckpoint
AttackCheckpoint.load()
AttackCheckpoint.save()
AttackCheckpoint.dataset_offset
AttackCheckpoint.datetime
AttackCheckpoint.num_failed_attacks
AttackCheckpoint.num_maximized_attacks
AttackCheckpoint.num_remaining_attacks
AttackCheckpoint.num_skipped_attacks
AttackCheckpoint.num_successful_attacks
AttackCheckpoint.results_count
transformation_consists_of()
transformation_consists_of_word_swaps()
transformation_consists_of_word_swaps_and_deletions()
validate_model_goal_function_compatibility()
validate_model_gradient_word_swap_compatibility()
AbstractWordEmbedding
AbstractWordEmbedding.get_cos_sim()
AbstractWordEmbedding.get_mse_dist()
AbstractWordEmbedding.index2word()
AbstractWordEmbedding.nearest_neighbours()
AbstractWordEmbedding.word2index()
GensimWordEmbedding
GensimWordEmbedding.get_cos_sim()
GensimWordEmbedding.get_mse_dist()
GensimWordEmbedding.index2word()
GensimWordEmbedding.nearest_neighbours()
GensimWordEmbedding.word2index()
WordEmbedding
WordEmbedding.counterfitted_GLOVE_embedding()
WordEmbedding.get_cos_sim()
WordEmbedding.get_mse_dist()
WordEmbedding.index2word()
WordEmbedding.nearest_neighbours()
WordEmbedding.word2index()
WordEmbedding.PATH
BackTranslation
SentenceTransformation
WordInsertion
WordInsertionMaskedLM
WordInsertionRandomSynonym
check_if_one_word()
WordMerge
WordMergeMaskedLM
find_merge_index()
WordSwap
WordSwapChangeLocation
idx_to_words()
WordSwapChangeName
WordSwapChangeNumber
WordSwapContract
WordSwapEmbedding
recover_word_case()
WordSwapExtend
WordSwapGradientBased
WordSwapHomoglyphSwap
WordSwapHowNet
WordSwapInflections
WordSwapMaskedLM
WordSwapNeighboringCharacterSwap
WordSwapQWERTY
WordSwapRandomCharacterDeletion
WordSwapRandomCharacterInsertion
WordSwapRandomCharacterSubstitution
WordSwapWordNet
Transformation.deterministic
WordDeletion
WordInnerSwapRandom
WordInnerSwapRandom.deterministic
Attack.clear_cache()
AttackArgs.attack_n
AttackArgs.checkpoint_dir
AttackArgs.checkpoint_interval
AttackArgs.csv_coloring_style
AttackArgs.disable_stdout
AttackArgs.enable_advance_metrics
AttackArgs.log_summary_to_json
AttackArgs.log_to_csv
AttackArgs.log_to_txt
AttackArgs.log_to_visdom
AttackArgs.log_to_wandb
AttackArgs.metrics
AttackArgs.num_examples
AttackArgs.num_examples_offset
AttackArgs.num_successful_examples
AttackArgs.num_workers_per_device
AttackArgs.parallel
AttackArgs.query_budget
AttackArgs.random_seed
AttackArgs.shuffle
AttackArgs.silent
CommandLineAttackArgs
Attacker.attack_interactive()
attack_from_queue()
pytorch_multiprocessing_workaround()
set_env_variables()
AugmenterArgs
AugmenterArgs.enable_advanced_metrics
AugmenterArgs.exclude_original
AugmenterArgs.fast_augment
AugmenterArgs.high_yield
AugmenterArgs.input_column
AugmenterArgs.input_csv
AugmenterArgs.interactive
AugmenterArgs.output_csv
AugmenterArgs.overwrite
AugmenterArgs.pct_words_to_swap
AugmenterArgs.random_seed
AugmenterArgs.recipe
AugmenterArgs.transformations_per_example
DatasetArgs
DatasetArgs.dataset_by_model
DatasetArgs.dataset_from_file
DatasetArgs.dataset_from_huggingface
DatasetArgs.dataset_split
DatasetArgs.filter_by_labels
ModelArgs
ModelArgs.model
ModelArgs.model_from_file
ModelArgs.model_from_huggingface
CommandLineTrainingArgs
CommandLineTrainingArgs.output_dir
TrainingArgs.alpha
TrainingArgs.attack_epoch_interval
TrainingArgs.attack_num_workers_per_device
TrainingArgs.checkpoint_interval_epochs
TrainingArgs.checkpoint_interval_steps
TrainingArgs.early_stopping_epochs
TrainingArgs.gradient_accumulation_steps
TrainingArgs.learning_rate
TrainingArgs.load_best_model_at_end
TrainingArgs.log_to_tb
TrainingArgs.log_to_wandb
TrainingArgs.logging_interval_step
TrainingArgs.num_clean_epochs
TrainingArgs.num_epochs
TrainingArgs.num_train_adv_examples
TrainingArgs.num_warmup_steps
TrainingArgs.output_dir
TrainingArgs.parallel
TrainingArgs.per_device_eval_batch_size
TrainingArgs.per_device_train_batch_size
TrainingArgs.query_budget_train
TrainingArgs.random_seed
TrainingArgs.save_last
TrainingArgs.tb_log_dir
TrainingArgs.wandb_project
TrainingArgs.weight_decay
default_output_dir()
AttackQueries.avg_num_queries()
AttackQueries.calculate()
AttackSuccessRate.attack_accuracy_perc()
AttackSuccessRate.attack_success_rate_perc()
AttackSuccessRate.calculate()
AttackSuccessRate.original_accuracy_perc()
WordsPerturbed.avg_number_word_perturbed_num()
WordsPerturbed.avg_perturbation_perc()
WordsPerturbed.calculate()
Perplexity.calc_ppl()
Perplexity.calculate()
USEMetric.calculate()
Bases: ABC
ABC
A metric for evaluating results and data quality.
Abstract function for computing any values which are to be calculated as a whole during initialization :param results: Attack results for each instance in dataset :type results: AttackResult objects