diff --git a/depthai_sdk/docs/requirements.txt b/depthai_sdk/docs/requirements.txt index d75a044fe..64ff0299c 100644 --- a/depthai_sdk/docs/requirements.txt +++ b/depthai_sdk/docs/requirements.txt @@ -1,4 +1,5 @@ -Sphinx==4.2.0 -sphinx-rtd-theme==0.5.0 -autodocsumm==0.2.10 -sphinx-tabs==3.4.0 \ No newline at end of file +Sphinx==3.4.3 +sphinx-rtd-theme==0.5.2 +autodocsumm==0.2.2 +sphinx-tabs==1.3.0 +jinja2==3.0.3 \ No newline at end of file diff --git a/depthai_sdk/docs/source/_static/images/favicon.png b/depthai_sdk/docs/source/_static/images/favicon.png index 2bbaad0ec..decd05d31 100644 Binary files a/depthai_sdk/docs/source/_static/images/favicon.png and b/depthai_sdk/docs/source/_static/images/favicon.png differ diff --git a/depthai_sdk/docs/source/_static/images/logo.png b/depthai_sdk/docs/source/_static/images/logo.png deleted file mode 100644 index 5f294fb91..000000000 Binary files a/depthai_sdk/docs/source/_static/images/logo.png and /dev/null differ diff --git a/depthai_sdk/docs/source/conf.py b/depthai_sdk/docs/source/conf.py index 884eca56a..518fea8f7 100644 --- a/depthai_sdk/docs/source/conf.py +++ b/depthai_sdk/docs/source/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'DepthAI SDK Docs' -copyright = u"@build_year@, Luxonis" +html_show_copyright=False author = 'Luxonis' # The full version, including alpha/beta/rc tags diff --git a/depthai_sdk/docs/source/features/conditional-actions.rst b/depthai_sdk/docs/source/features/conditional-actions.rst index 6efca5f15..fa504091b 100644 --- a/depthai_sdk/docs/source/features/conditional-actions.rst +++ b/depthai_sdk/docs/source/features/conditional-actions.rst @@ -51,7 +51,7 @@ When the trigger is activated, it records a 15 seconds video (5 seconds before t :language: python Reference -------------- +--------- .. autoclass:: depthai_sdk.trigger_action.TriggerAction :members: diff --git a/depthai_sdk/docs/source/fundamentals/components.rst b/depthai_sdk/docs/source/fundamentals/components.rst index 74b1305bc..b4e3add3a 100644 --- a/depthai_sdk/docs/source/fundamentals/components.rst +++ b/depthai_sdk/docs/source/fundamentals/components.rst @@ -4,14 +4,16 @@ Components Components are part of the :ref:`OakCamera` class and abstract `DepthAI API nodes `__; their initialization, configuration, and linking. This improves ease of use when developing OAK aplications. -**Available components** +Available components +-------------------- - :ref:`CameraComponent` - :ref:`NNComponent` - :ref:`StereoComponent` - :ref:`IMUComponent` -**Reference** +Reference +--------- .. autoclass:: depthai_sdk.components.Component :members: diff --git a/depthai_sdk/docs/source/fundamentals/packets.rst b/depthai_sdk/docs/source/fundamentals/packets.rst index 895def582..c907180b3 100644 --- a/depthai_sdk/docs/source/fundamentals/packets.rst +++ b/depthai_sdk/docs/source/fundamentals/packets.rst @@ -8,7 +8,7 @@ Packets are **synchronized collections** of one or more `DepthAI messages `. API Usage -##### +######### #. :meth:`OakCamera.visualize() `: In the example below SDK won't show the frame to the user, but instead it will send the packet to the callback function. SDK will draw detections (bounding boxes, labels) on the ``packet.frame``. #. :meth:`OakCamera.callback() `: This will also send :class:`DetectionPacket ` to the callback function, the only difference is that the SDK won't draw on the frame, so you can draw detections on the frame yourself. diff --git a/depthai_sdk/docs/source/includes/footer-short.rst b/depthai_sdk/docs/source/includes/footer-short.rst index 754e010b4..f770b7885 100644 --- a/depthai_sdk/docs/source/includes/footer-short.rst +++ b/depthai_sdk/docs/source/includes/footer-short.rst @@ -3,4 +3,4 @@

