Completed documentation

Signed-off-by: Jim Martens <github@2martens.de>

src/twomartens/masterthesis/cli.py

@@ -20,10 +20,14 @@ Provides CLI actions.
 
 Functions:
     config(...): handles the config component
-    train(...): trains a network
-    test(...): evaluates a network
-    val(...): runs predictions on the validation data
     prepare(...): prepares the SceneNet ground truth data
+    train(...): trains a network
+    test(...): tests a network
+    evaluate(...): evaluates prediction results
+    visualise(...): visualises ground truth
+    visualise_metrics(...): visualises evaluation results
+    visualise_all(...): creates figure for specific variants and thresholds
+    measure_mapping(...): measures the number of instances per COCO class
 """
 import argparse
 from typing import Any

src/twomartens/masterthesis/data.py

@@ -20,8 +20,11 @@ Functionality to load data into Tensorflow data sets.
 Functions:
     load_coco_train(...): loads the COCO training data into a Tensorflow data set
     load_coco_val(...): loads the COCO validation data into a Tensorflow data set
+    load_coco_val_ssd(...): loads the COCO validation data using the ssd_keras data pipeline
     load_scenenet_data(...): loads the SceneNet RGB-D data into a Tensorflow data set
     prepare_scenenet_data(...): prepares the SceneNet RGB-D data and returns it in Python format
+    group_bboxes_to_images(...): groups bounding boxes to images
+    clean_dataset(...): cleans a COCO data set and returns cleaned version
 """
 from typing import Callable
 from typing import Generator
@@ -248,6 +251,16 @@ def _load_images_callback(resized_shape: Sequence[int]) -> Callable[
 
 def group_bboxes_to_images(file_names: Sequence[str], bboxes: Sequence[Sequence[int]]) -> Tuple[List[str],
                                                                                                 List[List[List[int]]]]:
+    """
+    Groups bounding boxes to images.
+    
+    Args:
+        file_names: list of image file names
+        bboxes: list of bounding boxes
+    
+    Returns:
+        tuple of file names and corresponding lists of bounding boxes
+    """
     return_labels = {}
     for file_name, bbox in zip(file_names, bboxes):
         if file_name not in return_labels: