Merge pull request #569 from QData/fix-apidoc

fix read-the-doc installation issue / clean up and add new docstrings for recently added classes/packages
QData · Nov 9, 2021 · 49c94fb · 49c94fb
2 parents 57c2084 + cbd5e71
commit 49c94fb
Show file tree

Hide file tree

Showing 118 changed files with 347 additions and 63 deletions.
diff --git a/docs/apidoc/textattack.attack_recipes.rst b/docs/apidoc/textattack.attack_recipes.rst
@@ -8,6 +8,13 @@ textattack.attack\_recipes package
 
 
 
+
+.. automodule:: textattack.attack_recipes.a2t_yoo_2021
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 .. automodule:: textattack.attack_recipes.attack_recipe
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.attack_results.rst b/docs/apidoc/textattack.attack_results.rst
@@ -8,6 +8,7 @@ textattack.attack\_results package
 
 
 
+
 .. automodule:: textattack.attack_results.attack_result
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.augmentation.rst b/docs/apidoc/textattack.augmentation.rst
@@ -8,6 +8,7 @@ textattack.augmentation package
 
 
 
+
 .. automodule:: textattack.augmentation.augmenter
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.commands.rst b/docs/apidoc/textattack.commands.rst
@@ -8,6 +8,7 @@ textattack.commands package
 
 
 
+
 .. automodule:: textattack.commands.attack_command
    :members:
    :undoc-members:

diff --git a/...textattack.constraints.grammaticality.language_models.google_language_model.rst b/...textattack.constraints.grammaticality.language_models.google_language_model.rst
@@ -8,6 +8,7 @@ textattack.constraints.grammaticality.language\_models.google\_language\_model p
 
 
 
+
 .. automodule:: textattack.constraints.grammaticality.language_models.google_language_model.alzantot_goog_lm
    :members:
    :undoc-members:

diff --git a/...doc/textattack.constraints.grammaticality.language_models.learning_to_write.rst b/...doc/textattack.constraints.grammaticality.language_models.learning_to_write.rst
@@ -8,6 +8,7 @@ textattack.constraints.grammaticality.language\_models.learning\_to\_write packa
 
 
 
+
 .. automodule:: textattack.constraints.grammaticality.language_models.learning_to_write.adaptive_softmax
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.grammaticality.language_models.rst b/docs/apidoc/textattack.constraints.grammaticality.language_models.rst
@@ -16,6 +16,7 @@ textattack.constraints.grammaticality.language\_models package
 
 
 
+
 .. automodule:: textattack.constraints.grammaticality.language_models.gpt2
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.grammaticality.rst b/docs/apidoc/textattack.constraints.grammaticality.rst
@@ -15,6 +15,7 @@ textattack.constraints.grammaticality package
 
 
 
+
 .. automodule:: textattack.constraints.grammaticality.cola
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.overlap.rst b/docs/apidoc/textattack.constraints.overlap.rst
@@ -8,6 +8,7 @@ textattack.constraints.overlap package
 
 
 
+
 .. automodule:: textattack.constraints.overlap.bleu_score
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.pre_transformation.rst b/docs/apidoc/textattack.constraints.pre_transformation.rst
@@ -8,6 +8,7 @@ textattack.constraints.pre\_transformation package
 
 
 
+
 .. automodule:: textattack.constraints.pre_transformation.input_column_modification
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.rst b/docs/apidoc/textattack.constraints.rst
@@ -18,6 +18,7 @@ textattack.constraints package
 
 
 
+
 .. automodule:: textattack.constraints.constraint
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.semantics.rst b/docs/apidoc/textattack.constraints.semantics.rst
@@ -15,6 +15,7 @@ textattack.constraints.semantics package
 
 
 
+
 .. automodule:: textattack.constraints.semantics.bert_score
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.semantics.sentence_encoders.bert.rst b/docs/apidoc/textattack.constraints.semantics.sentence_encoders.bert.rst
@@ -8,6 +8,7 @@ textattack.constraints.semantics.sentence\_encoders.bert package
 
 
 
+
 .. automodule:: textattack.constraints.semantics.sentence_encoders.bert.bert
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.semantics.sentence_encoders.infer_sent.rst b/docs/apidoc/textattack.constraints.semantics.sentence_encoders.infer_sent.rst
@@ -8,6 +8,7 @@ textattack.constraints.semantics.sentence\_encoders.infer\_sent package
 
 
 
+
 .. automodule:: textattack.constraints.semantics.sentence_encoders.infer_sent.infer_sent
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.constraints.semantics.sentence_encoders.rst b/docs/apidoc/textattack.constraints.semantics.sentence_encoders.rst
@@ -17,6 +17,7 @@ textattack.constraints.semantics.sentence\_encoders package
 
 
 
