Skip to content

Commit 7406ed7

Browse files
quentonhGitHub Enterprise
authored andcommitted
Correct quickstart docker image name (#1165)
* Post 3.5 launch fixes * Integrate filtered HTML Model Zoo * Update VE2302 lounge link, update Quickstarts * Fix whitespace in make_gh_pages.bat * Remove AKS due to incompatible targets * Correct Quickstart img/vid paths and fix V70 Docker setup note * Update make_gh_pages * Update V70 Quickstart deployment step 1 * Automate gh-pages html build date in conf.py * Automate gh-pages html build date in conf.py * Fix make_gh_pages whitespace
1 parent bbd4583 commit 7406ed7

File tree

331 files changed

+1633
-64145
lines changed

Some content is hidden

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

331 files changed

+1633
-64145
lines changed

board_setup/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
The Vitis-AI repository provides pre-built board images that can be leveraged by users who wish to test-drive the Vitis AI workflow, run examples and evaluate models from the Model Zoo. This directory provides the necessary scripts and files that will enable usage of these targets.
1111

12-
As of the 3.5 release of Vitis AI, the target setup documentation has migrated to Github.IO and is integrated into the Quickstart tutorials. **[PLEASE ACCESS THE LATEST QUICKSTART DOCUMENTATION ONLINE](https://xilinx.github.io/Vitis-AI/docs)** or **[OPEN THE OFFLINE DOCUMENTATION IN YOUR BROWSER](../docs/docs/index.html)**.
12+
As of the 3.5 release of Vitis AI, the target setup documentation has migrated to Github.IO and is integrated into the Quickstart tutorials. **[PLEASE ACCESS THE LATEST QUICKSTART DOCUMENTATION ONLINE](https://xilinx.github.io/Vitis-AI)** or **[OPEN THE OFFLINE DOCUMENTATION IN YOUR BROWSER](../docs/docs/index.html)**.
1313

1414

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: e8809926e287b8b0d9656262fa0b07bc
3+
config: 1de2b2f9b235f1525cca77dddc2685a5
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,8 @@ From inside the docker container, execute one of the following commands to set t
109109
.. code-block:: Bash
110110
111111
[Docker] $ source /workspace/board_setup/v70/setup.sh DPUCV2DX8G_v70
112-
112+
113+
.. note:: You will need to execute this script each time you re-enter the Docker container.
113114

114115
Vitis-AI Model Zoo
115116
==================
@@ -231,18 +232,19 @@ floating-point model as an input and performs pre-processing (folds batchnorms a
231232
.. code-block:: Bash
232233
233234
[Host] $ cd ..
234-
[Host] ./docker_run.sh vitis-ai-pytorch-cpu:latest
235+
[Host] ./docker_run.sh xilinx/vitis-ai-pytorch-cpu:latest
235236
236237
* Note that when you start Docker appropriate as shown above, your ``/workspace`` folder will correspond to ``/Vitis-AI`` and your initial path in Docker will be ``/workspace``. If you inspect ``docker_run.sh`` you can see that the -v option is leveraged which links the Docker file system to your Host file system. Verify that you see the created ``/resnet18`` subfolder in your workspace:
237238

238239
.. code-block:: Bash
239240
240241
[Docker] $ ls
241242
242-
4. Download the pre-trained resnet18 model from PyTorch to the docker environment and store it in the ``model`` folder . This is the floating point (FP32) model that will be quantized to INT8 precision for deployment on the target.
243+
4. Next, download the pre-trained resnet18 model from PyTorch to the docker environment and store it in the ``model`` folder . This is the floating point (FP32) model that will be quantized to INT8 precision for deployment on the target. Also, since you have re-entered the Docker container, you need to re-run the setup script.
243244

244245
.. code-block:: Bash
245246
247+
[Docker] $ source /workspace/board_setup/v70/setup.sh DPUCV2DX8G_v70
246248
[Docker] $ cd resnet18/model
247249
[Docker] $ wget https://download.pytorch.org/models/resnet18-5c106cde.pth -O resnet18.pth
248250
@@ -381,7 +383,7 @@ The Vitis AI Compiler compiles the graph operators as a set of micro-coded instr
381383
Model Deployment
382384
================
383385

384-
1. Locate the ``resnet18_pt`` folder ``/usr/share/vitis_ai_library/models/`` folder along with the other Viitis AI model examples.
386+
1. Copy the ``resnet18_pt`` folder into the ``/usr/share/vitis_ai_library/models/`` directory. This will locate your compiled model in the default Vitis AI Library example model directory, alongside the other Vitis AI example models. Our purpose in doing this is to simplify the commands that follow, in which we will execute the Vitis AI Library samples with our model.
385387

386388
2. The `vitis_ai_library_r3.5.0_images.tar.gz <https://www.xilinx.com/bin/public/openDownload?filename=vitis_ai_library_r3.5.0_images.tar.gz>`__ and `vitis_ai_library_r3.5.0_video.tar.gz <https://www.xilinx.com/bin/public/openDownload?filename=vitis_ai_library_r3.5.0_video.tar.gz>`__ packages
387389
contain test images and videos that can be leveraged to evaluate our quantized model and other pre-built Vitis-AI Library examples.
@@ -413,15 +415,15 @@ contain test images and videos that can be leveraged to evaluate our quantized m
413415

414416
.. code-block:: Bash
415417
416-
[Docker] $ ./test_jpeg_classification resnet18_pt /workspace/examples/vai_library/samples/classification/images/001.jpg
418+
[Docker] $ ./test_jpeg_classification resnet18_pt /workspace/examples/vai_library/samples/classification/images/001.JPEG
417419
418420
If you wish to do so, you can review the `result.jpg` file. OpenCV function calls have been used to overlay the predictions.
419421

420422
5. To run the video example, run the following command:
421423

422424
.. code-block:: Bash
423425
424-
[Docker] $ ./test_video_classification resnet18_pt /workspace/examples/vai_library/apps/pose_960_540.avi -t 8
426+
[Docker] $ ./test_video_classification resnet18_pt /workspace/examples/vai_library/apps/seg_and_pose_detect/pose_960_540.avi -t 8
425427
426428
7. The output should be as follows:
427429

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ floating-point model as an input and performs pre-processing (folds batchnorms a
345345
.. code-block:: Bash
346346
347347
[Host] $ cd ..
348-
[Host] ./docker_run.sh vitis-ai-pytorch-cpu:latest
348+
[Host] ./docker_run.sh xilinx/vitis-ai-pytorch-cpu:latest
349349
350350
.. note:: When you start Docker as shown earlier, your ``/workspace`` folder will correspond to ``/Vitis-AI`` and your initial path in Docker will be ``/workspace``. If you inspect ``docker_run.sh`` you can see that the -v option is leveraged which links the Docker file system to your Host file system. Verify that you see the created ``/resnet18`` subfolder in your workspace:
351351

@@ -500,7 +500,7 @@ Model Deployment
500500
501501
[Docker] $ scp -r resnet18_pt root@[TARGET_IP_ADDRESS]:/usr/share/vitis_ai_library/models/
502502
503-
* The model will be located under the ``/usr/share/vitis_ai_library/models/`` folder along with the other Viitis-AI model examples.
503+
* The model will be located under the ``/usr/share/vitis_ai_library/models/`` folder along with the other Vitis-AI model examples.
504504

505505

506506
2. The `vitis_ai_library_r3.5.0_images.tar.gz <https://www.xilinx.com/bin/public/openDownload?filename=vitis_ai_library_r3.5.0_images.tar.gz>`__ and `vitis_ai_library_r3.5.0_video.tar.gz <https://www.xilinx.com/bin/public/openDownload?filename=vitis_ai_library_r3.5.0_video.tar.gz>`__ packages
@@ -548,7 +548,7 @@ If you wish to do so, you can copy the `result.jpg` file back to your host and r
548548

549549
.. code-block:: Bash
550550
551-
[Target] $ ./test_video_classification resnet18_pt ~/Vitis-AI/examples/vai_library/apps/pose_960_540.avi -t 8
551+
[Target] $ ./test_video_classification resnet18_pt ~/Vitis-AI/examples/vai_library/apps/seg_and_pose_detect/pose_960_540.avi -t 8
552552
553553
6. Users can run real time inference using a USB web camera connected to the target with the command below:
554554

docs/_sources/docs/ref_design_docs/README_DPUCV2DX8G.rst.txt

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
VEK280 DPUCV2DX8G Reference Design
24
==================================
35

@@ -165,7 +167,15 @@ is set as shown below.
165167

166168
**Step1:** Build VEK280 platform
167169

168-
First, build the VEK280 platform in the folder `$TRD_HOME/vek280_platform`, following the instructions in `$TRD_HOME/vek280_platform/README.md`.
170+
First, build the VEK280 platform in the folder `$TRD_HOME/vek280_platform`, more details refer to the instructions in `$TRD_HOME/vek280_platform/README.md`.
171+
172+
::
173+
174+
% source <Vitis_install_path>/Vitis/2023.1/settings64.sh
175+
176+
% source <PetaLinux_install_path>/settings.sh
177+
178+
% make all
169179

170180
**Step2:** Setup the environment for building the DPUCV2DX8G IP and
171181
kernel
@@ -448,6 +458,11 @@ Package the RTL kernel as XO file. Then modify 2 files:
448458

449459
set_param place.preplaceNOC true
450460

461+
5) If your OS is Ubuntu, during AIE compilation step, you may get the error
462+
like "[AIE ERROR] XAieSim_GetStackRange():522: Invalid Map file, 2: No
463+
such file or directory", the reason should be that your Ubuntu does not
464+
install the "rename" function, you can install it manually.
465+
451466
.. raw:: html
452467

453468
<!--
@@ -472,4 +487,4 @@ Package the RTL kernel as XO file. Then modify 2 files:
472487
.. |trade| unicode:: U+02122 .. TRADEMARK SIGN
473488
:ltrim:
474489
.. |reg| unicode:: U+000AE .. REGISTERED TRADEMARK SIGN
475-
:ltrim:
490+
:ltrim:

docs/_sources/docs/reference/faq.rst.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ With the release of the Vitis AI IDE, more than 120 models are released in the V
7474
What Xilinx Target Device Families and Platforms does Vitis AI Support?
7575
-----------------------------------------------------------------------
7676

77-
Vitis AI DPUs are available for both Zynq Ultrascale+ MPSoC as well as Versal Edge and Core chip-down designs. The Kria K26 SOM is supported as a production-ready Edge platform, and Alveo accelerator cards are supported for cloud applications.
77+
Vitis AI DPUs are available for both Zynq Ultrascale+ MPSoC as well as Versal Edge and Core chip-down designs. The Kria |trade| K26 SOM is supported as a production-ready Edge platform, and Alveo |trade| accelerator cards are supported for cloud applications.
7878

7979
What does the Vitis AI Library provide?
8080
---------------------------------------
@@ -172,4 +172,10 @@ In the past, developers have ported the DPUCZ reference design (formerly known a
172172
What is the specific AI accelerator that AMD Xilinx provides for Zynq™ Ultrascale+? Is it a systolic array?
173173
------------------------------------------------------------------------------------------------------------
174174

175-
The DPUCZ IP that is provided with the Vitis AI IDE is the specialized accelerator. It is a custom processor that has a specialized instruction set. Graph operators such as CONV, POOL, ELTWISE are compiled as instructions that are executed by the DPU. The DPUCZ bears similarities to a systolic array but has specialized micro-coded engines that are optimized for specific tasks. Some of these engines are optimized for conventional convolution, while some are optimized for tasks such as depth-wise convolution, eltwise and others. We tend to refer to the DPUCZ as a Matrix of (Heterogeneous) Processing Engines.
175+
The DPUCZ IP that is provided with the Vitis AI IDE is the specialized accelerator. It is a custom processor that has a specialized instruction set. Graph operators such as CONV, POOL, ELTWISE are compiled as instructions that are executed by the DPU. The DPUCZ bears similarities to a systolic array but has specialized micro-coded engines that are optimized for specific tasks. Some of these engines are optimized for conventional convolution, while some are optimized for tasks such as depth-wise convolution, eltwise and others. We tend to refer to the DPUCZ as a Matrix of (Heterogeneous) Processing Engines.
176+
177+
178+
.. |trade| unicode:: U+02122 .. TRADEMARK SIGN
179+
:ltrim:
180+
.. |reg| unicode:: U+000AE .. REGISTERED TRADEMARK SIGN
181+
:ltrim:

docs/_sources/docs/reference/release_documentation.rst.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Vitis AI User Guides / DPU Product Guides
2929
* - Versal™ AI Edge / AI Core with AIE-ML, VEK280
3030
- `DPUCV2DX8G (PG425) <https://docs.xilinx.com/r/en-US/pg425-dpucv2>`__
3131

32-
* - Alveo V70
32+
* - Alveo V70
3333
- `DPUCV2DX8G (PG425) <https://docs.xilinx.com/r/en-US/pg425-dpucv2>`__
3434

3535
* - Zynq™ Ultrascale+™, Kria™, ZCU102, ZCU104, K26 SOM
@@ -42,9 +42,6 @@ Vitis AI User Guides / DPU Product Guides
4242
- `DPUCVDX8H (PG403) <https://docs.xilinx.com/r/en-US/pg403-dpucvdx8h>`__
4343

4444

45-
Known Issues
46-
------------
47-
- Engineering to add comments
4845

4946
.. |trade| unicode:: U+02122 .. TRADEMARK SIGN
5047
:ltrim:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Versal |trade| AI Edge with AIE-ML
3636
- 5.15
3737

3838

39-
Alveo V70
39+
Alveo |trade| V70
4040

4141
.. list-table::
4242
:widths: 25 25 25 25

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The Vitis AI workflow is largely unified for Embedded and Data Center applicatio
3030

3131
- Zynq |trade| Ultrascale+ |trade|, Kria |trade|, and Versal |trade| SoC applications leverage the on-chip processor subsystem (APU) as the host control node for model deployment. Considering optimization and :ref:`whole-application-acceleration` of subgraphs deployed on the SoC APU is crucial.
3232

33-
- Alveo data center card deployments leverage the AMD64 architecture host for execution of subgraphs that cannot be deployed on the DPU.
33+
- Alveo trade| data center card deployments leverage the AMD64 architecture host for execution of subgraphs that cannot be deployed on the DPU.
3434

3535
- Zynq Ultrascale+ and Kria designs can leverage the DPU with either the Vivado workflow or the Vitis workflow.
3636

docs/_sources/docs/workflow-system-integration.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ As of the Vitis |trade| 1.2 release, the historic DPUv1/v2/v3 nomenclature was d
5656
DPU Options
5757
~~~~~~~~~~~
5858

59-
Versal |trade| AI Core / AI Edge Series / Alveo V70: DPUCV2DX8G
59+
Versal |trade| AI Core / AI Edge Series / Alveo |trade| V70: DPUCV2DX8G
6060
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
6161

6262
The DPUCV2DX8G is a high-performance, general-purpose convolutional neural network(CNN)
@@ -124,8 +124,8 @@ IP and Reference Designs
124124
* - DPUCV2DX8G `PG425 <https://docs.xilinx.com/r/en-US/pg425-dpu>`__
125125
- VE2302(see note)
126126
- 3.5
127-
- `Early Access <https://www.xilinx.com/member/vitis-ai-vek280.html>`__
128-
- `Early Access <https://www.xilinx.com/member/vitis-ai-vek280.html>`__
127+
- `Early Access <https://account.amd.com/en/member/vitis-ai-ve2302.html>`__
128+
- `Early Access <https://account.amd.com/en/member/vitis-ai-ve2302.html>`__
129129

130130
* - DPUCZDX8G `PG338 <https://docs.xilinx.com/r/en-US/pg338-dpu>`__
131131
- MPSoC & Kria K26

0 commit comments

Comments
 (0)