From c83a65571b0c1bc197599293043eb3e31fd2b4b5 Mon Sep 17 00:00:00 2001 From: Jim Martens Date: Thu, 4 Apr 2019 17:24:05 +0200 Subject: [PATCH] Corrected docstrings Signed-off-by: Jim Martens --- src/twomartens/masterthesis/aae/data.py | 8 ++++++++ src/twomartens/masterthesis/aae/train.py | 4 +--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/twomartens/masterthesis/aae/data.py b/src/twomartens/masterthesis/aae/data.py index 72cb05d..7058d58 100644 --- a/src/twomartens/masterthesis/aae/data.py +++ b/src/twomartens/masterthesis/aae/data.py @@ -14,6 +14,14 @@ # See the License for the specific language governing permissions and # limitations under the License. +""" +Data functionality for my AAE implementation. + +This module provides a function to prepare the training data. + +Functions: + prepare_training_data(...): prepares the mnist training data +""" import pickle from typing import Sequence from typing import Tuple diff --git a/src/twomartens/masterthesis/aae/train.py b/src/twomartens/masterthesis/aae/train.py index 7bfa1ad..81eb1bd 100644 --- a/src/twomartens/masterthesis/aae/train.py +++ b/src/twomartens/masterthesis/aae/train.py @@ -17,14 +17,12 @@ """ Training functionality for my AAE implementation. -This module provides functions to prepare the training data and subsequently -train a simple auto-encoder. +This module provides a function to train a simple auto-encoder. Attributes: LOG_FREQUENCY: number of steps that must pass before logging happens Functions: - prepare_training_data(...): prepares the mnist training data train_simple(...): trains a simple auto-encoder only with reconstruction loss """