+
 .. automodule:: textattack.constraints.semantics.sentence_encoders.sentence_encoder
    :members:
    :undoc-members:

diff --git a/...xtattack.constraints.semantics.sentence_encoders.universal_sentence_encoder.rst b/...xtattack.constraints.semantics.sentence_encoders.universal_sentence_encoder.rst
@@ -8,6 +8,7 @@ textattack.constraints.semantics.sentence\_encoders.universal\_sentence\_encoder
 
 
 
+
 .. automodule:: textattack.constraints.semantics.sentence_encoders.universal_sentence_encoder.multilingual_universal_sentence_encoder
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.datasets.helpers.rst b/docs/apidoc/textattack.datasets.helpers.rst
@@ -8,6 +8,7 @@ textattack.datasets.helpers package
 
 
 
+
 .. automodule:: textattack.datasets.helpers.ted_multi
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.datasets.rst b/docs/apidoc/textattack.datasets.rst
@@ -15,6 +15,7 @@ textattack.datasets package
 
 
 
+
 .. automodule:: textattack.datasets.dataset
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.goal_function_results.rst b/docs/apidoc/textattack.goal_function_results.rst
@@ -8,6 +8,7 @@ textattack.goal\_function\_results package
 
 
 
+
 .. automodule:: textattack.goal_function_results.classification_goal_function_result
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.goal_functions.classification.rst b/docs/apidoc/textattack.goal_functions.classification.rst
@@ -8,6 +8,7 @@ textattack.goal\_functions.classification package
 
 
 
+
 .. automodule:: textattack.goal_functions.classification.classification_goal_function
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.goal_functions.rst b/docs/apidoc/textattack.goal_functions.rst
@@ -16,6 +16,7 @@ textattack.goal\_functions package
 
 
 
+
 .. automodule:: textattack.goal_functions.goal_function
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.goal_functions.text.rst b/docs/apidoc/textattack.goal_functions.text.rst
@@ -8,6 +8,7 @@ textattack.goal\_functions.text package
 
 
 
+
 .. automodule:: textattack.goal_functions.text.minimize_bleu
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.loggers.rst b/docs/apidoc/textattack.loggers.rst
@@ -8,6 +8,7 @@ textattack.loggers package
 
 
 
+
 .. automodule:: textattack.loggers.attack_log_manager
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.metrics.attack_metrics.rst b/docs/apidoc/textattack.metrics.attack_metrics.rst
@@ -8,6 +8,7 @@ textattack.metrics.attack\_metrics package
 
 
 
+
 .. automodule:: textattack.metrics.attack_metrics.attack_queries
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.metrics.quality_metrics.rst b/docs/apidoc/textattack.metrics.quality_metrics.rst
@@ -8,6 +8,7 @@ textattack.metrics.quality\_metrics package
 
 
 
+
 .. automodule:: textattack.metrics.quality_metrics.perplexity
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.metrics.rst b/docs/apidoc/textattack.metrics.rst
@@ -16,6 +16,7 @@ textattack.metrics package
 
 
 
+
 .. automodule:: textattack.metrics.metric
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.models.helpers.rst b/docs/apidoc/textattack.models.helpers.rst
@@ -8,6 +8,7 @@ textattack.models.helpers package
 
 
 
+
 .. automodule:: textattack.models.helpers.glove_embedding_layer
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.models.tokenizers.rst b/docs/apidoc/textattack.models.tokenizers.rst
@@ -8,6 +8,7 @@ textattack.models.tokenizers package
 
 
 
+
 .. automodule:: textattack.models.tokenizers.glove_tokenizer
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.models.wrappers.rst b/docs/apidoc/textattack.models.wrappers.rst
@@ -8,6 +8,7 @@ textattack.models.wrappers package
 
 
 
+
 .. automodule:: textattack.models.wrappers.huggingface_model_wrapper
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.rst b/docs/apidoc/textattack.rst
@@ -7,6 +7,7 @@ textattack package
    :show-inheritance:
 
 
+
 .. toctree::
    :maxdepth: 6
 
@@ -27,6 +28,7 @@ textattack package
 
 
 
+
 .. automodule:: textattack.attack
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.search_methods.rst b/docs/apidoc/textattack.search_methods.rst
@@ -8,6 +8,7 @@ textattack.search\_methods package
 
 
 
+
 .. automodule:: textattack.search_methods.alzantot_genetic_algorithm
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.shared.rst b/docs/apidoc/textattack.shared.rst
@@ -15,6 +15,7 @@ textattack.shared package
 
 
 
+
 .. automodule:: textattack.shared.attacked_text
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.shared.utils.rst b/docs/apidoc/textattack.shared.utils.rst
@@ -8,6 +8,7 @@ textattack.shared.utils package
 
 
 
