diff --git a/autoaug/autoaugment_learners/AaLearner.py b/autoaug/autoaugment_learners/AaLearner.py
index 94541ffb00c69493cb35a5e853ee33288b120ea8..f14a107ebc5ac73c6c6fe1e9202936c652ab50d8 100644
--- a/autoaug/autoaugment_learners/AaLearner.py
+++ b/autoaug/autoaugment_learners/AaLearner.py
@@ -20,6 +20,24 @@ class AaLearner:
op_tensor_length (int): what is the dimension of the tensor that represents
each 'operation' (which is made up of fun_name, prob,
and mag).
+
+ See Also
+ --------
+
+
+ Notes
+ -----
+
+
+ References
+ ----------
+
+
+ Examples
+ --------
+
+
+
"""
def __init__(self,
# parameters that define the search space
@@ -309,8 +327,7 @@ class AaLearner:
Example code:
.. code-block::
- :caption: This is an example dummy code which tests out 15
- different policies
+ :caption: This is how a child class might implement this method:
for _ in range(15):
policy = self._generate_new_policy()
diff --git a/autoaug/autoaugment_learners/EvoLearner.py b/autoaug/autoaugment_learners/EvoLearner.py
index 91871cb2f920ee32cdeeb1879a3b80a2ac9e92d8..c78d0bb87e8951c52afba14855e5e1d7d6018b4a 100644
--- a/autoaug/autoaugment_learners/EvoLearner.py
+++ b/autoaug/autoaugment_learners/EvoLearner.py
@@ -10,7 +10,31 @@ import autoaug.controller_networks as cont_n
class EvoLearner(AaLearner):
+ """evo algorithm
+
+ long explanatino here
+
+ Args:
+ AaLearner (_type_): _description_
+
+
+ See Also
+ --------
+
+
+ Notes
+ -----
+
+
+ References
+ ----------
+
+
+ Examples
+ --------
+
+ """
def __init__(self,
# search space settings
sp_num=5,
diff --git a/autoaug/autoaugment_learners/GruLearner.py b/autoaug/autoaugment_learners/GruLearner.py
index 28799b650731ba58858ff542cd9de796ba82fa41..6db3ba5cc5f75b81947ebe52b9df32bcd67194c2 100644
--- a/autoaug/autoaugment_learners/GruLearner.py
+++ b/autoaug/autoaugment_learners/GruLearner.py
@@ -23,6 +23,25 @@ class GruLearner(AaLearner):
network as the LSTM whilst training and testing much faster
(https://arxiv.org/abs/1412.3555), which is why we substituted
the LSTM for the GRU.
+
+
+ See Also
+ --------
+
+
+ Notes
+ -----
+
+
+ References
+ ----------
+
+
+ Examples
+ --------
+
+
+
"""
def __init__(self,
diff --git a/autoaug/autoaugment_learners/RsLearner.py b/autoaug/autoaugment_learners/RsLearner.py
index eee8eab04d3fef4fe4e11538141d88376005591d..da0f7695ec94f7387c4d2dcdb42b7c5b0951b957 100644
--- a/autoaug/autoaugment_learners/RsLearner.py
+++ b/autoaug/autoaugment_learners/RsLearner.py
@@ -16,6 +16,24 @@ class RsLearner(AaLearner):
"""
Tests randomly sampled policies from the search space specified by the AutoAugment
paper. Acts as a baseline for other AaLearner's.
+
+
+ See Also
+ --------
+
+
+ Notes
+ -----
+
+
+ References
+ ----------
+
+
+ Examples
+ --------
+
+
"""
def __init__(self,
# parameters that define the search space
diff --git a/autoaug/autoaugment_learners/UcbLearner.py b/autoaug/autoaugment_learners/UcbLearner.py
index 0c84e6648f60f7c4209f586a2ed30e4a19155bd7..ded7d67a87dbb9582e3753a520b9d15d6de39ff1 100644
--- a/autoaug/autoaugment_learners/UcbLearner.py
+++ b/autoaug/autoaugment_learners/UcbLearner.py
@@ -8,8 +8,32 @@ from .RsLearner import RsLearner
class UcbLearner(RsLearner):
"""
- Tests randomly sampled policies from the search space specified by the AutoAugment
- paper. Acts as a baseline for other AaLearner's.
+ Uses the UCB1 algorithm originally developed for multi-armed bandit problems.
+ Recommended when
+
+ - Optimal hyperparameters for training the CNN (such as batch size and learning rate) has not been found yet.
+
+ - Using a toy dataset or a toy CNN
+
+
+
+ See Also
+ --------
+
+
+ Notes
+ -----
+
+
+ References
+ ----------
+
+
+ Examples
+ --------
+
+
+
"""
def __init__(self,
# parameters that define the search space
@@ -84,7 +108,7 @@ class UcbLearner(RsLearner):
child_network_architecture,
iterations=15,
print_every_epoch=False):
- """continue the UCB algorithm for `iterations` number of turns
+ """continue the UCB algorithm for ``iterations`` number of turns
"""
diff --git a/docs/source/_static/logohd.png b/docs/source/_static/logohd.png
index f3011280f514e3ca5cd3b5bb258d13fd9c083748..0775636e05afbf7f1f8ffca9b2d33d2088bfd3a5 100644
Binary files a/docs/source/_static/logohd.png and b/docs/source/_static/logohd.png differ
diff --git a/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.AaLearner.rst b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.AaLearner.rst
new file mode 100644
index 0000000000000000000000000000000000000000..ac34fb251c8002231f2ed806d5df876e97df8472
--- /dev/null
+++ b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.AaLearner.rst
@@ -0,0 +1,7 @@
+:mod:`autoaug.autoaugment_learners`.AaLearner
+==============================================
+
+.. currentmodule:: autoaug.autoaugment_learners
+
+.. autoclass:: AaLearner
+ :members:
\ No newline at end of file
diff --git a/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.EvoLearner.rst b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.EvoLearner.rst
new file mode 100644
index 0000000000000000000000000000000000000000..2d1a8e0c966478a793831e74b8c4919fe67a2d1a
--- /dev/null
+++ b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.EvoLearner.rst
@@ -0,0 +1,7 @@
+:mod:`autoaug.autoaugment_learners`.EvoLearner
+==============================================
+
+.. currentmodule:: autoaug.autoaugment_learners
+
+.. autoclass:: EvoLearner
+ :members:
\ No newline at end of file
diff --git a/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.GruLearner.rst b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.GruLearner.rst
new file mode 100644
index 0000000000000000000000000000000000000000..842afcc47ea001c3c9abb278551a8af57a7c52fa
--- /dev/null
+++ b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.GruLearner.rst
@@ -0,0 +1,7 @@
+:mod:`autoaug.autoaugment_learners`.GruLearner
+==============================================
+
+.. currentmodule:: autoaug.autoaugment_learners
+
+.. autoclass:: GruLearner
+ :members:
\ No newline at end of file
diff --git a/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.RsLearner.rst b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.RsLearner.rst
new file mode 100644
index 0000000000000000000000000000000000000000..2693d7fdbc0c92ae357481da66aee894d459c7a5
--- /dev/null
+++ b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.RsLearner.rst
@@ -0,0 +1,7 @@
+:mod:`autoaug.autoaugment_learners`.RsLearner
+==============================================
+
+.. currentmodule:: autoaug.autoaugment_learners
+
+.. autoclass:: RsLearner
+ :members:
\ No newline at end of file
diff --git a/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.UcbLearner.rst b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.UcbLearner.rst
new file mode 100644
index 0000000000000000000000000000000000000000..6f68b8e04392b3fda9973dea7a16bf1d01df9f99
--- /dev/null
+++ b/docs/source/autoaug/aa_learners/autoaug.autoaugment_learners.UcbLearner.rst
@@ -0,0 +1,7 @@
+:mod:`autoaug.autoaugment_learners`.UcbLearner
+==============================================
+
+.. currentmodule:: autoaug.autoaugment_learners
+
+.. autoclass:: UcbLearner
+ :members:
\ No newline at end of file
diff --git a/docs/source/autoaug/api_reference.rst b/docs/source/autoaug/api_reference.rst
deleted file mode 100644
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000
diff --git a/docs/source/autoaug/auto_augmentation_learners.rst b/docs/source/autoaug/auto_augmentation_learners.rst
deleted file mode 100644
index 7ac9319a9bc01cb9afc9262c6ebeaec3243f237c..0000000000000000000000000000000000000000
--- a/docs/source/autoaug/auto_augmentation_learners.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-AutoAugment learners
---------------------
-
-
-.. autosummary::
- :toctree: generated
-
- autoaug.autoaugment_learners.AaLearner
- autoaug.autoaugment_learners.EvoLearner
- autoaug.autoaugment_learners.GruLearner
- autoaug.autoaugment_learners.RsLearner
- autoaug.autoaugment_learners.UcbLearner
\ No newline at end of file
diff --git a/docs/source/autoaug/autoaugment_learners.rst b/docs/source/autoaug/autoaugment_learners.rst
new file mode 100644
index 0000000000000000000000000000000000000000..3cd0dbc23c67c6c722a03debf58960e792f44d1d
--- /dev/null
+++ b/docs/source/autoaug/autoaugment_learners.rst
@@ -0,0 +1,12 @@
+AutoAugment learners
+--------------------
+
+.. toctree::
+ :maxdepth: 3
+ :caption: autoaugment_learners
+
+ aa_learners/autoaug.autoaugment_learners.AaLearner
+ aa_learners/autoaug.autoaugment_learners.EvoLearner
+ aa_learners/autoaug.autoaugment_learners.GruLearner
+ aa_learners/autoaug.autoaugment_learners.RsLearner
+ aa_learners/autoaug.autoaugment_learners.UcbLearner
\ No newline at end of file
diff --git a/docs/source/autoaug/generated/autoaug.autoaugment_learners.AaLearner.rst b/docs/source/autoaug/generated/autoaug.autoaugment_learners.AaLearner.rst
deleted file mode 100644
index 2960b163338ba9c12e5857b3fd9f9437438bb5ef..0000000000000000000000000000000000000000
--- a/docs/source/autoaug/generated/autoaug.autoaugment_learners.AaLearner.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-autoaug.autoaugment\_learners.AaLearner
-=======================================
-
-.. currentmodule:: autoaug.autoaugment_learners
-
-.. autoclass:: AaLearner
-
-
- .. automethod:: __init__
-
-
- .. rubric:: Methods
-
- .. autosummary::
-
- ~AaLearner.__init__
- ~AaLearner.get_mega_policy
- ~AaLearner.learn
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/source/autoaug/generated/autoaug.autoaugment_learners.EvoLearner.rst b/docs/source/autoaug/generated/autoaug.autoaugment_learners.EvoLearner.rst
deleted file mode 100644
index 68f0d7133b1c5e2ff5c5f670925628e293a539ed..0000000000000000000000000000000000000000
--- a/docs/source/autoaug/generated/autoaug.autoaugment_learners.EvoLearner.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-autoaug.autoaugment\_learners.EvoLearner
-========================================
-
-.. currentmodule:: autoaug.autoaugment_learners
-
-.. autoclass:: EvoLearner
-
-
- .. automethod:: __init__
-
-
- .. rubric:: Methods
-
- .. autosummary::
-
- ~EvoLearner.__init__
- ~EvoLearner.get_mega_policy
- ~EvoLearner.learn
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/source/autoaug/generated/autoaug.autoaugment_learners.GruLearner.rst b/docs/source/autoaug/generated/autoaug.autoaugment_learners.GruLearner.rst
deleted file mode 100644
index 1162183bc2b979b21a71fa8882d68f9fc424c8aa..0000000000000000000000000000000000000000
--- a/docs/source/autoaug/generated/autoaug.autoaugment_learners.GruLearner.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-autoaug.autoaugment\_learners.GruLearner
-========================================
-
-.. currentmodule:: autoaug.autoaugment_learners
-
-.. autoclass:: GruLearner
-
-
- .. automethod:: __init__
-
-
- .. rubric:: Methods
-
- .. autosummary::
-
- ~GruLearner.__init__
- ~GruLearner.get_mega_policy
- ~GruLearner.learn
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/source/autoaug/generated/autoaug.autoaugment_learners.RsLearner.rst b/docs/source/autoaug/generated/autoaug.autoaugment_learners.RsLearner.rst
deleted file mode 100644
index 9b099240ced7d2537b8297588a0f7d2418ef0558..0000000000000000000000000000000000000000
--- a/docs/source/autoaug/generated/autoaug.autoaugment_learners.RsLearner.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-autoaug.autoaugment\_learners.RsLearner
-=======================================
-
-.. currentmodule:: autoaug.autoaugment_learners
-
-.. autoclass:: RsLearner
-
-
- .. automethod:: __init__
-
-
- .. rubric:: Methods
-
- .. autosummary::
-
- ~RsLearner.__init__
- ~RsLearner.get_mega_policy
- ~RsLearner.learn
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/source/autoaug/generated/autoaug.autoaugment_learners.UcbLearner.rst b/docs/source/autoaug/generated/autoaug.autoaugment_learners.UcbLearner.rst
deleted file mode 100644
index b20667da9a19c5fc4a73ed50fbcebea844b66db3..0000000000000000000000000000000000000000
--- a/docs/source/autoaug/generated/autoaug.autoaugment_learners.UcbLearner.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-autoaug.autoaugment\_learners.UcbLearner
-========================================
-
-.. currentmodule:: autoaug.autoaugment_learners
-
-.. autoclass:: UcbLearner
-
-
- .. automethod:: __init__
-
-
- .. rubric:: Methods
-
- .. autosummary::
-
- ~UcbLearner.__init__
- ~UcbLearner.get_mega_policy
- ~UcbLearner.learn
- ~UcbLearner.make_more_policies
-
-
-
-
-
-
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b210c1e1cdaa48c2ac2f3150d953fe7f5cd3479e..05b42d6ea104e6caefe59a6904be90a0593691c3 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,4 +1,4 @@
-autoaug Documentation
+``autoaug`` official documentation
==================================
@@ -14,11 +14,14 @@ autoaug Documentation
.. toctree::
:maxdepth: 4
- :caption: Library:
-
- autoaug/auto_augmentation_learners
-
-
+ :caption: API Reference:
+
+ autoaug/autoaugment_learners
+ autoaug/aa_learners/autoaug.autoaugment_learners.AaLearner
+ autoaug/aa_learners/autoaug.autoaugment_learners.EvoLearner
+ autoaug/aa_learners/autoaug.autoaugment_learners.GruLearner
+ autoaug/aa_learners/autoaug.autoaugment_learners.RsLearner
+ autoaug/aa_learners/autoaug.autoaugment_learners.UcbLearner