Reformat, improve comments.

Author: UPstartDeveloper

app/main.py

@@ -3,8 +3,12 @@
 from fire_classifier.util.api import API
 
 # A: init API
-app = FastAPI(title=API["title"], description=API["description"],
-              version=API["version"], openapi_tags=API["endpoints"])
+app = FastAPI(
+    title=API["title"],
+    description=API["description"],
+    version=API["version"],
+    openapi_tags=API["endpoints"],
+)
 
 # B: init ML inference object, and the routes
 predictor_config_path = API["config_path"]

fire_classifier/util/api.py

@@ -8,6 +8,8 @@
 
 # Info about what data users can request.
 # These are intended shown on the UI, related only to a specific endpoint.
+# Note: the value in the "name" field should match what goes in the
+#       "tags" parameter of the corresponding app route in main.py!!
 API_ENDPOINTS = (
     {
         "name": "Detect Fire",
@@ -17,7 +19,7 @@
 
 # Tells the app how to find the config.yaml (for running ML inference)
 BASE_DIR = Path(__file__).resolve().parent.parent.parent
-CONFIG_PATH = os.path.join(BASE_DIR, 'app', 'config.yaml')
+CONFIG_PATH = os.path.join(BASE_DIR, "app", "config.yaml")
 
 # Wraps all the API metadata as one dictionary
 API = {
@@ -26,4 +28,4 @@
     "version": API_VERSION,
     "endpoints": API_ENDPOINTS,
     "config_path": CONFIG_PATH,
-}
+}