From b70c0a31f79633101b2d73c38c8a4788924d798a Mon Sep 17 00:00:00 2001 From: Charles Zaloom Date: Thu, 12 Dec 2024 13:18:01 -0600 Subject: [PATCH] added python docs --- docs/classification/documentation.md | 16 +++++++++++ docs/index.md | 12 +++++++- docs/object_detection/documentation.md | 31 +++++++++++++++++++++ docs/semantic_segmentation/documentation.md | 21 ++++++++++++++ docs/text_generation/documentation.md | 16 +++++++++++ mkdocs.yml | 4 +++ 6 files changed, 99 insertions(+), 1 deletion(-) create mode 100644 docs/classification/documentation.md create mode 100644 docs/object_detection/documentation.md create mode 100644 docs/semantic_segmentation/documentation.md create mode 100644 docs/text_generation/documentation.md diff --git a/docs/classification/documentation.md b/docs/classification/documentation.md new file mode 100644 index 000000000..fe2dcc915 --- /dev/null +++ b/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 diff --git a/docs/index.md b/docs/index.md index 72a38e32e..66f453592 100644 --- a/docs/index.md +++ b/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. diff --git a/docs/object_detection/documentation.md b/docs/object_detection/documentation.md new file mode 100644 index 000000000..e4c1844aa --- /dev/null +++ b/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 diff --git a/docs/semantic_segmentation/documentation.md b/docs/semantic_segmentation/documentation.md new file mode 100644 index 000000000..5ae0bb57d --- /dev/null +++ b/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 diff --git a/docs/text_generation/documentation.md b/docs/text_generation/documentation.md new file mode 100644 index 000000000..7858dcacc --- /dev/null +++ b/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 diff --git a/mkdocs.yml b/mkdocs.yml index ac61dee6a..49e956c49 100644 --- a/mkdocs.yml +++ b/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"