Skip to content

Commit bbef483

Browse files
cshilwantStaticRocket
authored andcommitted
style(edgeai): Switch to :file:
Switch to role-file [0] for all references of file names & directories in edgeai documentation. [0] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>
1 parent c51e4c5 commit bbef483

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

source/edgeai/configuration_file.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Configuring applications
66

77
The demo config file uses YAML format to define input sources, models, outputs
88
and finally the flows which defines how everything is connected. Config files
9-
for out-of-box demos are kept in ``edgeai-gst-apps/configs`` folder. The
9+
for out-of-box demos are kept in :file:`edgeai-gst-apps/configs` folder. The
1010
folder contains config files for all the use cases and also multi-input and
1111
multi-inference case. The folder also has a template YAML file
12-
``app_config_template.yaml`` which has detailed explanation of all the
12+
:file:`app_config_template.yaml` which has detailed explanation of all the
1313
parameters supported in the config file.
1414

1515
Config file is divided in 4 sections:
@@ -62,7 +62,7 @@ which are exposed as v4l2 devices. In Linux, there are many devices which are
6262
implemented as v4l2 devices. Not all of them will be camera devices. You need
6363
to make sure the correct device is configured for running the demo successfully.
6464

65-
``init_script.sh`` is ran as part of systemd, which detects all cameras connected
65+
:file:`init_script.sh` is ran as part of systemd, which detects all cameras connected
6666
and prints the detail like below in the console:
6767

6868
.. code-block:: bash
@@ -80,7 +80,7 @@ and prints the detail like below in the console:
8080
script can also be run manually later to get the camera details.
8181

8282
From the above log we can determine that 1 USB camera is connected
83-
(/dev/video-usb-cam0), and 1 CSI camera is connected (/dev/video-imx219-cam0) which is IMX219 raw
83+
(:file:`/dev/video-usb-cam0`), and 1 CSI camera is connected (:file:`/dev/video-imx219-cam0`) which is IMX219 raw
8484
sensor and needs ISP.
8585

8686
Using this method, you can configure correct device for camera capture in the
@@ -112,7 +112,7 @@ Video sources
112112
-------------
113113

114114
H.264 and H.265 encoded videos can be provided as input sources to the demos.
115-
Sample video files are provided under ``/opt/edgeai-test-data/videos/``
115+
Sample video files are provided under :file:`/opt/edgeai-test-data/videos/`
116116

117117
.. code-block:: yaml
118118
@@ -138,7 +138,7 @@ Image sources
138138
-------------
139139

140140
JPEG compressed images can be provided as inputs to the demos. A sample set of
141-
images are provided under ``/opt/edgeai-test-data/images``. The names of the
141+
images are provided under :file:`/opt/edgeai-test-data/images`. The names of the
142142
files are numbered sequentially and incrementally and the demo plays the files
143143
at the fps specified by the user.
144144

@@ -302,7 +302,7 @@ is 127.0.0.1.
302302
host: 127.0.0.1
303303
encoding: jpeg #(jpeg or h264)
304304
305-
A NodeJS server is provided under ``/opt/edgeai-gst-apps/scripts/remote_streaming``
305+
A NodeJS server is provided under :file:`/opt/edgeai-gst-apps/scripts/remote_streaming`
306306
which establishes a node server on the target and listens to the udp port (8081)
307307
on localhost (127.0.0.1) and can be used to view the frames remotely.
308308

@@ -345,7 +345,7 @@ GStreamer plugins
345345
The edgeai-gst-apps essentially constructs GStreamer pipelines for dataflow.
346346
This pipeline is constructed optimally and dynamically based on a pool of
347347
specific plugins available on the platform. The defined pool of plugins for
348-
different platform can be found in ``edgeai-gst-apps/configs/gst_plugin_maps.yaml``
348+
different platform can be found in :file:`edgeai-gst-apps/configs/gst_plugin_maps.yaml`
349349
file.
350350

351351
This file contains the plugin used for certain task and the property of plugin

source/edgeai/docker_environment.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ access camera, display and other hardware accelerators the SoC has to offer.
7777
.. note::
7878

7979
After building and running the docker container, one needs to run
80-
``setup_script.sh`` before running any of the demo applications.
80+
:file:`setup_script.sh` before running any of the demo applications.
8181
This is required to rebuild all components against the shared libraries
8282
of docker, same should be done when switching back to Yocto
8383

@@ -98,7 +98,7 @@ changes it is good to save the changes on top of the existing Docker image.
9898
When re-running the Docker image, the local changes can be restored.
9999

100100
Following commands show how to save the changes made to the last container.
101-
Note that this is already done automatically by ``docker_run.sh`` when you exit
101+
Note that this is already done automatically by :file:`docker_run.sh` when you exit
102102
the container.
103103

104104
.. code-block:: bash

source/edgeai/inference_models.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Use the **Model Downloader Tool** in the SDK to download more models on target a
6565
6666
The script will launch an interactive menu showing the list of available,
6767
pre-imported models for download. The downloaded models will be placed
68-
under ``/opt/model_zoo/`` directory
68+
under :file:`/opt/model_zoo/` directory
6969

7070
.. figure:: ../images/edgeai/model_downloader.png
7171
:align: center

source/edgeai/sample_apps.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ custom input (Camera/VideoFile/Image) and a custom model available in the
3636
filesystem. This will automatically construct a GStreamer pipeline with required
3737
elements and launch the application.
3838

39-
- For a model to pop up on GUI, it needs to be present under ``/opt/model_zoo/``
40-
- For a videofile to pop up on GUI, the videos needs to be present under ``/opt/edgeai-test-data/videos/``
41-
- For an image to pop up on GUI, the images needs to be present under ``/opt/edgeai-test-data/iamges/``
39+
- For a model to pop up on GUI, it needs to be present under :file:`/opt/model_zoo/`
40+
- For a videofile to pop up on GUI, the videos needs to be present under :file:`/opt/edgeai-test-data/videos/`
41+
- For an image to pop up on GUI, the images needs to be present under :file:`/opt/edgeai-test-data/images/`
4242

4343

4444
.. note::
@@ -87,8 +87,8 @@ configured using a YAML file. Details on configuration file parameters can
8787
be found in :ref:`pub_edgeai_configuration`
8888

8989
Sample configuration files for out of the box demos can be found in
90-
``edgeai-gst-apps/configs`` this folder also contains a template config file
91-
which has brief info on each configurable parameter ``edgeai-gst-apps/configs/app_config_template.yaml``
90+
:file:`edgeai-gst-apps/configs` this folder also contains a template config file
91+
which has brief info on each configurable parameter :file:`edgeai-gst-apps/configs/app_config_template.yaml`
9292

9393
Here is how a Python based image classification demo can be run,
9494

0 commit comments

Comments
 (0)