cpp scaffold

ashwinvaidya17 · ashwinvaidya17 · commit ab1e88acce9e · 2024-10-24T15:58:15.000+02:00
Signed-off-by: Ashwin Vaidya &lt;ashwinnitinvaidya@gmail.com&gt;
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,21 +36,24 @@
     "sphinx.ext.graphviz"
 ]
 
+myst_enable_extensions = [
+    "colon_fence",
+    # other MyST extensions...
+]
+
 templates_path = ['_templates']
 exclude_patterns = []
 
-
+# Automatic exclusion of prompts from the copies
+# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies
+copybutton_exclude = ".linenos, .gp, .go"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_book_theme"
 html_static_path = ['_static']
-html_theme_options = {
-    "logo": {
-        "text": "InferenceSDK",
-    },
-}
 
 breathe_projects = {"InferenceSDK":  Path(__file__).parent.parent/"build_cpp"/ "xml"}
 breathe_default_project = "InferenceSDK"
+breathe_default_members = ('members', 'undoc-members', 'private-members')
diff --git a/docs/source/cpp/adapters/index.md b/docs/source/cpp/adapters/index.md
@@ -0,0 +1,11 @@
+## Adapters
+
+```{eval-rst}
+.. doxygenclass:: InferenceAdapter
+
+```
+
+```{eval-rst}
+.. doxygenclass:: OpenVINOInferenceAdapter
+
+```
diff --git a/docs/source/cpp/index.md b/docs/source/cpp/index.md
@@ -0,0 +1,45 @@
+# C++ API Reference
+
+::::{grid} 1 2 2 3
+:margin: 1 1 0 0
+:gutter: 1
+
+:::{grid-item-card} {octicon}`plug` Adapters
+:link: ./adapters/index
+:link-type: doc
+
+Adapters description[todo]
+:::
+
+:::{grid-item-card} {octicon}`dependabot` Models
+:link: ./models/index
+:link-type: doc
+
+Models description[todo]
+:::
+
+:::{grid-item-card} {octicon}`versions` Tilers
+:link: ./tilers/index
+:link-type: doc
+
+Tilers description[todo]
+:::
+
+:::{grid-item-card} {octicon}`tools` Utils
+:link: ./utils/index
+:link-type: doc
+
+Utils description[todo]
+:::
+
+::::
+
+```{toctree}
+:caption: Classes
+:hidden:
+
+adapters/index
+models/index
+tilers/index
+utils/index
+```
diff --git a/docs/source/cpp/models/anomaly_model.md b/docs/source/cpp/models/anomaly_model.md
@@ -0,0 +1,6 @@
+# Anomaly Model
+
+```{eval-rst}
+.. doxygenclass:: AnomalyModel
+
+```
diff --git a/docs/source/cpp/models/associative_embedding_decoder.md b/docs/source/cpp/models/associative_embedding_decoder.md
@@ -0,0 +1 @@
+# Associative Embedding Decoder.H
diff --git a/docs/source/cpp/models/classification_model.md b/docs/source/cpp/models/classification_model.md
@@ -0,0 +1 @@
+# Classification Model.H
diff --git a/docs/source/cpp/models/deblurring_model.md b/docs/source/cpp/models/deblurring_model.md
@@ -0,0 +1 @@
+# Deblurring Model.H
diff --git a/docs/source/cpp/models/detection_model.md b/docs/source/cpp/models/detection_model.md
@@ -0,0 +1 @@
+# Detection Model.H
diff --git a/docs/source/cpp/models/detection_model_centernet.md b/docs/source/cpp/models/detection_model_centernet.md
@@ -0,0 +1 @@
+# Detection Model Centernet.H
diff --git a/docs/source/cpp/models/detection_model_ext.md b/docs/source/cpp/models/detection_model_ext.md
@@ -0,0 +1 @@
+# Detection Model Ext.H
diff --git a/docs/source/cpp/models/detection_model_faceboxes.md b/docs/source/cpp/models/detection_model_faceboxes.md
@@ -0,0 +1 @@
+# Detection Model Faceboxes.H
diff --git a/docs/source/cpp/models/detection_model_retinaface.md b/docs/source/cpp/models/detection_model_retinaface.md
@@ -0,0 +1 @@
+# Detection Model Retinaface.H
diff --git a/docs/source/cpp/models/detection_model_retinaface_pt.md b/docs/source/cpp/models/detection_model_retinaface_pt.md
@@ -0,0 +1 @@
+# Detection Model Retinaface Pt.H
diff --git a/docs/source/cpp/models/detection_model_ssd.md b/docs/source/cpp/models/detection_model_ssd.md
@@ -0,0 +1 @@
+# Detection Model Ssd.H
diff --git a/docs/source/cpp/models/detection_model_yolo.md b/docs/source/cpp/models/detection_model_yolo.md
@@ -0,0 +1 @@
+# Detection Model Yolo.H
diff --git a/docs/source/cpp/models/detection_model_yolov3_onnx.md b/docs/source/cpp/models/detection_model_yolov3_onnx.md
@@ -0,0 +1 @@
+# Detection Model Yolov3 Onnx.H
diff --git a/docs/source/cpp/models/detection_model_yolox.md b/docs/source/cpp/models/detection_model_yolox.md
@@ -0,0 +1 @@
+# Detection Model Yolox.H
diff --git a/docs/source/cpp/models/hpe_model_associative_embedding.md b/docs/source/cpp/models/hpe_model_associative_embedding.md
@@ -0,0 +1 @@
+# Hpe Model Associative Embedding.H
diff --git a/docs/source/cpp/models/hpe_model_openpose.md b/docs/source/cpp/models/hpe_model_openpose.md
@@ -0,0 +1 @@
+# Hpe Model Openpose.H
diff --git a/docs/source/cpp/models/image_model.md b/docs/source/cpp/models/image_model.md
@@ -0,0 +1 @@
+# Image Model.H
diff --git a/docs/source/cpp/models/index.md b/docs/source/cpp/models/index.md
@@ -0,0 +1,211 @@
+# Models
+
+::::{grid} 1 2 2 3
+:margin: 1 1 0 0
+:gutter: 1
+
+:::{grid-item-card} Model Base
+:link: ./model_base
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Super Resolution Model
+:link: ./super_resolution_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Associative Embedding Decoder
+:link: ./associative_embedding_decoder
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Centernet
+:link: ./detection_model_centernet
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Hpe Model Openpose
+:link: ./hpe_model_openpose
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model
+:link: ./detection_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Hpe Model Associative Embedding
+:link: ./hpe_model_associative_embedding
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Image Model
+:link: ./image_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Internal Model Data
+:link: ./internal_model_data
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Keypoint Detection
+:link: ./keypoint_detection
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Jpeg Restoration Model
+:link: ./jpeg_restoration_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Yolov3 Onnx
+:link: ./detection_model_yolov3_onnx
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Anomaly Model
+:link: ./anomaly_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Ext
+:link: ./detection_model_ext
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Segmentation Model
+:link: ./segmentation_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Yolox
+:link: ./detection_model_yolox
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Ssd
+:link: ./detection_model_ssd
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Faceboxes
+:link: ./detection_model_faceboxes
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Results
+:link: ./results
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Deblurring Model
+:link: ./deblurring_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Instance Segmentation
+:link: ./instance_segmentation
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Input Data
+:link: ./input_data
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Retinaface
+:link: ./detection_model_retinaface
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Yolo
+:link: ./detection_model_yolo
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Classification Model
+:link: ./classification_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Style Transfer Model
+:link: ./style_transfer_model
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Detection Model Retinaface Pt
+:link: ./detection_model_retinaface_pt
+:link-type: doc
+
+[todo]
+:::
+:::{grid-item-card} Openpose Decoder
+:link: ./openpose_decoder
+:link-type: doc
+
+[todo]
+:::
+
+::::
+
+```{toctree}
+:caption: Models
+:hidden:
+
+./model_base
+./super_resolution_model
+./associative_embedding_decoder
+./detection_model_centernet
+./hpe_model_openpose
+./detection_model
+./hpe_model_associative_embedding
+./image_model
+./internal_model_data
+./keypoint_detection
+./jpeg_restoration_model
+./detection_model_yolov3_onnx
+./anomaly_model
+./detection_model_ext
+./segmentation_model
+./detection_model_yolox
+./detection_model_ssd
+./detection_model_faceboxes
+./results
+./deblurring_model
+./instance_segmentation
+./input_data
+./detection_model_retinaface
+./detection_model_yolo
+./classification_model
+./style_transfer_model
+./detection_model_retinaface_pt
+./openpose_decoder
+
+```{toctree}
diff --git a/docs/source/cpp/models/input_data.md b/docs/source/cpp/models/input_data.md
@@ -0,0 +1 @@
+# Input Data.H
diff --git a/docs/source/cpp/models/instance_segmentation.md b/docs/source/cpp/models/instance_segmentation.md
@@ -0,0 +1 @@
+# Instance Segmentation.H
diff --git a/docs/source/cpp/models/internal_model_data.md b/docs/source/cpp/models/internal_model_data.md
@@ -0,0 +1 @@
+# Internal Model Data.H
diff --git a/docs/source/cpp/models/jpeg_restoration_model.md b/docs/source/cpp/models/jpeg_restoration_model.md
@@ -0,0 +1 @@
+# Jpeg Restoration Model.H
diff --git a/docs/source/cpp/models/keypoint_detection.md b/docs/source/cpp/models/keypoint_detection.md
@@ -0,0 +1 @@
+# Keypoint Detection.H
diff --git a/docs/source/cpp/models/model_base.md b/docs/source/cpp/models/model_base.md
@@ -0,0 +1 @@
+# Model Base.H
diff --git a/docs/source/cpp/models/openpose_decoder.md b/docs/source/cpp/models/openpose_decoder.md
@@ -0,0 +1 @@
+# Openpose Decoder.H
diff --git a/docs/source/cpp/models/results.md b/docs/source/cpp/models/results.md
@@ -0,0 +1 @@
+# Results.H
diff --git a/docs/source/cpp/models/segmentation_model.md b/docs/source/cpp/models/segmentation_model.md
@@ -0,0 +1 @@
+# Segmentation Model.H
diff --git a/docs/source/cpp/models/style_transfer_model.md b/docs/source/cpp/models/style_transfer_model.md
@@ -0,0 +1 @@
+# Style Transfer Model.H
diff --git a/docs/source/cpp/models/super_resolution_model.md b/docs/source/cpp/models/super_resolution_model.md
@@ -0,0 +1 @@
+# Super Resolution Model.H
diff --git a/docs/source/cpp/tilers/detection.md b/docs/source/cpp/tilers/detection.md
@@ -0,0 +1,6 @@
+# Detection
+
+```{eval-rst}
+.. doxygenclass:: DetectionTiler
+
+```
diff --git a/docs/source/cpp/tilers/index.md b/docs/source/cpp/tilers/index.md
diff --git a/docs/source/cpp/tilers/instance_segmentation.md b/docs/source/cpp/tilers/instance_segmentation.md
diff --git a/docs/source/cpp/tilers/semantic_segmentation.md b/docs/source/cpp/tilers/semantic_segmentation.md
diff --git a/docs/source/cpp/tilers/tiler_base.md b/docs/source/cpp/tilers/tiler_base.md
diff --git a/docs/source/cpp/utils/args_helper.md b/docs/source/cpp/utils/args_helper.md
diff --git a/docs/source/cpp/utils/async_infer_queue.md b/docs/source/cpp/utils/async_infer_queue.md
diff --git a/docs/source/cpp/utils/common.md b/docs/source/cpp/utils/common.md
diff --git a/docs/source/cpp/utils/image_utils.md b/docs/source/cpp/utils/image_utils.md
diff --git a/docs/source/cpp/utils/index.md b/docs/source/cpp/utils/index.md
diff --git a/docs/source/cpp/utils/kuhn_munkres.md b/docs/source/cpp/utils/kuhn_munkres.md
diff --git a/docs/source/cpp/utils/nms.md b/docs/source/cpp/utils/nms.md
diff --git a/docs/source/cpp/utils/ocv_common.md b/docs/source/cpp/utils/ocv_common.md
diff --git a/docs/source/cpp/utils/performance_metrics.md b/docs/source/cpp/utils/performance_metrics.md
diff --git a/docs/source/cpp/utils/slog.md b/docs/source/cpp/utils/slog.md
