From 422e01a917ad15eb2df8759ddf3b0f349d419788 Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Fri, 8 Feb 2019 22:23:24 +0100 Subject: [PATCH] Improved docstring in aae package Signed-off-by: Jim Martens --- src/twomartens/masterthesis/aae/__init__.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/src/twomartens/masterthesis/aae/__init__.py b/src/twomartens/masterthesis/aae/__init__.py index 68f09f6..7e5b620 100644 --- a/src/twomartens/masterthesis/aae/__init__.py +++ b/src/twomartens/masterthesis/aae/__init__.py @@ -14,4 +14,16 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""masterthesis.aae: contains code for adversarial auto encoders""" +""" +Provides an AAE implementation. + +Modules: + ``model``: provides the keras models of the AAE implementation + + ``train``: provides functionality to train the AAE + + ``util``: provides helper functionality for visualization + +Todos: + - make the implementation compatible with the YCB Video dataset +"""