Merge pull request #757 from QData/doc-update

update docs with missing api

docs/api/transformations.rst

@@ -11,3 +11,13 @@ Composite Transformation
 .. autoclass:: textattack.transformations.CompositeTransformation
     :members:
 
+
+
+.. toctree::
+   :maxdepth: 6
+
+   textattack.transformations.sentence_transformations
+   textattack.transformations.word_insertions
+   textattack.transformations.word_merges
+   textattack.transformations.word_swaps
+

docs/index.rst

@@ -69,7 +69,7 @@ TextAttack Documentation
 
 
 .. toctree::
-   :maxdepth: 6
+   :maxdepth: 7
    :glob:
    :caption: Full Reference
 

textattack/attack_recipes/chinese_recipe.py

@@ -1,3 +1,11 @@
+"""
+Attack Chinese Recipe
+=====================
+
+(Contextualized Perturbation for Chinese NLP Adversarial Attack)
+
+"""
+
 import string
 
 from textattack import Attack

textattack/attack_recipes/french_recipe.py

@@ -1,3 +1,11 @@
+"""
+Attack French Recipe
+====================
+
+(Contextualized Perturbation for French NLP Adversarial Attack)
+
+"""
+
 from textattack import Attack
 from textattack.constraints.pre_transformation import (
     RepeatModification,

textattack/attack_recipes/spanish_recipe.py

@@ -1,3 +1,11 @@
+"""
+Attack Spanish Recipe
+=====================
+
+(Contextualized Perturbation for Spanish NLP Adversarial Attack)
+
+"""
+
 from textattack import Attack
 from textattack.constraints.pre_transformation import (
     RepeatModification,

textattack/constraints/semantics/sentence_encoders/__init__.py

@@ -1,6 +1,6 @@
 """
-Sentence Encoder
----------------------
+Sentence Encoder Constraint
+----------------------------
 """
 
 

textattack/constraints/semantics/sentence_encoders/bert/bert.py

@@ -1,5 +1,5 @@
 """
-BERT for Sentence Similarity
+sBERT for Sentence Similarity
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 """
 

textattack/goal_functions/classification/hardlabel_classification.py

@@ -1,6 +1,6 @@
 """
 Determine if an attack has been successful in Hard Label Classficiation.
-----------------------------------------------------
+------------------------------------------------------------------------
 """
 
 

textattack/goal_functions/classification/input_reduction.py

@@ -1,6 +1,6 @@
 """
 
-Determine if maintaining the same predicted label
+Determine if maintaining the same predicted label (input reduction)
 ---------------------------------------------------------------------
 """
 

textattack/search_methods/population_based_search.py

@@ -1,6 +1,6 @@
 """
-Population based Search
-==========================
+Population based Search  abstract class
+=======================================
 """
 
 from abc import ABC, abstractmethod

textattack/transformations/word_swaps/chn_transformations/chinese_homophone_character_swap.py

@@ -1,3 +1,9 @@
+"""
+Word Swap by chinese homophone
+-------------------------------------
+"""
+
+
 import os
 
 import pandas as pd

textattack/transformations/word_swaps/chn_transformations/chinese_morphonym_character_swap.py

@@ -1,3 +1,8 @@
+"""
+Word Swap by chinese morphonym
+-------------------------------------
+"""
+
 from textattack.shared.data import MORPHONYM_LS
 
 from . import WordSwap

textattack/transformations/word_swaps/chn_transformations/chinese_word_swap_hownet.py

@@ -1,3 +1,8 @@
+"""
+Word Swap by chinese hownet
+-------------------------------------
+"""
+
 import OpenHowNet
 
 from . import WordSwap

textattack/transformations/word_swaps/chn_transformations/chinese_word_swap_masked.py

@@ -1,6 +1,6 @@
 """
-Word Swap by BERT-Masked LM.
--------------------------------
+Word Swap by chinese BERT-Masked LM.
+-------------------------------------
 """
 
 from transformers import pipeline