Merge pull request #592 from QData/doc-fix

change the default installation documentation to textattack[tensorflow]
QData · Dec 3, 2021 · 7a80944 · 7a80944
2 parents 5f825f6 + 4c9d873
commit 7a80944
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/0_get_started/installation.md b/docs/0_get_started/installation.md
@@ -10,7 +10,7 @@ There are two ways to install TextAttack. If you want to simply use as it is, in
 ## Install with pip
 Simply run
 
-    pip install textattack 
+    pip install textattack[tensorflow]
 
 ## Install from Source
 To install TextAttack from source, first clone the repo by running

diff --git a/textattack/attack_recipes/bert_attack_li_2020.py b/textattack/attack_recipes/bert_attack_li_2020.py
@@ -4,6 +4,11 @@
 
 (BERT-Attack: Adversarial Attack Against BERT Using BERT)
 
+.. warning::
+    This attack is super slow
+    (see https://github.com/QData/TextAttack/issues/586) 
+    Consider using smaller values for "max_candidates".
+
 """
 from textattack import Attack
 from textattack.constraints.overlap import MaxWordsPerturbed