Got questions?

Head over to Discussion Forum for technical support or any other questions you might have. -| + diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_cam_ffc.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_cam_ffc.rst index bfcbca398..f3bd90f70 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_cam_ffc.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_cam_ffc.rst @@ -28,7 +28,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/cam_ffc.py :language: python diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control.rst index d5d6a275f..8d86c2e94 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control.rst @@ -40,7 +40,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/camera_control.py :language: python diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control_with_nn.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control_with_nn.rst index 23db6a3c5..894ef5de0 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control_with_nn.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_control_with_nn.rst @@ -32,9 +32,9 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ - .. literalinclude:: ../../../../examples/CameraComponent/camera_control_with_NN.py + .. literalinclude:: ../../../../examples/CameraComponent/camera_control_with_nn.py :language: python :linenos: diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_preview.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_preview.rst index 7b6e02a50..b86d394ad 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_preview.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_camera_preview.rst @@ -34,7 +34,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/camera_preview.py :language: python diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_mono_400p.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_mono_400p.rst index 2902419e6..677b915b4 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_mono_400p.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_mono_400p.rst @@ -31,7 +31,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/mono_400p.py :language: python diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_preview_all_cameras.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_preview_all_cameras.rst index a765b98c1..b9ad72f7c 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_preview_all_cameras.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_preview_all_cameras.rst @@ -32,7 +32,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/preview_all_cameras.py :language: python diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_rgb_mono_preview.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_rgb_mono_preview.rst index fa70f29ce..72a15bd54 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_rgb_mono_preview.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_rgb_mono_preview.rst @@ -29,7 +29,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/rgb_mono_preview.py :language: python diff --git a/depthai_sdk/docs/source/samples/CameraComponent/sdk_rotated.rst b/depthai_sdk/docs/source/samples/CameraComponent/sdk_rotated.rst index 81ce2c1ec..f1d46d538 100644 --- a/depthai_sdk/docs/source/samples/CameraComponent/sdk_rotated.rst +++ b/depthai_sdk/docs/source/samples/CameraComponent/sdk_rotated.rst @@ -30,7 +30,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/rotated.py :language: python diff --git a/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu.rst b/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu.rst index 21a46f70e..7e3150fe6 100644 --- a/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu.rst +++ b/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu.rst @@ -33,7 +33,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__. + Also `available on GitHub `__. .. literalinclude:: ../../../../examples/IMUComponent/imu.py :language: python diff --git a/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu_rerun.rst b/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu_rerun.rst index 50d58312e..84daa45c0 100644 --- a/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu_rerun.rst +++ b/depthai_sdk/docs/source/samples/IMUComponent/sdk_imu_rerun.rst @@ -33,7 +33,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__. + Also `available on GitHub `__. .. literalinclude:: ../../../../examples/IMUComponent/imu_rerun.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_age_gender.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_age_gender.rst index 9a93a09e5..4c8d7fd2f 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_age_gender.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_age_gender.rst @@ -29,7 +29,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/age-gender.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_custom_decode.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_custom_decode.rst index 6a37b7efd..f3bc50a38 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_custom_decode.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_custom_decode.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/custom_decode.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_deeplabv3_person.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_deeplabv3_person.rst index 160d974b9..3f4a1d4a1 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_deeplabv3_person.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_deeplabv3_person.rst @@ -24,10 +24,11 @@ Source Code ########### One thing worth noting is the resize mode option. Because inference is done on a color camera which has a 16:9 aspect ratio, and the model expects a 1:1 aspect ratio, we need -to resize the input frame to fit the model. This is done in three ways: - - letterbox - resize the frame to fit the model, and pad the rest with black pixels - - crop - crop the frame to fit the model - - stretch - stretch the frame to fit the model +to resize the input frame to fit the model. This is done in three ways: + +- letterbox - resize the frame to fit the model, and pad the rest with black pixels +- crop - crop the frame to fit the model +- stretch - stretch the frame to fit the model More information at `Maximizing FOV `__. @@ -37,7 +38,7 @@ More information at `Maximizing FOV `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/NNComponent/deeplabv3_person.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_emotion_recognition.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_emotion_recognition.rst index bd6d02d41..0def7c4d4 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_emotion_recognition.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_emotion_recognition.rst @@ -30,7 +30,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/emotion-recognition.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_color.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_color.rst index 8cde34eaa..563dceb3e 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_color.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_color.rst @@ -33,7 +33,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/face_detection_color.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_left.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_left.rst index 158814bd7..c2ff435a0 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_left.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_face_detection_left.rst @@ -31,7 +31,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/face_detection_left.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_human_pose.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_human_pose.rst index 64fd2a855..d09bad817 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_human_pose.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_human_pose.rst @@ -29,7 +29,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/human_pose.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_mobilenet_encoded.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_mobilenet_encoded.rst index 6d8087c81..c102e9574 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_mobilenet_encoded.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_mobilenet_encoded.rst @@ -26,7 +26,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/NNComponent/mobilenet_encoded.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_nn_component.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_nn_component.rst index 2778b059f..7e9030354 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_nn_component.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_nn_component.rst @@ -7,7 +7,6 @@ For additional models, check: `models supported by SDK `__. + Also `available on GitHub `__. .. literalinclude:: ../../../../examples/NNComponent/nn_component.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_object_tracking.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_object_tracking.rst index 8e768f41d..2f9fccd0b 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_object_tracking.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_object_tracking.rst @@ -34,7 +34,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__. + Also `available on GitHub `__. .. literalinclude:: ../../../../examples/NNComponent/object_tracking.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_roboflow_integration.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_roboflow_integration.rst index 43befa343..e7afb3d5c 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_roboflow_integration.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_roboflow_integration.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__. + Also `available on GitHub `__. .. literalinclude:: ../../../../examples/NNComponent/roboflow_integration.py :language: python diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_spatial_detection.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_spatial_detection.rst index d6b07d778..dfa00209d 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_spatial_detection.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_spatial_detection.rst @@ -33,7 +33,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/NNComponent/spatial_detection.py diff --git a/depthai_sdk/docs/source/samples/NNComponent/sdk_yolo.rst b/depthai_sdk/docs/source/samples/NNComponent/sdk_yolo.rst index 65660f7f8..da377d65e 100644 --- a/depthai_sdk/docs/source/samples/NNComponent/sdk_yolo.rst +++ b/depthai_sdk/docs/source/samples/NNComponent/sdk_yolo.rst @@ -33,7 +33,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__. + Also `available on GitHub `__. .. literalinclude:: ../../../../examples/NNComponent/yolo.py diff --git a/depthai_sdk/docs/source/samples/PointcloudComponent/SDK_pointcloud.rst b/depthai_sdk/docs/source/samples/PointcloudComponent/SDK_pointcloud.rst index 64e6bec07..6a31ca594 100644 --- a/depthai_sdk/docs/source/samples/PointcloudComponent/SDK_pointcloud.rst +++ b/depthai_sdk/docs/source/samples/PointcloudComponent/SDK_pointcloud.rst @@ -33,11 +33,9 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. - - - .. literalinclude:: ../../../../examples/PointcloudComonent/pointcloud.py + .. literalinclude:: ../../../../examples/PointcloudComponent/pointcloud.py :language: python :linenos: diff --git a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo.rst b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo.rst index 94f597bdf..75239b2aa 100644 --- a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo.rst +++ b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/StereoComponent/stereo.py diff --git a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_auto_ir.rst b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_auto_ir.rst index 70e7e3614..47eca77bc 100644 --- a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_auto_ir.rst +++ b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_auto_ir.rst @@ -29,7 +29,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/StereoComponent/stereo_auto_ir.py :language: python diff --git a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_control.rst b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_control.rst index 2ee08c452..1accf8a60 100644 --- a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_control.rst +++ b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_control.rst @@ -45,7 +45,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/StereoComponent/stereo_control.py :language: python diff --git a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_encoded.rst b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_encoded.rst index cab07248c..d406f4ba4 100644 --- a/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_encoded.rst +++ b/depthai_sdk/docs/source/samples/StereoComponent/SDK_stereo_encoded.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/StereoComponent/stereo_encoded.py :language: python diff --git a/depthai_sdk/docs/source/samples/color_example.rst b/depthai_sdk/docs/source/samples/color_example.rst deleted file mode 100644 index 199a92a72..000000000 --- a/depthai_sdk/docs/source/samples/color_example.rst +++ /dev/null @@ -1,2 +0,0 @@ -Color camera example -===================== \ No newline at end of file diff --git a/depthai_sdk/docs/source/samples/mixed/sdk_api_interop.rst b/depthai_sdk/docs/source/samples/mixed/sdk_api_interop.rst index 94c96ff44..2d8030dc4 100644 --- a/depthai_sdk/docs/source/samples/mixed/sdk_api_interop.rst +++ b/depthai_sdk/docs/source/samples/mixed/sdk_api_interop.rst @@ -32,7 +32,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/mixed/api_interop.py :language: python diff --git a/depthai_sdk/docs/source/samples/mixed/sdk_car_tracking.rst b/depthai_sdk/docs/source/samples/mixed/sdk_car_tracking.rst index 91e7ca1ff..bda9ea2e0 100644 --- a/depthai_sdk/docs/source/samples/mixed/sdk_car_tracking.rst +++ b/depthai_sdk/docs/source/samples/mixed/sdk_car_tracking.rst @@ -30,7 +30,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/mixed/car_tracking.py :language: python diff --git a/depthai_sdk/docs/source/samples/mixed/sdk_collision_avoidance.rst b/depthai_sdk/docs/source/samples/mixed/sdk_collision_avoidance.rst index dbd5f5eb3..29709f38e 100644 --- a/depthai_sdk/docs/source/samples/mixed/sdk_collision_avoidance.rst +++ b/depthai_sdk/docs/source/samples/mixed/sdk_collision_avoidance.rst @@ -31,7 +31,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/mixed/collision_avoidance.py :language: python diff --git a/depthai_sdk/docs/source/samples/mixed/sdk_speed_calculation.rst b/depthai_sdk/docs/source/samples/mixed/sdk_speed_calculation.rst index 65fc004e7..e2987a961 100644 --- a/depthai_sdk/docs/source/samples/mixed/sdk_speed_calculation.rst +++ b/depthai_sdk/docs/source/samples/mixed/sdk_speed_calculation.rst @@ -1,16 +1,17 @@ Speed Calculation Preview ========================= -This example showcases the use of callback function inside the visualizer to log speed and draw tracking information. +This example showcases the use of callback function inside the visualizer to log speed and draw tracking information. + .. include:: /includes/blocking_behavior.rst - + Demo #### + .. image:: /_static/images/demos/sdk_speed_calculation.gif :alt: Speed Calculation Demo - Setup ##### @@ -22,8 +23,6 @@ Pipeline .. image:: /_static/images/pipelines/speed_calculation.png :alt: Pipeline graph - - Source Code ########### @@ -31,7 +30,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/mixed/speed_calculation.py diff --git a/depthai_sdk/docs/source/samples/mixed/sdk_switch_between_models.rst b/depthai_sdk/docs/source/samples/mixed/sdk_switch_between_models.rst index 60182f5e6..16ad1e570 100644 --- a/depthai_sdk/docs/source/samples/mixed/sdk_switch_between_models.rst +++ b/depthai_sdk/docs/source/samples/mixed/sdk_switch_between_models.rst @@ -25,7 +25,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/mixed/switch_between_models.py :language: python diff --git a/depthai_sdk/docs/source/samples/mixed/sdk_sync_multiple_outputs.rst b/depthai_sdk/docs/source/samples/mixed/sdk_sync_multiple_outputs.rst index 5c67ee081..d24fa89f9 100644 --- a/depthai_sdk/docs/source/samples/mixed/sdk_sync_multiple_outputs.rst +++ b/depthai_sdk/docs/source/samples/mixed/sdk_sync_multiple_outputs.rst @@ -32,7 +32,7 @@ Source Code .. tab:: Python - Also `available on GitHub `__ + Also `available on GitHub `__ .. literalinclude:: ../../../../examples/CameraComponent/sync_multiple_outputs.py :language: python diff --git a/depthai_sdk/docs/source/samples/recording/SDK_encode.rst b/depthai_sdk/docs/source/samples/recording/SDK_encode.rst index bc41b9da9..2f4d44002 100644 --- a/depthai_sdk/docs/source/samples/recording/SDK_encode.rst +++ b/depthai_sdk/docs/source/samples/recording/SDK_encode.rst @@ -26,7 +26,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. diff --git a/depthai_sdk/docs/source/samples/recording/SDK_encoder_preview.rst b/depthai_sdk/docs/source/samples/recording/SDK_encoder_preview.rst index ef5b43953..b6810c204 100644 --- a/depthai_sdk/docs/source/samples/recording/SDK_encoder_preview.rst +++ b/depthai_sdk/docs/source/samples/recording/SDK_encoder_preview.rst @@ -26,7 +26,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/recording/encoder_preview.py diff --git a/depthai_sdk/docs/source/samples/recording/SDK_mcap_record.rst b/depthai_sdk/docs/source/samples/recording/SDK_mcap_record.rst index b99fc5dca..84a3a1ef0 100644 --- a/depthai_sdk/docs/source/samples/recording/SDK_mcap_record.rst +++ b/depthai_sdk/docs/source/samples/recording/SDK_mcap_record.rst @@ -20,7 +20,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. diff --git a/depthai_sdk/docs/source/samples/recording/SDK_mcap_record_imu.rst b/depthai_sdk/docs/source/samples/recording/SDK_mcap_record_imu.rst index bd7c433c7..a1346c5f6 100644 --- a/depthai_sdk/docs/source/samples/recording/SDK_mcap_record_imu.rst +++ b/depthai_sdk/docs/source/samples/recording/SDK_mcap_record_imu.rst @@ -20,7 +20,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/recording/mcap_record_imu.py diff --git a/depthai_sdk/docs/source/samples/recording/SDK_recording_duration.rst b/depthai_sdk/docs/source/samples/recording/SDK_recording_duration.rst index c6ae2a377..8a57abdb2 100644 --- a/depthai_sdk/docs/source/samples/recording/SDK_recording_duration.rst +++ b/depthai_sdk/docs/source/samples/recording/SDK_recording_duration.rst @@ -25,7 +25,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. diff --git a/depthai_sdk/docs/source/samples/recording/SDK_rosbag_record.rst b/depthai_sdk/docs/source/samples/recording/SDK_rosbag_record.rst index 15ecae853..3ec326f29 100644 --- a/depthai_sdk/docs/source/samples/recording/SDK_rosbag_record.rst +++ b/depthai_sdk/docs/source/samples/recording/SDK_rosbag_record.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/recording/rosbag_record.py diff --git a/depthai_sdk/docs/source/samples/replay/SDK_counter.rst b/depthai_sdk/docs/source/samples/replay/SDK_counter.rst index e79575a60..ef55bf824 100644 --- a/depthai_sdk/docs/source/samples/replay/SDK_counter.rst +++ b/depthai_sdk/docs/source/samples/replay/SDK_counter.rst @@ -1,10 +1,17 @@ -People Counter on Video Replay -============================== +Object counting on images +========================= -This example shows how to run the people counter pipeline on a video file. +This example cycles through a folder of images and counts the number of objects (people in our case) in each image. It displays the count number on the top of the image. It cycles through +each image every 3 seconds, but you can change that with: + +.. code-block:: bash + + with OakCamera('path/to/folder') as oak: + oak.replay.set_fps(0.5) # For switching cycling through image every 2 seconds + # ... .. include:: /includes/blocking_behavior.rst - + Demo #### .. image:: /_static/images/demos/sdk_counter.gif @@ -30,7 +37,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/replay/counter.py :language: python diff --git a/depthai_sdk/docs/source/samples/replay/SDK_looped_replay.rst b/depthai_sdk/docs/source/samples/replay/SDK_looped_replay.rst index 69551aeb2..404dbce83 100644 --- a/depthai_sdk/docs/source/samples/replay/SDK_looped_replay.rst +++ b/depthai_sdk/docs/source/samples/replay/SDK_looped_replay.rst @@ -29,10 +29,10 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. - .. literalinclude:: ../../../../examples/replay/looped_replay.py + .. literalinclude:: ../../../../examples/replay/looped-replay.py :language: python :linenos: diff --git a/depthai_sdk/docs/source/samples/replay/SDK_people_tracker.rst b/depthai_sdk/docs/source/samples/replay/SDK_people_tracker.rst index 276e1f442..1f92389d9 100644 --- a/depthai_sdk/docs/source/samples/replay/SDK_people_tracker.rst +++ b/depthai_sdk/docs/source/samples/replay/SDK_people_tracker.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/replay/people-tracker.py diff --git a/depthai_sdk/docs/source/samples/replay/SDK_photo_download.rst b/depthai_sdk/docs/source/samples/replay/SDK_photo_download.rst index 9f01e9a3c..cc82f91b4 100644 --- a/depthai_sdk/docs/source/samples/replay/SDK_photo_download.rst +++ b/depthai_sdk/docs/source/samples/replay/SDK_photo_download.rst @@ -30,7 +30,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/replay/photo-download.py diff --git a/depthai_sdk/docs/source/samples/replay/SDK_youtube_download.rst b/depthai_sdk/docs/source/samples/replay/SDK_youtube_download.rst index 1e510dfc4..2942933d1 100644 --- a/depthai_sdk/docs/source/samples/replay/SDK_youtube_download.rst +++ b/depthai_sdk/docs/source/samples/replay/SDK_youtube_download.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/replay/youtube-download.py :language: python diff --git a/depthai_sdk/docs/source/samples/streaming/SDK_ros_publishing.rst b/depthai_sdk/docs/source/samples/streaming/SDK_ros_publishing.rst index aa2faa53e..36788b409 100644 --- a/depthai_sdk/docs/source/samples/streaming/SDK_ros_publishing.rst +++ b/depthai_sdk/docs/source/samples/streaming/SDK_ros_publishing.rst @@ -21,7 +21,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/streaming/ros_publishing.py :language: python diff --git a/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_action.rst b/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_action.rst index e6336fe06..4555479b2 100644 --- a/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_action.rst +++ b/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_action.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/trigger_action/custom_action.py :language: python diff --git a/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_trigger.rst b/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_trigger.rst index f5fb6aab5..fa2dcb385 100644 --- a/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_trigger.rst +++ b/depthai_sdk/docs/source/samples/trigger_action/SDK_custom_trigger.rst @@ -27,7 +27,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/trigger_action/custom_trigger.py :language: python diff --git a/depthai_sdk/docs/source/samples/trigger_action/SDK_person_record.rst b/depthai_sdk/docs/source/samples/trigger_action/SDK_person_record.rst index 7e3fd979d..d3b704064 100644 --- a/depthai_sdk/docs/source/samples/trigger_action/SDK_person_record.rst +++ b/depthai_sdk/docs/source/samples/trigger_action/SDK_person_record.rst @@ -26,7 +26,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/trigger_action/person_record.py :language: python diff --git a/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer.rst b/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer.rst index 98171ce31..91c8b159e 100644 --- a/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer.rst +++ b/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer.rst @@ -26,7 +26,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/visualizer/visualizer.py diff --git a/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer_callback.rst b/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer_callback.rst index db759ef24..fc407af43 100644 --- a/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer_callback.rst +++ b/depthai_sdk/docs/source/samples/visualizer/SDK_visualizer_callback.rst @@ -31,7 +31,7 @@ Source Code .. tab:: Python - Also `available on GitHub `_. + Also `available on GitHub `_. .. literalinclude:: ../../../../examples/visualizer/visualizer_callback.py :language: python diff --git a/depthai_sdk/docs/source/tutorials/code_samples.rst b/depthai_sdk/docs/source/tutorials/code_samples.rst index d7207dbe0..1364dc2d4 100644 --- a/depthai_sdk/docs/source/tutorials/code_samples.rst +++ b/depthai_sdk/docs/source/tutorials/code_samples.rst @@ -72,7 +72,7 @@ are presented with code. - :ref:`Stereo Recording` - Records disparity stream .. rubric:: Replay -- :ref:`People Counter on Video Replay` - Run people counter on a pre-saved video +- :ref:`Object counting on images` - Count number of objects on a folder of images (cycle through images every 3 sec) - :ref:`People Tracker on Video Replay` - Run people tracker on a pre-saved video - :ref:`Face Detection Inference on Downloaded Image` - Run face detection on a downloaded image - :ref:`Vehicle Detection on a Youtube Video` - Run vehicle detection on a Youtube video stream