Overview strings

scoutbot/agg/__init__.py

@@ -1,7 +1,11 @@
 # -*- coding: utf-8 -*-
-'''
-2022 Wild Me
-'''
+"""Aggregation (AGG) returns unified detects for an image given its individual tile detections
+
+This module defines how the tile-base localization detection results are aggregated
+at the image level.  This includes the ability to weight the importance of detections
+along the border of each tile within an image, and performing non-maximum suppression (NMS)
+on the combined results.
+"""
 import numpy as np
 import utool as ut
 
@@ -11,6 +15,9 @@ NMS_THRESH = 0.2
 
 
 def iou(box1, box2):
+    """
+    Computes the IoU (Intersection over Union) ratio for two bounding boxes.
+    """
     inter_xtl = max(box1['xtl'], box2['xtl'])
     inter_ytl = max(box1['ytl'], box2['ytl'])
     inter_xbr = min(box1['xbr'], box2['xbr'])
@@ -35,6 +42,10 @@ def iou(box1, box2):
 
 
 def demosaic(img_shape, tile_grids, loc_outputs, margin=MARGIN):
+    """
+    Demosaics a list of tiles and their respective detections back into the original
+    image's coordinate system.
+    """
     assert len(tile_grids) == len(loc_outputs)
 
     img_h, img_w = img_shape[:2]
@@ -125,6 +136,9 @@ def demosaic(img_shape, tile_grids, loc_outputs, margin=MARGIN):
 def compute(
     img_shape, tile_grids, loc_outputs, agg_thresh=AGG_THRESH, nms_thresh=NMS_THRESH
 ):
+    """
+    Compute the aggregated image-level detection results for a given list of tile-level detections
+    """
     from scoutbot.agg.py_cpu_nms import py_cpu_nms
 
     # Demosaic tile detection results and aggregate across the image

scoutbot/loc/__init__.py

@@ -1,6 +1,11 @@
 # -*- coding: utf-8 -*-
-'''
-The localizer (loc) is responsible for taking a (256, 256) tile image
+'''The localizer (LOC) returns bounding box detections on image tiles.
+
+This module defines how Localizer models are downloaded from an external CDN,
+how to load an image and prepare it for inference, demonstrates how to run the
+Localization ONNX model on this input, and finally how to convert this raw CNN
+output into usable detection bounding boxes with class labels and confidence
+scores.
 '''
 from os.path import exists, join
 from pathlib import Path

scoutbot/scoutbot.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-ScoutBot CLI executable
+Coming Soon
 """
 import click
 

scoutbot/tile/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
-2022 Wild Me
+
 '''
 from os.path import abspath, exists, join, split, splitext
 
@@ -66,6 +66,10 @@ def tile_write(img, grid, filepath):
 
 
 def tile_filepath(img_filepath, grid, ext=None):
+    """
+    Returns a suggested filepath for a tile given the original image filepath and the tile's grid
+    coordinates.
+    """
     x = grid.get('x')
     y = grid.get('y')
     w = grid.get('w')
@@ -86,6 +90,9 @@ def tile_filepath(img_filepath, grid, ext=None):
 def tile_grid(
     shape, size=TILE_SIZE, overlap=TILE_OVERLAP, offset=TILE_OFFSET, borders=TILE_BORDERS
 ):
+    """
+    Calculates a grid of tile coordinates for a given image.
+    """
     h_, w_ = shape[:2]
     w, h = size
     ol = overlap

scoutbot/utils.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 '''
-2022 Wild Me
+Scoutbot utilities file for common and handy functions.
 '''
 import logging
 from logging.handlers import TimedRotatingFileHandler