doc(pipeline): document TrafficImage fields

ZhiXin18 · Oct 8, 2024 · bf6aef5 · bf6aef5
1 parent 3725fde
commit bf6aef5
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/pipeline/TrafficImage.py b/pipeline/TrafficImage.py
@@ -1,4 +1,15 @@
 class TrafficImage:
+    """Traffic Image to be rated for congestion.
+
+    Attributes:
+        image: URL that retrieves Traffic camera image.
+        processed: Whether this TrafficImage instance has been processed.
+        congestion_rating: 0-1 Congestion Rating
+        camera_id: ID of the camera that captured this image
+        longitude: Longitude of the camera that captured this image
+        latitude: Latitude of the camera that captured this image
+    """
+
     def __init__(
         self,
         image=None,