From d47deaaca6e8dedba7b5e70c300ba41cd652855d Mon Sep 17 00:00:00 2001 From: Sebastian Golebiewski Date: Fri, 20 Jan 2023 10:26:17 +0100 Subject: [PATCH] fix formatting (#15174) fix formatting and links --- .../configurations-for-iei-card.md | 202 +++++++++++------- 1 file changed, 127 insertions(+), 75 deletions(-) diff --git a/docs/install_guides/configurations-for-iei-card.md b/docs/install_guides/configurations-for-iei-card.md index 467ea870341..e3e33fb07f1 100644 --- a/docs/install_guides/configurations-for-iei-card.md +++ b/docs/install_guides/configurations-for-iei-card.md @@ -1,134 +1,186 @@ # Configurations for IEI Mustang-V100-MX8-R10 Card {#openvino_docs_install_guides_movidius_setup_guide} -> **NOTE**: These steps are only required for **IEI Mustang-V100-MX8-R10** card. **IEI Mustang-V100-MX8-R11** card doesn't require any additional steps and it's completely configured using the [general guidance](configurations-for-ivad-vpu.md). +@sphinxdirective +.. note:: These steps are only required for **IEI Mustang-V100-MX8-R10** card. **IEI Mustang-V100-MX8-R11** card doesn't require any additional steps and it's completely configured using the :doc:`general guidance ` The IEI Mustang-V100-MX8 is an OEM version of the Intel® Vision Accelerator Design with Intel® Movidius™ VPUs. -This guide assumes you have installed the [Mustang-V100-MX8](https://download.ieiworld.com/) and OpenVINO™ Runtime. +This guide assumes you have installed the `Mustang-V100-MX8 `_ and OpenVINO™ Runtime. Instructions in this guide for configuring your accelerator include: -1. Installing the required IEI BSL reset software -2. Configuration settings for the `hddldaemon` service -> **NOTE**: This guide does not apply to Uzel cards. +1. Installing the required IEI BSL reset software +2. Configuration settings for the ``hddldaemon`` service + +.. note:: This guide does not apply to Uzel cards. + +@endsphinxdirective + ## Installing IEI Reset Software + +@sphinxdirective + Using the IEI Mustang-V100-MX8 requires downloading and installing the most current software for your system. -Visit the [IEI Download Center](https://download.ieiworld.com/) for the most current software and documentation. +Visit the `IEI Download Center `_ for the most current software and documentation. Search for **Mustang-V100-MX8**. Download the appropriate software for your system, extract the downloaded archive file, enter the newly created directory, and run the install script: On **Linux**: -- Run the `install.sh script` with `sudo`, or as `root`. -On **Windows**, do one of the following:
-- **GUI**: Double-click `install.bat` -- **CLI**: Open a console with administrator privileges, cd into the directory, and run `install.bat`. +- Run the ``install.sh script`` with ``sudo``, or as ``root``. + +On **Windows**, do one of the following: + +- **GUI**: Double-click ``install.bat`` +- **CLI**: Open a console with administrator privileges, cd into the directory, and run ``install.bat``. + +@endsphinxdirective + ## Configuring Mustang-V100-MX8 Service -The `hddldaemon` is a system service, a binary executable that is run to manage the computational workload on the board. It is a required abstraction layer that handles inference, graphics processing, and any type of computation that should be run on the video processing units (VPUs). Depending on the board configuration, there can be 8 or 16 VPUs. +@sphinxdirective + +The ``hddldaemon`` is a system service, a binary executable that is run to manage the computational workload on the board. It is a required abstraction layer that handles inference, graphics processing, and any type of computation that should be run on the video processing units (VPUs). Depending on the board configuration, there can be 8 or 16 VPUs. + +.. note:: Graphics and other specialized processing may require some custom development. + +@endsphinxdirective -> **NOTE**: Graphics and other specialized processing may require some custom development. ### Conventions Used in This Document -`` refers to the following default OpenVINO™ Runtime directories: -- **Linux:** - ``` - /opt/intel/openvino_2022/runtime - ``` -- **Windows:** -``` -C:\Program Files (x86)\IntelSWTools\openvino\runtime -``` +@sphinxdirective + +```` refers to the following default OpenVINO™ Runtime directories: + +- **Linux:** + +.. code-block:: + + /opt/intel/openvino_2022/runtime + +- **Windows:** + +.. code-block:: + + C:\Program Files (x86)\IntelSWTools\openvino\runtime + If you have installed OpenVINO™ in a different directory on your system, you will need to enter your unique directory path. +@endsphinxdirective + + ### Configuration File Location `\3rdparty\hddl\config\hddl_service.config` ### Service Configuration File Settings -Below are some possible configuration options. +@sphinxdirective + +Below are some possible configuration options. + +.. note:: After changing a configuration file, the ``hddldaemon`` must be restarted. + +@endsphinxdirective -> **NOTE**: After changing a configuration file, the `hddldaemon` must be restarted. #### Recommended Settings -`device_snapshot_mode` -Changes the output of the `hddldaemon` to display a table with individual VPU statistics. +@sphinxdirective -**Default Setting:** -`"device_snapshot_mode": "none"` +.. list-table:: + :header-rows: 1 -**Suggested Setting:** -`"device_snapshot_mode": "full"` - -**Supported Settings:** - - `none` (default) - - `base` - - `full` + * - Setting + - Default value + - Recommended value + - Supported values + - Description + * - ``device_snapshot_mode`` + - ``"none"`` + - ``"full"`` + - + - ``"none"`` (default) + - ``"base"`` + - ``"full"`` + - Changes the output of the ``hddldaemon`` to display a table with individual VPU statistics. + * - ``device_snapshot_style`` + - ``"table"`` + - ``"table"`` -`device_snapshot_style` + The ``table`` setting presents labels on the left for each column and is recommended as easier to read. + - + - ``"table"`` (default) + - ``"tape"`` -**Default Setting:** -`"device_snapshot_style": "table"` - -**Recommended Setting:** -`"device_snapshot_style": "table"` + The ``"tape"`` setting prints the labels in each column. -The `table` setting presents labels on the left for each column and is recommended as easier to read. -The `tape` setting prints the labels in each column. + - Sets the style for device snapshot. + * - ``user_group`` + - ``"users"`` -**Supported Settings:** -- `tape` -- `table` (default) + The ``hddldaemon`` may be restricted to a privileged group of users. -`user_group ` -Restricts the service to group members. + The appropriate group will vary according to the local system configuration. + - Recommended setting depends on your unique system configuration. + - Valid groups on the current system. -**Recommended setting depends on your unique system configuration.** - -**Default Setting** -`"user_group": "users"` - -The `hddldaemon` may be restricted to a privileged group of users. The appropriate group will vary according to the local system configuration. - -**Supported Settings:** -Valid groups on the current system. The `"users"` group is a default group that exists on Windows and most Linux distributions. + The ``"users"`` group is a default group that exists on Windows and most Linux distributions. + - Restricts the service to group members. -**Optional Recommended Settings:** +@endsphinxdirective -`"device_utilization" : "off"` -This setting displays the percent of time each VPU is in use. It appears in the `table` column when turned on, or if `"device_fps"` is turned on. -`"memory_usage" : "off"` -This setting reports the amount of memory being used by each VPU. +#### Optional Recommended Settings -`"max_cycle_switchout": 3` -Requires the squeeze scheduler. This setting might speed up performance significantly, depending on the app. +@sphinxdirective -> **NOTE**: This setting works in conjunction with: `max_task_number_switch_out`. +.. list-table:: + :header-rows: 1 -`"client_fps" : "off"` -This setting reports the total FPS for the dispatching hddl_service (which will have one or more clients per app). + * - Setting + - Recommended Value + - Description + * - ``device_utilization`` + - ``"off"`` + - This setting displays the percent of time each VPU is in use. It appears in the ``table`` column when turned on, or if ``device_fps`` is turned on. + * - ``memory_usage`` + - ``"off"`` + - This setting reports the amount of memory being used by each VPU. + * - ``max_cycle_switchout`` + - ``"3"`` + - Requires the squeeze scheduler. This setting might speed up performance significantly, depending on the app. -`debug_service` -`"debug_service": "false"` -(default: `"true"`) + Note that this setting works in conjunction with: ``max_task_number_switch_out``. + * - ``client_fps`` + - ``"off"`` + - This setting reports the total FPS for the dispatching "hddl_service" (which will have one or more clients per app). + * - ``debug_service`` + - ``"false"`` + - This setting defines whether to display service log information. + + The default value is ``"true"`` + +@endsphinxdirective ## Additional Resources -- [Intel Distribution of OpenVINO Toolkit home page](https://software.intel.com/en-us/openvino-toolkit) -- [Troubleshooting Guide](troubleshooting.md) -- [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs HAL Configuration Guide](/downloads/595850_Intel_Vision_Accelerator_Design_with_Intel_Movidius_VPUs-HAL Configuration Guide_rev1.3.pdf) -- [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs Workload Distribution User Guide](/downloads/613514_Intel Vision Accelerator Design with Intel Movidius VPUs Workload Distribution_UG_r0.9.pdf) -- [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs Scheduler User Guide](/downloads/613759_Intel Vision Accelerator Design with Intel Movidius VPUs Scheduler_UG_r0.9.pdf) -- [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs Errata](/downloads/Intel Vision Accelerator Design with Intel Movidius VPUs Errata.pdf) \ No newline at end of file +@sphinxdirective + +- `Intel Distribution of OpenVINO Toolkit home page `_ +- :doc:`Troubleshooting Guide ` +- `Intel® Vision Accelerator Design with Intel® Movidius™ VPUs HAL Configuration Guide `_ +- `Intel® Vision Accelerator Design with Intel® Movidius™ VPUs Workload Distribution User Guide `_ +- `Intel® Vision Accelerator Design with Intel® Movidius™ VPUs Scheduler User Guide `_ +- `Intel® Vision Accelerator Design with Intel® Movidius™ VPUs Errata `_ + +@endsphinxdirective