Fixed issues with Documentation + Added Copy Button for Code Blocks · QData/TextAttack@03ad3c1 · GitHub
Skip to content

Commit 03ad3c1

Browse files
srujanjoshisrujanjoshi
committed
Fixed issues with Documentation + Added Copy Button for Code Blocks
1 parent ae07432 commit 03ad3c1

22 files changed

Lines changed: 71 additions & 38 deletions

File tree

‎docs/0_get_started/basic-Intro.rst‎

Lines changed: 2 additions & 2 deletions

‎docs/0_get_started/quick_api_tour.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Next, let's build the attack that we want to use. TextAttack provides prebuilt a
2929
>>> dataset = textattack.datasets.HuggingFaceDataset("imdb", split="test")
3030
>>> attack = textattack.attack_recipes.TextFoolerJin2019.build(model_wrapper)
3131
>>> # Attack 20 samples with CSV logging and checkpoint saved every 5 interval
32-
>>> # Attack 20 samples with CSV logging and checkpoint saved every 5 interval
3332
>>> attack_args = textattack.AttackArgs(num_examples=20, log_to_csv="log.csv", checkpoint_interval=5, checkpoint_dir="checkpoints", disable_stdout=True)
3433
>>> attacker = textattack.Attacker(attack, dataset, attack_args)
3534
>>> attacker.attack_dataset()

‎docs/3recipes/models.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -447,10 +447,10 @@ roberta-base-RTE | natural language inference
447447
roberta-base-WNLI | natural language inference | sentence pairs | binary | <sub><sup> https://paperswithcode.com/sota/natural-language-inference-on-wnli </sub></sup> | https://huggingface.co/textattack/roberta-base-WNLI </sub></sup>
448448
xlnet-base-cased-RTE | natural language inference | sentence pairs (1 premise and 1 hypothesis) | binary(0=entailed/1=not entailed) | <sub><sup> https://paperswithcode.com/sota/ </sub></sup>natural-language-inference-on-rte | <sub><sup> https://huggingface.co/textattack/xlnet-base-cased-RTE </sub></sup>
449449
xlnet-base-cased-WNLI | natural language inference | sentence pairs | binary | none yet | <sub><sup> https://huggingface.co/textattack/xlnet-base-cased-WNLI </sub></sup>
450-
albert-base-v2-QQP | paraphase similarity | question pairs | binary (1=similar/0=not similar) | <sub><sup> https://paperswithcode.com/sota/question-answering-on-quora-question-pairs </sub></sup> | <sub><sup> https://huggingface.co/textattack/albert-base-v2-QQP</sub></sup>
451-
bert-base-uncased-QQP | paraphase similarity | question pairs | binary (1=similar/0=not similar) | <sub><sup> https://paperswithcode.com/sota/question-answering-on-quora-question-pairs </sub></sup> | <sub><sup> https://huggingface.co/textattack/bert-base-uncased-QQP </sub></sup>
450+
albert-base-v2-QQP | paraphrase similarity | question pairs | binary (1=similar/0=not similar) | <sub><sup> https://paperswithcode.com/sota/question-answering-on-quora-question-pairs </sub></sup> | <sub><sup> https://huggingface.co/textattack/albert-base-v2-QQP</sub></sup>
451+
bert-base-uncased-QQP | paraphrase similarity | question pairs | binary (1=similar/0=not similar) | <sub><sup> https://paperswithcode.com/sota/question-answering-on-quora-question-pairs </sub></sup> | <sub><sup> https://huggingface.co/textattack/bert-base-uncased-QQP </sub></sup>
452452
distilbert-base-uncased-QNLI | question answering/natural language inference | question/answer pairs | binary (1=unanswerable/ 0=answerable) | <sub><sup> https://paperswithcode.com/sota/natural-language-inference-on-qnli </sub></sup> | <sub><sup> https://huggingface.co/textattack/distilbert-base-uncased-QNLI </sub></sup>
453-
distilbert-base-cased-QQP | question answering/paraphase similarity | question pairs | binary (1=similar/ 0=not similar) | <sub><sup> https://paperswithcode.com/sota/question-answering-on-quora-question-pairs </sub></sup> | <sub><sup> https://huggingface.co/textattack/distilbert-base-cased-QQP </sub></sup>
453+
distilbert-base-cased-QQP | question answering/paraphrase similarity | question pairs | binary (1=similar/ 0=not similar) | <sub><sup> https://paperswithcode.com/sota/question-answering-on-quora-question-pairs </sub></sup> | <sub><sup> https://huggingface.co/textattack/distilbert-base-cased-QQP </sub></sup>
454454
albert-base-v2-STS-B | semantic textual similarity | sentence pairs | similarity (0.0 to 5.0) | <sub><sup> https://paperswithcode.com/sota/semantic-textual-similarity-on-sts-benchmark </sub></sup> | <sub><sup> https://huggingface.co/textattack/albert-base-v2-STS-B </sub></sup>
455455
bert-base-uncased-MRPC | semantic textual similarity | sentence pairs | binary (1=similar/0=not similar) | none yet | <sub><sup> https://huggingface.co/textattack/bert-base-uncased-MRPC </sub></sup>
456456
bert-base-uncased-STS-B | semantic textual similarity | sentence pairs | similarity (0.0 to 5.0) | none yet | <sub><sup> https://huggingface.co/textattack/bert-base-uncased-STS-B </sub></sup>

