adding the missed docstrings for api-rework-modules

docs/conf.py

@@ -21,7 +21,7 @@ copyright = "2020, UVA QData Lab"
 author = "UVA QData Lab"
 
 # The full version, including alpha/beta/rc tags
-release = "0.3.2"
+release = "0.3.3"
 
 # Set master doc to `index.rst`.
 master_doc = "index"

docs/requirements.txt

@@ -28,5 +28,4 @@ tensorflow-text==2.4.2
 tensorflow-hub==0.12.0
 textattack==0.3.2
 transformers==4.9.1
-virtualenv==20.0.18
 pillow>=8.2.0

textattack/attack.py

@@ -1,3 +1,8 @@
+"""
+Attack Class 
+============
+"""
+
 from collections import OrderedDict
 from typing import List, Union
 

textattack/attack_args.py

@@ -1,3 +1,8 @@
+"""
+AttackArgs Class 
+================
+"""
+
 from dataclasses import dataclass, field
 import json
 import os

textattack/attacker.py

@@ -1,3 +1,8 @@
+"""
+Attacker Class 
+==============
+"""
+
 import collections
 import logging
 import multiprocessing as mp

textattack/augment_args.py

@@ -1,3 +1,9 @@
+"""
+AugmenterArgs Class 
+===================
+"""
+
+
 from dataclasses import dataclass
 
 AUGMENTATION_RECIPE_NAMES = {

textattack/dataset_args.py

@@ -1,3 +1,8 @@
+"""
+DatasetArgs Class 
+=================
+"""
+
 from dataclasses import dataclass
 
 import textattack

textattack/model_args.py

@@ -1,3 +1,9 @@
+"""
+ModelArgs Class 
+===============
+"""
+
+
 from dataclasses import dataclass
 import json
 import os

textattack/trainer.py

@@ -1,3 +1,8 @@
+"""
+Trainer Class 
+=============
+"""
+
 import collections
 import json
 import logging

textattack/training_args.py

@@ -1,3 +1,8 @@
+"""
+TrainingArgs Class 
+==================
+"""
+
 from dataclasses import dataclass, field
 import datetime
 import os