Merge pull request #474 from QData/doc-cmd

add two recipes_cmd.md files

docs/0_get_started/command_line_usage.md

@@ -9,6 +9,13 @@ just about anything TextAttack offers in a single bash command.
 > can access all the same functionality by prepending `python -m` to the command
 > (`python -m textattack ...`).
 
+
+> The [`examples/`](https://github.com/QData/TextAttack/tree/master/examples) folder includes scripts showing common TextAttack usage for training models, running attacks, and augmenting a CSV file. 
+
+
+> 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..
+
+
 To see all available commands, type `textattack --help`. This page explains
 some of the most important functionalities of textattack: NLP data augmentation,
 adversarial attacks, and training and evaluating models.

docs/3recipes/attack_recipes_cmd.md

@@ -16,7 +16,10 @@ or a specific command using, for example,
 textattack attack --help
 ```
 
-The [`examples/`](examples/) folder includes scripts showing common TextAttack usage for training models, running attacks, and augmenting a CSV file. 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..
+The [`examples/`](https://github.com/QData/TextAttack/tree/master/examples) folder includes scripts showing common TextAttack usage for training models, running attacks, and augmenting a CSV file. 
+
+
+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..
 
 ## Running Attacks: `textattack attack --help`
 

docs/3recipes/augmenter_recipes_cmd.md

@@ -2,6 +2,11 @@
 
 Transformations and constraints can be used for simple NLP data augmentations. 
 
+The [`examples/`](https://github.com/QData/TextAttack/tree/master/examples) folder includes scripts showing common TextAttack usage for training models, running attacks, and augmenting a CSV file. 
+
+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..
+
+
 ## Augmenting Text: `textattack augment`
 
 Many of the components of TextAttack are useful for data augmentation. The `textattack.Augmenter` class
@@ -15,14 +20,15 @@ for data augmentation:
 - `textattack.CLAREAugmenter` augments text by replacing, inserting, and merging with a pre-trained masked language model.
 
 ### Augmentation Command-Line Interface
-The easiest way to use our data augmentation tools is with `textattack augment <args>`. `textattack augment`
-takes an input CSV file and text column to augment, along with the number of words to change per augmentation
-and the number of augmentations per input example. It outputs a CSV in the same format with all the augmentation
-examples corresponding to the proper columns.
+The easiest way to use our data augmentation tools is with `textattack augment <args>`. 
 
-For example, given the following as `examples.csv`:
+`textattack augment`
+takes an input CSV file, the "text" column to augment, along with the number of words to change per augmentation
+and the number of augmentations per input example. It outputs a CSV in the same format with all the augmented examples in the proper columns.
 
-```csv
+> For instance, when given the following as `examples.csv`:
+
+```
 "text",label
 "the rock is destined to be the 21st century's new conan and that he's going to make a splash even greater than arnold schwarzenegger , jean- claud van damme or steven segal.", 1
 "the gorgeously elaborate continuation of 'the lord of the rings' trilogy is so huge that a column of words cannot adequately describe co-writer/director peter jackson's expanded vision of j . r . r . tolkien's middle-earth .", 1
@@ -39,7 +45,7 @@ output CSV. (All of this will be saved to `augment.csv` by default.)
 
 
 After augmentation, here are the contents of `augment.csv`:
-```csv
+```
 text,label
 "the rock is destined to be the 21st century's newest conan and that he's gonna to make a splashing even stronger than arnold schwarzenegger , jean- claud van damme or steven segal.",1
 "the rock is destined to be the 21tk century's novel conan and that he's going to make a splat even greater than arnold schwarzenegger , jean- claud van damme or stevens segal.",1