Merge pull request #563 from QData/Add-Docstrings-to-Back-Translation

Add API docstrings for back translation

setup.py

@@ -26,11 +26,11 @@
 ]
 
 extras["tensorflow"] = [
-    "tensorflow>=2",
+    "tensorflow==2.5.0",
     "tensorflow_hub",
     "tensorflow_text>=2",
     "tensorboardX",
-    "tensorflow-estimator==2.6.0",
+    "tensorflow-estimator==2.5.0",
 ]
 
 extras["optional"] = [

tests/test_augment_api.py

@@ -91,3 +91,14 @@ def test_deletion_augmenter():
     augmented_text_list = augmenter.augment(s)
     augmented_s = "United States"
     assert augmented_s in augmented_text_list
+
+
+def test_back_translation():
+    from textattack.augmentation import Augmenter
+    from textattack.transformations.sentence_transformations import BackTranslation
+
+    augmenter = Augmenter(transformation=BackTranslation())
+    s = "What on earth are you doing?"
+    augmented_text_list = augmenter.augment(s)
+    augmented_s = "What the hell are you doing?"
+    assert augmented_s in augmented_text_list

textattack/transformations/sentence_transformations/back_translation.py

@@ -20,6 +20,19 @@ class BackTranslation(SentenceTransformation):
     src_model: translation model from huggingface that translates from source language to target language
     target_model: translation model from huggingface that translates from target language to source language
     chained_back_translation: run back translation in a chain for more perturbation (for example, en-es-en-fr-en)
+
+    Example::
+
+        >>> from textattack.transformations.sentence_transformations import BackTranslation
+        >>> from textattack.constraints.pre_transformation import RepeatModification, StopwordModification
+        >>> from textattack.augmentation import Augmenter
+
+        >>> transformation = BackTranslation
+        >>> constraints = [RepeatModification(), StopwordModification()]
+        >>> augmenter = Augmenter(transformation = transformation, constraints = constraints)
+        >>> s = 'What on earth are you doing here.'
+
+        >>> augmenter.augment(s)
     """
 
     def __init__(