Skip to content

Commit 7737bf1

Browse files
committed
fix(Edge_AI_Gallery_User_Guide): Handle miscellaneous fixes w.r.t sphinx
* This commit handles following fixes related to sphinx, - Switch to role-file [0] - Add 1 new line between the content & note directive as per [1] - Switch to code directive [2] [0] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file [1] - https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#indentation-and-whitespace [2] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>
1 parent 33282a5 commit 7737bf1

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

source/linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide.rst

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ The edge AI gallery launches on Linux startup. Follow the below instructions to
7474
7575
5. Select the 4 options as described above and click on ``Start`` to generate and start the pipeline.
7676

77-
.. note:: As the note suggests, it might take a while for custom pipeline to start.
77+
.. note::
78+
79+
As the note suggests, it might take a while for custom pipeline to start.
7880

7981
.. Image:: /images/am62a_edge_ai_gallery_custom.jpg
8082
:width: 407
@@ -86,7 +88,9 @@ The edge AI gallery launches on Linux startup. Follow the below instructions to
8688

8789
7. For ease of use, the IP addr of the device is displayed at the bottom right when Network is connected.
8890

89-
.. note:: The IP addr is polled only for the first 100 seconds after the application has started.
91+
.. note::
92+
93+
The IP addr is polled only for the first 100 seconds after the application has started.
9094

9195
8. To close the application and go to the Wallpaper screen, use the close button on the top right corner.
9296

@@ -99,32 +103,34 @@ The edge AI gallery launches on Linux startup. Follow the below instructions to
99103

100104
9. To add new images, videos and models, you should add them in the below directories respectively
101105

102-
- Images - /opt/edgeai-test-data/images/
106+
- Images - :file:`/opt/edgeai-test-data/images/`
103107

104-
- Videos - /opt/edgeai-test-data/videos/
108+
- Videos - :file:`/opt/edgeai-test-data/videos/`
105109

106-
- Models - /opt/model_zoo/
110+
- Models - :file:`/opt/model_zoo/`
107111

108112

109113
10. To change the videos in the prebuilt pipelines used for ``Image Classification``, ``Object Detection``, ``Semantic Segmentation`` & ``Multi Channel``, you can replace the video files :file:`oob-gui-video*.h264` under :file:`/opt/oob-demo-assets/`.
110114

111115
11. To relaunch the application, you should run
112116

113-
::
117+
.. code:: console
114118
115-
/etc/init.d/edgeai-launcher.sh start
119+
/etc/init.d/edgeai-launcher.sh start
116120
117121
12. And to stop the application again, you should run
118122

119-
::
123+
.. code:: console
120124
121-
/etc/init.d/edgeai-launcher.sh stop
125+
/etc/init.d/edgeai-launcher.sh stop
122126
123127
.. ifconfig:: CONFIG_part_family in ('AM62AX_family')
124128

125129
13. To add new models to the ``Model`` dropdown list in Custom popup menu, Add the names of the models in :file:`/opt/oob-demo-assets/allowedModels.txt`.
126130

127-
.. note:: For the above changes to take affect, close and relaunch the application.
131+
.. note::
132+
133+
For the above changes to take affect, close and relaunch the application.
128134

129135
14. For more information on edge AI software stack, refer `Edge AI Documentation <https://software-dl.ti.com/processor-sdk-linux/esd/AM62AX/11_01_07_05/exports/docs/edgeai/sdk_overview.html>`_
130136

@@ -172,7 +178,7 @@ Finally, run:
172178
cmake -B build -S .
173179
make -C build
174180
175-
The compiled binary should be ``build/edgeai-gui-app``.
181+
The compiled binary should be :file:`build/edgeai-gui-app`.
176182

177183
Copy the compiled binary to the :file:`/usr/bin` of the target:
178184

0 commit comments

Comments
 (0)