Corrected docstrings

Signed-off-by: Jim Martens <github@2martens.de>
This commit is contained in:
2019-04-04 17:24:05 +02:00
parent 53955cbc46
commit c83a65571b
2 changed files with 9 additions and 3 deletions

View File

@ -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

View File

@ -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
"""