chore: update documentation to refactor

docs/classifier_cetacean.md

@@ -0,0 +1,3 @@
+This module documents the cetacean fluke and fin classifier. 
+
+::: src.classifier.cetacean_image

docs/fix_tabrender.md

@@ -2,4 +2,4 @@ A js fix for certain UI elements, including maps, getting rendered into a
 zero-sized frame by default. Here we resize it so it is visible once the tab is
 clicked and no further interaction is required to see it.
 
-::: src.fix_tabrender
+::: src.utils.fix_tabrender

docs/grid_maker.md

@@ -0,0 +1,3 @@
+This module takes care of creating a grid composed of batches, rows and pages based on an incoming number of items. 
+
+::: src.utils.grid_maker

docs/hf_push_observations.md

@@ -0,0 +1,3 @@
+This module writes an observation into a temporary JSON file, in order to add this JSON file to the Saving-Willy Dataset in the Saving-Willy Hugging Face Community. 
+
+::: src.hf_push_observations

docs/hotdog.md

@@ -0,0 +1,3 @@
+This module documents the "hotdog" classifier. This example is purely a placeholder to show how multiple image (or other data) classifiers could be present in the same interface. 
+
+::: src.classifier.classifier_hotdog

docs/input_handling.md

@@ -5,4 +5,4 @@ This module focuses on image and metadata entry:
 - a container class for an observation
 
 
-::: src.input_handling
+::: src.input.input_handling

docs/input_observation.md

@@ -0,0 +1,3 @@
+This module focuses on the Object Class representing an Observation once all the data has been extracted automatically or inputted by the user. 
+
+::: src.input.input_observation

docs/input_validator.md

@@ -0,0 +1,3 @@
+This module focuses on the extraction and validation of data after data input. 
+
+::: src.input.input_validator

docs/metadata_handler.md

@@ -0,0 +1,3 @@
+This module takes care of formatting some fields of the metadata to make them human readable by the user. 
+
+::: src.utils.metadata_handler

docs/obs_map.md

@@ -4,4 +4,4 @@ Note: OSM, ESRI, and CartoDB map tiles are served without authentication/tokens,
 and so render correctly on the huggingface deployment. The Stamen tiles render
 on localhost but require a token to present on a 3rd-party site.
 
-::: src.obs_map
+::: src.maps.obs_map

mkdocs.yaml

@@ -28,12 +28,23 @@ nav:
   - API:
     - Main app: main.md
     - Modules:
-      - Data entry handling: input_handling.md
+      - Data entry handling: 
+        - Data input: input_handling.md
+        - Data extraction and validation: input_validator.md
+        - Data Object Class: input_observation.md
+      - Classifiers: 
+        - Cetacean Fluke & Fin Recognition: classifier_cetacean.md
+        - (temporary) Hotdog Classifier: hotdog.md
+      - Hugging Face Integration: 
+        - Push Observations to Dataset: hf_push_observations.md
       - Map of observations: obs_map.md
       - Whale gallery: whale_gallery.md
       - Whale viewer: whale_viewer.md
       - Logging: st_logs.md
-      - Tab-rendering fix (js): fix_tabrender.md
+      - Utils: 
+        - Tab-rendering fix (js): fix_tabrender.md
+        - Metadata handling: metadata_handler.md
+        - Grid maker: grid_maker.md
 
     - Development clutter:
       - Demo app: app.md

src/classifier/classifier_image.py

@@ -12,6 +12,11 @@ from utils.grid_maker import gridder
 from utils.metadata_handler import metadata2md
 
 def cetacean_classify(cetacean_classifier):
+    """Cetacean classifier using the saving-willy model from Saving Willy Hugging Face space.
+    For each image in the session state, classify the image and display the top 3 predictions.
+    Args:
+        cetacean_classifier ([type]):  saving-willy model from Saving Willy Hugging Face space
+    """
     images = st.session_state.images
     observations = st.session_state.observations
     hashes = st.session_state.image_hashes

src/utils/grid_maker.py

@@ -2,6 +2,14 @@ import streamlit as st
 import math
 
 def gridder(items):
+    """Creates a grid for displaying items in a batched manner.
+    Args:
+        items (list): The items to be displayed.
+    Returns:
+        batch_size (int): The number of items to display in each batch.
+        row_size (int): The number of items to display in each row.
+        page (int): The range of pages available based on the number of items.
+    """
     cols = st.columns(3)
     with cols[0]:
         batch_size = st.select_slider("Batch size:",range(10,110,10), value=10)