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()
LogitSum
NamedEntityRecognition
TargetedStrict
TargetedBonus
ClassificationGoalFunction
ClassificationGoalFunction.extra_repr_keys()
TargetedClassification
TargetedClassification.extra_repr_keys()
UntargetedClassification
InputReduction
InputReduction.extra_repr_keys()
TextToTextGoalFunction
MinimizeBleu
MinimizeBleu.extra_repr_keys()
NonOverlappingOutput
MaximizeLevenshtein
MaximizeLevenshtein.extra_repr_keys()
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
DifferentialEvolution
DifferentialEvolution.check_transformation_compatibility()
DifferentialEvolution.extra_repr_keys()
DifferentialEvolution.perform_search()
DifferentialEvolution.is_black_box
Full Reference
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()
from abc import ABC, abstractmethod [docs]class TextAttackCommand(ABC): [docs] @staticmethod @abstractmethod def register_subcommand(parser): raise NotImplementedError() [docs] @abstractmethod def run(self): raise NotImplementedError()