diff --git a/docs/api/transformations.rst b/docs/api/transformations.rst index 508e46a6..ab6761bd 100644 --- a/docs/api/transformations.rst +++ b/docs/api/transformations.rst @@ -11,13 +11,3 @@ Composite Transformation .. autoclass:: textattack.transformations.CompositeTransformation :members: - - -.. toctree:: - :maxdepth: 6 - - textattack.transformations.sentence_transformations - textattack.transformations.word_insertions - textattack.transformations.word_merges - textattack.transformations.word_swaps - diff --git a/textattack/attack_args.py b/textattack/attack_args.py index 21b144c5..1ce0a006 100644 --- a/textattack/attack_args.py +++ b/textattack/attack_args.py @@ -154,9 +154,10 @@ class AttackArgs: The number of successful adversarial examples we want. This is different from :obj:`num_examples` as :obj:`num_examples` only cares about attacking `N` samples while :obj:`num_successful_examples` aims to keep attacking until we have `N` successful cases. + .. note:: If set, this argument overrides `num_examples` argument. - num_examples_offset (:obj: `int`, `optional`, defaults to :obj:`0`): + num_examples_offset (:obj:`int`, `optional`, defaults to :obj:`0`): The offset index to start at in the dataset. attack_n (:obj:`bool`, `optional`, defaults to :obj:`False`): Whether to run attack until total of `N` examples have been attacked (and not skipped). @@ -167,6 +168,7 @@ class AttackArgs: query_budget (:obj:`int`, `optional`, defaults to :obj:`None`): The maximum number of model queries allowed per example attacked. If not set, we use the query budget set in the :class:`~textattack.goal_functions.GoalFunction` object (which by default is :obj:`float("inf")`). + .. note:: Setting this overwrites the query budget set in :class:`~textattack.goal_functions.GoalFunction` object. checkpoint_interval (:obj:`int`, `optional`, defaults to :obj:`None`): diff --git a/textattack/constraints/grammaticality/language_models/learning_to_write/learning_to_write.py b/textattack/constraints/grammaticality/language_models/learning_to_write/learning_to_write.py index 9fb9f9bb..ca40693d 100644 --- a/textattack/constraints/grammaticality/language_models/learning_to_write/learning_to_write.py +++ b/textattack/constraints/grammaticality/language_models/learning_to_write/learning_to_write.py @@ -24,7 +24,7 @@ class LearningToWriteLanguageModel(LanguageModelConstraint): https://github.com/windweller/l2w - Reused by Jia et al., 2019, as a substitution for the Google + Reused by Jia et al., 2019, as a substitution for the Google 1-billion words language model (in a revised version the attack of Alzantot et al., 2018). diff --git a/textattack/goal_function_results/custom/__init__.py b/textattack/goal_function_results/custom/__init__.py index ac46cd78..147ebcf8 100644 --- a/textattack/goal_function_results/custom/__init__.py +++ b/textattack/goal_function_results/custom/__init__.py @@ -1,6 +1,6 @@ """ Custom Goal Function Result package: -============================= +==================================== Custom goal function results diff --git a/textattack/goal_function_results/custom/named_entity_recognition_goal_function_result.py b/textattack/goal_function_results/custom/named_entity_recognition_goal_function_result.py index fdb4ac12..182797d4 100644 --- a/textattack/goal_function_results/custom/named_entity_recognition_goal_function_result.py +++ b/textattack/goal_function_results/custom/named_entity_recognition_goal_function_result.py @@ -1,9 +1,9 @@ """ -NamedEntityRecognitionoalFunctionResult Class -==================================== +NamedEntityRecognitionGoalFunctionResult Class +=============================================== -logit sum goal function Result +named entity recognition goal function Result """ diff --git a/textattack/goal_function_results/custom/targeted_bonus_goal_function_result.py b/textattack/goal_function_results/custom/targeted_bonus_goal_function_result.py index 08aa4822..1a82734c 100644 --- a/textattack/goal_function_results/custom/targeted_bonus_goal_function_result.py +++ b/textattack/goal_function_results/custom/targeted_bonus_goal_function_result.py @@ -1,7 +1,7 @@ """ TargetedBonusGoalFunctionResult Class -==================================== +===================================== targeted bonus goal function Result diff --git a/textattack/goal_function_results/custom/targeted_strict_goal_function_result.py b/textattack/goal_function_results/custom/targeted_strict_goal_function_result.py index 6c1b6f78..885b67e5 100644 --- a/textattack/goal_function_results/custom/targeted_strict_goal_function_result.py +++ b/textattack/goal_function_results/custom/targeted_strict_goal_function_result.py @@ -1,7 +1,7 @@ """ TargetedStrictGoalFunctionResult Class -==================================== +====================================== targeted strict goal function Result diff --git a/textattack/loggers/json_summary_logger.py b/textattack/loggers/json_summary_logger.py index b1ac508d..9b6b0648 100644 --- a/textattack/loggers/json_summary_logger.py +++ b/textattack/loggers/json_summary_logger.py @@ -1,6 +1,6 @@ """ Attack Summary Results Logs to Json -======================== +=================================== """ import json diff --git a/textattack/transformations/sentence_transformations/back_transcription.py b/textattack/transformations/sentence_transformations/back_transcription.py index c902b6d5..a7eba18c 100644 --- a/textattack/transformations/sentence_transformations/back_transcription.py +++ b/textattack/transformations/sentence_transformations/back_transcription.py @@ -34,7 +34,7 @@ class BackTranscription(SentenceTransformation): >>> augmenter.augment(s) - You can find more about the back transcription method in the following paper: + You can find more about the back transcription method in the following paper:: @inproceedings{kubis-etal-2023-back, title = "Back Transcription as a Method for Evaluating Robustness of Natural Language Understanding Models to Speech Recognition Errors",