+
 .. automodule:: textattack.shared.utils.importing
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.transformations.rst b/docs/apidoc/textattack.transformations.rst
@@ -11,12 +11,14 @@ textattack.transformations package
 .. toctree::
    :maxdepth: 6
 
+   textattack.transformations.sentence_transformations
    textattack.transformations.word_insertions
    textattack.transformations.word_merges
    textattack.transformations.word_swaps
 
 
 
+
 .. automodule:: textattack.transformations.composite_transformation
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.transformations.sentence_transformations.rst b/docs/apidoc/textattack.transformations.sentence_transformations.rst
@@ -0,0 +1,21 @@
+textattack.transformations.sentence\_transformations package
+============================================================
+
+.. automodule:: textattack.transformations.sentence_transformations
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+
+
+.. automodule:: textattack.transformations.sentence_transformations.back_translation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: textattack.transformations.sentence_transformations.sentence_transformation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidoc/textattack.transformations.word_insertions.rst b/docs/apidoc/textattack.transformations.word_insertions.rst
@@ -8,6 +8,7 @@ textattack.transformations.word\_insertions package
 
 
 
+
 .. automodule:: textattack.transformations.word_insertions.word_insertion
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.transformations.word_merges.rst b/docs/apidoc/textattack.transformations.word_merges.rst
@@ -8,6 +8,7 @@ textattack.transformations.word\_merges package
 
 
 
+
 .. automodule:: textattack.transformations.word_merges.word_merge
    :members:
    :undoc-members:

diff --git a/docs/apidoc/textattack.transformations.word_swaps.rst b/docs/apidoc/textattack.transformations.word_swaps.rst
@@ -8,6 +8,7 @@ textattack.transformations.word\_swaps package
 
 
 
+
 .. automodule:: textattack.transformations.word_swaps.word_swap
    :members:
    :undoc-members:

diff --git a/textattack/attack_recipes/__init__.py b/textattack/attack_recipes/__init__.py
@@ -1,7 +1,7 @@
 """.. _attack_recipes:
 
-Attack Recipes:
-======================
+Attack Recipes Package:
+========================
 
 We provide a number of pre-built attack recipes, which correspond to attacks from the literature. To run an attack recipe from the command line, run::
 

diff --git a/textattack/attack_recipes/a2t_yoo_2021.py b/textattack/attack_recipes/a2t_yoo_2021.py
@@ -1,3 +1,9 @@
+"""
+A2T (A2T: Attack for Adversarial Training Recipe)
+==================================================
+
+"""
+
 from textattack import Attack
 from textattack.constraints.grammaticality import PartOfSpeech
 from textattack.constraints.pre_transformation import (

diff --git a/textattack/attack_recipes/clare_li_2020.py b/textattack/attack_recipes/clare_li_2020.py
@@ -1,3 +1,11 @@
+"""
+CLARE Recipe
+=============
+
+(Contextualized Perturbation for Textual Adversarial Attack)
+
+"""
+
 import transformers
 
 from textattack import Attack

diff --git a/textattack/attack_results/__init__.py b/textattack/attack_results/__init__.py
@@ -1,3 +1,10 @@
+"""
+
+TextAttack attack_results Package
+==================================
+
+"""
+
 from .attack_result import AttackResult
 from .maximized_attack_result import MaximizedAttackResult
 from .failed_attack_result import FailedAttackResult

diff --git a/textattack/attack_results/attack_result.py b/textattack/attack_results/attack_result.py
@@ -1,3 +1,9 @@
+"""
+AttackResult Class
+======================
+
+"""
+
 from abc import ABC
 
 from textattack.goal_function_results import GoalFunctionResult
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ textattack.attack\_results package




		.. automodule:: textattack.attack_results.attack_result
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ textattack.augmentation package




		.. automodule:: textattack.augmentation.augmenter
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ textattack.commands package




		.. automodule:: textattack.commands.attack_command
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ textattack.constraints.grammaticality.language\_models.google\_language\_model p




		.. automodule:: textattack.constraints.grammaticality.language_models.google_language_model.alzantot_goog_lm
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,6 +16,7 @@ textattack.constraints.grammaticality.language\_models package




		.. automodule:: textattack.constraints.grammaticality.language_models.gpt2
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,6 +15,7 @@ textattack.constraints.grammaticality package




		.. automodule:: textattack.constraints.grammaticality.cola
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ textattack.constraints.overlap package




		.. automodule:: textattack.constraints.overlap.bleu_score
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,6 +8,7 @@ textattack.constraints.pre\_transformation package




		.. automodule:: textattack.constraints.pre_transformation.input_column_modification
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,6 +18,7 @@ textattack.constraints package




		.. automodule:: textattack.constraints.constraint
		:members:
		:undoc-members:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,6 +15,7 @@ textattack.constraints.semantics package




		.. automodule:: textattack.constraints.semantics.bert_score
		:members:
		:undoc-members:
Expand Down