Merge pull request #519 from QData/Add-textattack-highlevel-overview-…

…diagram

Add a high level overview diagram to docs

README.md

@@ -77,6 +77,10 @@ The [`examples/`](examples/) folder includes scripts showing common TextAttack u
 The [documentation website](https://textattack.readthedocs.io/en/latest) contains walkthroughs explaining basic usage of TextAttack, including building a custom transformation and a custom constraint..
 
 
+
+<img src="docs/_static/imgs/overview.png" alt="TextAttack Overview" style="display: block; margin: 0 auto;" />
+
+
 ### Running Attacks: `textattack attack --help`
 
 The easiest way to try out an attack is via the command-line interface, `textattack attack`. 

docs/0_get_started/quick_api_tour.rst

@@ -23,11 +23,16 @@ TextAttack requires both the model and the tokenizer to be wrapped by a :class:`
 
 Next, let's build the attack that we want to use. TextAttack provides prebuilt attacks in the form of :class:`~transformers.attack_recipes.AttackRecipe`. For this example, we will use :ref:TextFooler attack 
 
-Let us also load the IMDB dataset using 🤗 Datasets library. TextAttack also requires that the dataset
 
 .. code-block::
 
-    >>> import datasets
-    >>> dataset = datasets.load_dataset("imdb", split="test")
+    >>> dataset = textattack.datasets.HuggingFaceDataset("imdb", split="test")
+    >>> attack = textattack.attack_recipes.TextFoolerJin2019.build(model_wrapper)
+    >>> # Attack 20 samples with CSV logging and checkpoint saved every 5 interval
+    >>> # Attack 20 samples with CSV logging and checkpoint saved every 5 interval
+    >>> attack_args = textattack.AttackArgs(num_examples=20, log_to_csv="log.csv", checkpoint_interval=5, checkpoint_dir="checkpoints", disable_stdout=True)
+    >>> attacker = textattack.Attacker(attack, dataset, attack_args)
+    >>> attacker.attack_dataset()
 
 
+.. image:: ../_static/imgs/overview.png