added python docs

docs/classification/documentation.md

@@ -0,0 +1,16 @@
+Documentation
+
+::: valor_lite.classification.Classification
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.classification.DataLoader
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.classification.Evaluator
+    options:
+        show_root_heading: true
+        show_source: true

docs/index.md

@@ -18,7 +18,17 @@ cd valor
 make install
 ```
 
-# Quick Links
+## Quick Links
 
+- **Documentation**
+    - Classification
+        - [DataLoader](classification/dataloader.md)
+        - [Metrics](classification/metrics.md)
+    - Object Detection
+        - [Metrics](object_detection/metrics.md)
+    - Semantic Segmentation
+        - [Metrics](semantic_segmentation/metrics.md)
+    - Text Generation
+        - [Metrics](text_generation/metrics.md)
 - **[Example Notebooks](https://github.com/Striveworks/valor/blob/main/examples/)**: Collection of descriptive Jupyter notebooks giving examples of how to evaluate model performance using Valor.
 - **[Contributing and Development](contributing.md)**: Explains how you can build on and contribute to Valor.

docs/object_detection/documentation.md

@@ -0,0 +1,31 @@
+Documentation
+
+::: valor_lite.object_detection.BoundingBox
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.object_detection.Polygon
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.object_detection.Bitmask
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.object_detection.Detection
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.object_detection.DataLoader
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.object_detection.Evaluator
+    options:
+        show_root_heading: true
+        show_source: true

docs/semantic_segmentation/documentation.md

@@ -0,0 +1,21 @@
+Documentation
+
+::: valor_lite.semantic_segmentation.Bitmask
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.semantic_segmentation.Segmentation
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.semantic_segmentation.DataLoader
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.semantic_segmentation.Evaluator
+    options:
+        show_root_heading: true
+        show_source: true

docs/text_generation/documentation.md

@@ -0,0 +1,16 @@
+Documentation
+
+::: valor_lite.text_generation.Context
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.text_generation.QueryResponse
+    options:
+        show_root_heading: true
+        show_source: true
+
+::: valor_lite.text_generation.Evaluator
+    options:
+        show_root_heading: true
+        show_source: true

mkdocs.yml

@@ -12,12 +12,16 @@ extra_javascript:
 nav:
   - Overview: "index.md"
   - Classification:
+    - Documentation: "classification/documentation.md"
     - Metrics: "classification/metrics.md"
   - Object Detection:
+    - Documentation: "object_detection/documentation.md"
     - Metrics: "object_detection/metrics.md"
   - Semantic Segmentation:
+    - Documentation: "semantic_segmentation/documentation.md"
     - Metrics: "semantic_segmentation/metrics.md"
   - Text Generation:
+    - Documentation: "text_generation/documentation.md"
     - Metrics: "text_generation/metrics.md"
   - Example Notebooks: "https://github.com/Striveworks/valor/blob/main/examples/"
   - Contributing & Development: "contributing.md"