From 15b9eb4dca06a716dca88df2e0ca75d48bb50dc4 Mon Sep 17 00:00:00 2001
From: lucas_miranda <lucasmiranda42@gmail.com>
Date: Thu, 17 Sep 2020 14:03:40 +0200
Subject: [PATCH] Added header docstrings to all modules

---
 deepof/hypermodels.py     | 8 ++++++++
 deepof/models.py          | 8 ++++++++
 deepof/visuals.py         | 8 ++++++++
 tests/test_model_utils.py | 8 ++++++++
 tests/test_preprocess.py  | 8 ++++++++
 tests/test_utils.py       | 8 ++++++++
 tests/test_visuals.py     | 8 ++++++++
 7 files changed, 56 insertions(+)

diff --git a/deepof/hypermodels.py b/deepof/hypermodels.py
index 76210950..5904092e 100644
--- a/deepof/hypermodels.py
+++ b/deepof/hypermodels.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+keras hypermodels for hyperparameter tuning of deep autoencoders
+
+"""
 
 from kerastuner import HyperModel
 from tensorflow.keras import backend as K
diff --git a/deepof/models.py b/deepof/models.py
index bee22e91..e07069e1 100644
--- a/deepof/models.py
+++ b/deepof/models.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+deep autoencoder models for unsupervised pose detection
+
+"""
 
 from tensorflow.keras import backend as K
 from tensorflow.keras import Input, Model, Sequential
diff --git a/deepof/visuals.py b/deepof/visuals.py
index c45aaea3..937d01c5 100644
--- a/deepof/visuals.py
+++ b/deepof/visuals.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+General plotting functions for the deepof package
+
+"""
 
 import matplotlib.pyplot as plt
 import numpy as np
diff --git a/tests/test_model_utils.py b/tests/test_model_utils.py
index b5d27855..8f59e043 100644
--- a/tests/test_model_utils.py
+++ b/tests/test_model_utils.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+Testing module for deepof.model_utils
+
+"""
 
 from hypothesis import given
 from hypothesis import settings
diff --git a/tests/test_preprocess.py b/tests/test_preprocess.py
index 9f70c9fe..18a797ba 100644
--- a/tests/test_preprocess.py
+++ b/tests/test_preprocess.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+Testing module for deepof.preprocess
+
+"""
 
 from hypothesis import given
 from hypothesis import settings
diff --git a/tests/test_utils.py b/tests/test_utils.py
index 6add3b8e..a4a2091b 100644
--- a/tests/test_utils.py
+++ b/tests/test_utils.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+Testing module for deepof.utils
+
+"""
 
 from hypothesis import given
 from hypothesis import HealthCheck
diff --git a/tests/test_visuals.py b/tests/test_visuals.py
index b5d27855..5ac23b9a 100644
--- a/tests/test_visuals.py
+++ b/tests/test_visuals.py
@@ -1,4 +1,12 @@
 # @author lucasmiranda42
+# encoding: utf-8
+# module deepof
+
+"""
+
+Testing module for deepof.visuals
+
+"""
 
 from hypothesis import given
 from hypothesis import settings
-- 
GitLab