Skip to content

Commit 5880ef4

Browse files
quentonhGitHub Enterprise
authored andcommitted
Updates to 3.5 documentation post release (#1158)
* Post 3.5 launch fixes * Integrate filtered HTML Model Zoo
1 parent 98f972d commit 5880ef4

File tree

290 files changed

+2128
-19910
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

290 files changed

+2128
-19910
lines changed

docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 69378c3e4e70920506b6c832d7ea1ffb
3+
config: e8809926e287b8b0d9656262fa0b07bc
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.

docs/_images/VEK280_Top_img.png

109 KB
Loading

docs/_sources/docs/install/China_Ubuntu_servers.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Vitis |trade| AI Docker images leverage Ubuntu 20.04. In your Ubuntu installatio
99
1010
deb http://us.archive.ubuntu.com/ubuntu/ focal universe
1111
12-
You can see that the hostname “archive.ubuntu.com” resolves to servers located within the United States. When building the Vitis AI Docker image, whether for `CPU-only <https://github.com/Xilinx/Vitis-AI/blob/master/docker/dockerfiles/vitis-ai-cpu.Dockerfile>`__ or `GPU <https://github.com/Xilinx/Vitis-AI/blob/master/docker/dockerfiles/vitis-ai-gpu.Dockerfile>`__ applications Docker will attempt to pull from US servers. As a result, users accessing from China will generally experience slow download speeds.
12+
You can see that the hostname “archive.ubuntu.com” resolves to servers located within the United States. When building the Vitis AI Docker image, whether for CPU-only or GPU accelerated containers Docker will attempt to pull from US servers. As a result, users accessing from China will generally experience slow download speeds.
1313

1414
Prior to building the Vitis AI Docker image it is recommended that you modify **/etc/apt/sources.list** and the vitis-ai-gpu.Dockerfile.
1515

docs/_sources/docs/quickstart/v70.rst.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Quick Start Guide for Alveo V70
33
###############################
44

5-
The AMD **DPUCV2DX8G** for the Alveo |trade| V70 is a configurable computation engine dedicated to convolutional neural networks. It supports a highly optimized instruction set, enabling the deployment of most convolutional neural networks. The following instructions will help you to install the software and packages required to support V70.
5+
The AMD **DPUCV2DX8G** for the Alveo |trade| V70 is a configurable computation engine dedicated to convolutional neural networks. It supports a highly optimized instruction set, enabling the deployment of most convolutional neural networks. The following instructions will help you install the software and packages required to support V70.
66

77
.. image:: ../reference/images/V70.PNG
88
:width: 1300
@@ -114,7 +114,7 @@ From inside the docker container, execute one of the following commands to set t
114114
Vitis-AI Model Zoo
115115
==================
116116

117-
You can now select a model from the Vitis AI Model Zoo `Vitis AI Model Zoo <../workflow-model-zoo.html>`__. Navigate to the `model-list subdirectory <https://github.com/Xilinx/Vitis-AI/tree/master/model_zoo/model-list>`__ and select the model that you wish to test. For each model, a YAML file provides key details of the model. In the YAML file there are separate hyperlinks to download the model for each supported target. Choose the correct link for your target platform and download the model.
117+
You can now select a model from the `Vitis AI Model Zoo <../workflow-model-zoo.html>`__. Navigate to the `model-list subdirectory <https://github.com/Xilinx/Vitis-AI/tree/master/model_zoo/model-list>`__ and select the model that you wish to test. For each model, a YAML file provides key details of the model. In the YAML file there are separate hyperlinks to download the model for each supported target. Choose the correct link for your target platform and download the model.
118118

119119
- Take the ResNet50 model as an example.
120120

@@ -144,7 +144,7 @@ Run the Vitis AI Examples
144144

145145
.. code-block:: Bash
146146
147-
[Docker] $ tar -xzvf vitis_ai_runtime_r3.5.0_image_video.tar.gz -C /w/examples/vai_runtime
147+
[Docker] $ tar -xzvf vitis_ai_runtime_r3.5.0_image_video.tar.gz -C /workspace/examples/vai_runtime
148148
149149
3. Navigate to the example directory.
150150

@@ -157,6 +157,7 @@ Run the Vitis AI Examples
157157

158158
.. code-block:: Bash
159159
160+
[Docker] $ sudo chmod u+r+x build.sh
160161
[Docker] $ bash -x build.sh
161162
162163
5. Run the example.
@@ -412,7 +413,7 @@ contain test images and videos that can be leveraged to evaluate our quantized m
412413

413414
.. code-block:: Bash
414415
415-
[Docker] $ ./test_jpeg_classification resnet18_pt /workspace/examples/vai_library/samples/classification/images/002.jpg
416+
[Docker] $ ./test_jpeg_classification resnet18_pt /workspace/examples/vai_library/samples/classification/images/001.jpg
416417
417418
If you wish to do so, you can review the `result.jpg` file. OpenCV function calls have been used to overlay the predictions.
418419

docs/_sources/docs/quickstart/vek280.rst.txt

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
Quick Start Guide for Versal |trade| AI Edge VEK280
33
###################################################
44

5-
The AMD **DPUCV2DX** for Versal |trade| AI Edge is a configurable computation engine dedicated to convolutional neural networks. It supports a highly optimized instruction set, enabling the deployment of most convolutional neural networks. The following instructions will help you to install the software and packages required to support VEK280.
5+
The AMD **DPUCV2DX8G** for Versal |trade| AI Edge is a configurable computation engine dedicated to convolutional neural networks. It supports a highly optimized instruction set, enabling the deployment of most convolutional neural networks. The following instructions will help you to install the software and packages required to support VEK280.
6+
7+
.. image:: ../reference/images/VEK280_Top_img.png
8+
:width: 400
9+
:align: center
10+
611

712

813
*************
@@ -28,7 +33,7 @@ WSL
2833
This is an optional step intended to enable Windows users to evaluate Vitis |trade| AI.
2934

3035

31-
Although this is not a fully tested and supported flow, in most cases users will be able to execute this basic tutorial on Windows. The Windows Subsystem for Linux (WSL) can be installed from the command line. Open a Powershell prompt as an Administrator and execute the following command:
36+
Although this is not a fully supported flow, in most cases users will be able to execute this basic tutorial on Windows. The Windows Subsystem for Linux (WSL) can be installed from the command line. Open a Powershell prompt as an Administrator and execute the following command:
3237

3338
.. code-block:: Bash
3439
@@ -138,6 +143,7 @@ Cross compile the ``resnet50_pt`` example.
138143
.. code-block:: Bash
139144
140145
[Docker] $ cd examples/vai_runtime/resnet50_pt
146+
[Docker] $ sudo chmod u+r+x build.sh
141147
[Docker] $ bash –x build.sh
142148
143149
If the compilation process does not report an error and the executable file ``resnet50_pt`` is generated, then the host environment is installed correctly. If an error is reported, double-check that you executed the ``source ~/petalinux....`` command.
@@ -216,7 +222,7 @@ If you are using a point-to-point connection or DHCP is not available, you can m
216222
Vitis-AI Model Zoo
217223
==================
218224

219-
You can now select a model from the Vitis AI Model Zoo `Vitis AI Model Zoo <../workflow-model-zoo.html>`__. Navigate to the `model-list subdirectory <https://github.com/Xilinx/Vitis-AI/tree/master/model_zoo/model-list>`__ and select the model that you wish to test. For each model, a YAML file provides key details of the model. In the YAML file there are separate hyperlinks to download the model for each supported target. Choose the correct link for your target platform and download the model.
225+
You can now select a model from the `Vitis AI Model Zoo <../workflow-model-zoo.html>`__. Navigate to the `model-list subdirectory <https://github.com/Xilinx/Vitis-AI/tree/master/model_zoo/model-list>`__ and select the model that you wish to test. For each model, a YAML file provides key details of the model. In the YAML file there are separate hyperlinks to download the model for each supported target. Choose the correct link for your target platform and download the model.
220226

221227
1. Take the ResNet50 model as an example.
222228

@@ -453,7 +459,7 @@ The Vitis AI Compiler compiles the graph operators as a set of micro-coded instr
453459
.. code-block:: Bash
454460
455461
[Docker] $ cd /workspace/resnet18
456-
[Docker] $ vai_c_xir -x quantize_result/ResNet_int.xmodel -a /opt/vitis_ai/compiler/arch/DPUCV2DX/VEK280/arch.json -o resnet18_pt -n resnet18_pt
462+
[Docker] $ vai_c_xir -x quantize_result/ResNet_int.xmodel -a /opt/vitis_ai/compiler/arch/DPUCV2DX8G/VEK280/arch.json -o resnet18_pt -n resnet18_pt
457463
458464
- If compilation is successful, the ``resnet18_pt.xmodel`` file should be generated according to the specified DPU architecture.
459465

@@ -527,6 +533,7 @@ contain test images and videos that can be leveraged to evaluate our quantized m
527533
.. code-block:: Bash
528534
529535
[Target] $ cd ~/Vitis-AI/examples/vai_library/samples/classification
536+
[Target] $ chmod u+r+x build.sh
530537
[Target] $ ./build.sh
531538
532539
4. Execute the single-image test application.
@@ -537,7 +544,7 @@ contain test images and videos that can be leveraged to evaluate our quantized m
537544
538545
If you wish to do so, you can copy the `result.jpg` file back to your host and review the output. OpenCV function calls have been used to overlay the predictions.
539546

540-
5. To run the video example, run the following command. To keep this simple we will use one of the Vitis AI video samples, but you should scp your own video clip to the target (webm / raw formats).
547+
5. To run the video example, run the following command. To keep this simple we will use one of the Vitis AI video samples, but users should scp their own video clip to the target in a webm or raw format.
541548

542549
.. code-block:: Bash
543550

docs/_sources/docs/reference/release_notes.rst.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,14 @@ TensorFlow 1 CNN Quantizer
8181
- Support for setting the opset version in exporting onnx format.
8282

8383
Bug Fixed:
84-
1. Fixed a bug where the AddV2 operation is misunderstood as a BiasAdd.
84+
1. Fixed a bug where the AddV2 operation is misinterpreted as a BiasAdd.
8585

8686
Compiler
8787
--------
88-
- Release notes to be announced ASAP
88+
- New operators supported: Broadcast add/mul, Bilinear downsample, Trilinear downsample, Group conv2d, Strided-slice
89+
- Performance improved on XV2DPU
90+
- Error message improved
91+
- Compilation time speed up
8992

9093
PyTorch Optimizer
9194
-----------------
@@ -124,7 +127,7 @@ Library
124127

125128
Model Inspector
126129
---------------
127-
- Release notes to be announced ASAP
130+
- Added support for DPUCV2DX8G
128131

129132
Profiler
130133
--------

docs/_sources/docs/reference/version_compatibility.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Zynq |trade| Ultrascale+ |trade|
8484
- 5.15
8585

8686
* - v2.0
87-
- 3.5
87+
- 3.4
8888
- Vivado / Vitis / PetaLinux 2021.2
8989
- 5.10
9090

docs/_sources/docs/workflow-model-development.rst.txt

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In the early phases of development, it is highly recommended that the developer
1717

1818
For more information on the Model Inspector, see the following resources:
1919

20-
- When you are ready to get started with the Vitis AI Model Inspector, refer to the examples provided for both `PyTorch <https://github.com/Xilinx/Vitis-AI/tree/v3.5/examples/vai_quantizer/pytorch/inspector_tutorial.ipynb>`__ and `TensorFlow <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_tensorflow2.x/README.md#inspecting-vai_q_tensorflow2>`__.
20+
- When you are ready to get started with the Vitis AI Model Inspector, refer to the examples provided for both `PyTorch <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_pytorch/example/jupyter_notebook/inspector/inspector_tutorial.ipynb>`__ and `TensorFlow <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_tensorflow2.x/README.md#inspecting-vai_q_tensorflow2>`__.
2121

2222
- If your graph uses operators that are not natively supported by your specific DPU target, see the :ref:`Operator Support <operator-support>` section.
2323

@@ -129,13 +129,10 @@ Quantization Related Resources
129129

130130
- For additional details on the Vitis AI Quantizer, refer the "Quantizing the Model" chapter in the `Vitis AI User Guide <https://docs.xilinx.com/access/sources/dita/map?isLatest=true&ft:locale=en-US&url=ug1414-vitis-ai>`__.
131131

132-
- TensorFlow 2.x examples are available as follows:
133-
- `TF2 Post-Training Quantization <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_tensorflow2.x/tensorflow_model_optimization/g3doc/guide/quantization/post_training.md>`__
134-
- `TF2 Quantization Aware Training <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_tensorflow2.x/tensorflow_model_optimization/g3doc/guide/quantization/training.md>`__
132+
- TensorFlow 2.x examples are available `here <https://github.com/Xilinx/Vitis-AI/tree/v3.5/examples/vai_quantizer/tensorflow2x>`__
133+
134+
- PyTorch examples are available `here <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_pytorch/example>`__
135135

136-
- PyTorch examples are available as follows:
137-
- `PT Post-Training Quantization <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_pytorch/example/resnet18_quant.py>`__
138-
- `PT Quantization Aware Training <https://github.com/Xilinx/Vitis-AI/tree/v3.5/src/vai_quantizer/vai_q_pytorch/example/resnet18_qat.py>`__
139136

140137
.. _model-compilation:
141138

docs/_sources/docs/workflow-model-zoo.rst.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,16 @@ All the models in the Model Zoo are deployed on AMD adaptable hardware with `Vit
1818

1919
To make the job of using the Model Zoo a little easier, we have provided a downloadable spreadsheet and an online table that incorporates key data about the Model Zoo models. The spreadsheet and tables include comprehensive information about all models, including links to the original papers and datasets, source framework, input size, computational cost (GOPs), and float and quantized accuracy. **You can download the spreadsheet** :download:`here <reference/ModelZoo_Github.xlsx>`.
2020

21+
.. The below is functional (remove the .. comment on the second line) but has formatting issues that are currently unresolved.
22+
.. raw:: html
23+
.. :file: reference/ModelZoo_Github.htm
24+
25+
.. For now we will just do this:
2126
.. raw:: html
2227

2328
<a href="reference/ModelZoo_Github_web.htm"><h4>Click here to view the Model Zoo Details & Performance table online.</h4></a><br><br>
2429

25-
.. note:: Please note that if the models are marked as "Non-Commercial Use Only", users must comply with this `AMD license agreement <https://github.com/Xilinx/Vitis-AI/blob/master/model_zoo/Xilinx-license-agreement-for-non-commercial-models.md>`__
30+
.. note:: Please note that if the models are marked as "Non-Commercial Use Only", users must comply with this `AMD license agreement <https://github.com/Xilinx/Vitis-AI/blob/master/model_zoo/AMD-license-agreement-for-non-commercial-models.md>`__
2631

2732

2833
.. note:: The model performance benchmarks listed in these tables are verified using Vitis AI v3.5 and Vitis AI Library v3.5. For each platform, specific DPU configurations are used and highlighted in the table's header. Free download of Vitis AI and Vitis AI Library from `Vitis AI Github <https://github.com/Xilinx/Vitis-AI>`__ and `Vitis AI Library Github <https://github.com/Xilinx/Vitis-AI/tree/v3.5/examples/vai_library>`__.

0 commit comments

Comments
 (0)