‎docs/api/attack.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Attack
55
------------
66
Attack is composed of four components:
77

8-
- `Goal Functions <../attacks/goal_function.html>`__ stipulate the goal of the attack, like to change the prediction score of a classification model, or to change all of the words in a translation output.
9-
- `Constraints <../attacks/constraint.html>`__ determine if a potential perturbation is valid with respect to the original input.
10-
- `Transformations <../attacks/transformation.html>`__ take a text input and transform it by inserting and deleting characters, words, and/or phrases.
11-
- `Search Methods <../attacks/search_method.html>`__ explore the space of possible **transformations** within the defined **constraints** and attempt to find a successful perturbation which satisfies the **goal function**.
8+
- :ref:`Goal Functions <goal_functions>`: stipulate the goal of the attack, like to change the prediction score of a classification model, or to change all of the words in a translation output.
9+
- :ref:`Constraints <constraint>`: determine if a potential perturbation is valid with respect to the original input.
10+
- :ref:`Transformations <transformations>`: take a text input and transform it by inserting and deleting characters, words, and/or phrases.
11+
- :ref:`Search Methods <search_methods>`: explore the space of possible **transformations** within the defined **constraints** and attempt to find a successful perturbation which satisfies the **goal function**.
1212

1313
The :class:`~textattack.Attack` class represents an adversarial attack composed of a goal function, search method, transformation, and constraints.
1414

‎docs/api/goal_functions.rst‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,36 @@ GoalFunction
1111

1212
ClassificationGoalFunction
1313
--------------------------
14-
.. autoclass:: textattack.goal_functions.ClassificationGoalFunction
14+
.. autoclass:: textattack.goal_functions.classification.ClassificationGoalFunction
1515
:members:
1616

1717
TargetedClassification
1818
----------------------
19-
.. autoclass:: textattack.goal_functions.TargetedClassification
19+
.. autoclass:: textattack.goal_functions.classification.TargetedClassification
2020
:members:
2121

2222
UntargetedClassification
2323
------------------------
24-
.. autoclass:: textattack.goal_functions.UntargetedClassification
24+
.. autoclass:: textattack.goal_functions.classification.UntargetedClassification
2525
:members:
2626

2727
InputReduction
2828
--------------
29-
.. autoclass:: textattack.goal_functions.InputReduction
29+
.. autoclass:: textattack.goal_functions.classification.InputReduction
3030
:members:
3131

3232
TextToTextGoalFunction
3333
-----------------------
34-
.. autoclass:: textattack.goal_functions.TextToTextGoalFunction
34+
.. autoclass:: textattack.goal_functions.text.TextToTextGoalFunction
3535
:members:
3636

3737
MinimizeBleu
3838
-------------
39-
.. autoclass:: textattack.goal_functions.MinimizeBleu
39+
.. autoclass:: textattack.goal_functions.text.MinimizeBleu
4040
:members:
4141

4242
NonOverlappingOutput
4343
----------------------
44-
.. autoclass:: textattack.goal_functions.NonOverlappingOutput
44+
.. autoclass:: textattack.goal_functions.text.NonOverlappingOutput
4545
:members:
4646

‎docs/api/transformations.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Transformations API Reference
2+
============================
3+
4+
Transformation
5+
------------
6+
.. autoclass:: textattack.transformations.Transformation
7+
:members:
8+
9+
Composite Transformation
10+
-----------------------------
11+
.. autoclass:: textattack.transformations.CompositeTransformation
12+
:members:
13+

‎docs/conf.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
# -- Project information -----------------------------------------------------
1919
project = "TextAttack"
20-
copyright = "2020, UVA QData Lab"
20+
copyright = "2021, UVA QData Lab"
2121
author = "UVA QData Lab"
2222

2323
# The full version, including alpha/beta/rc tags
@@ -39,6 +39,7 @@
3939
"sphinx.ext.autosummary",
4040
"sphinx.ext.napoleon",
4141
"sphinx_rtd_theme",
42+
"sphinx_copybutton",
4243
# Enable .ipynb doc files
4344
"nbsphinx",
4445
# Enable .md doc files
@@ -94,3 +95,11 @@
9495

9596
# Sort members by group
9697
autodoc_member_order = "groupwise"
98+
99+
# -- Options for Sphinx Copy Button-------------------------------------------------
100+
101+
# Exclude the prompt symbol ">>>" when copying text
102+
copybutton_prompt_text = ">>> "
103+
104+
# Specify Line Continuation Character so that all the entire Line is copied
105+
copybutton_line_continuation_character = "\\"

‎docs/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ TextAttack Documentation
6363
Datasets <api/datasets.rst>
6464
GoalFunction <api/goal_functions.rst>
6565
Constraints <api/constraints.rst>
66+
Transformations <api/transformations.rst>
6667
SearchMethod <api/search_methods.rst>
6768

6869

‎docs/requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
recommonmark==0.7.1
22
Sphinx==4.1.2
33
sphinx-autobuild==2021.3.14
4+
sphinx-copybutton==0.4.0
45
sphinx-markdown-tables==0.0.15
56
sphinx-rtd-theme==0.5.2
67
sphinxcontrib-applehelp==1.0.2

‎textattack/attack_args.py‎

Lines changed: 12 additions & 5 deletions

0 commit comments

Comments
 (0)