####################################### AI Engine Development #######################################
More Information
See AMD Vitis™ Development Environment on xilinx.com
The tutorials under the AI Engine Development help you learn how to target, develop, and deploy advanced algorithms using a Versal AI Engine array in conjunction with PL IP/kernels and software applications running on the embedded processors. To successfully deploy AI Engine applications in hardware, you need to be aware of the Vitis and AI Engine tools and flows.
- :doc:`Feature Tutorials <./Feature_Tutorials/Feature_Tutorials>` highlight specific features and flows that help develop AI Engine applications.
- :doc:`Design Tutorials <./Design_Tutorials/Design_Tutorials>` showcase the two major phases of AI Engine application development: architecting the application and developing the kernels. Both phases are demonstrated in these tutorials.
Tutorials target the VCK190 board. The table below lists the tutorials available, and the features and flows showcased in all of these tutorials. The various columns correspond to specific features/flows supported in these tutorials and will help you identify tutorials that showcase specific flows and features that you are interested in.
To easily find the right documentation corresponding to the development stage you are at, we recommend you use the AI Engine Design Process Hub.
The major documentation for AI Engine includes:
- Versal ACAP AI Engine Architecture Manual (AM009)
- AI Engine Tools and Flows (UG1076)
- AI Engine Kernel and Graph Programming Guide (UG1079)
If you are new with AI Engine, the following training courses can help you understand the architecture and design flow.
- Designing with Versal AI Engine 1: Architecture and Design Flow
- Designing with Versal AI Engine 2: Graph Programming with AI Engine Kernels
- Designing with Versal AI Engine 3: Kernel Programming and Optimization
Important
Before beginning a tutorial, read and follow the Vitis Software Platform Release Notes (v2024.1) for setting up software and installing the VCK190 base platform.
Run the following steps to set up the environment (do NOT apply to tutorials that do not use the VCK190 base platform):
- Set up your platform by running the
xilinx-versal-common-v2024.1/environment-setup-cortexa72-cortexa53-xilinx-linuxscript as provided in the platform download. This script sets up theSYSROOTandCXXvariables. If the script is not present, you must run thexilinx-versal-common-v2024.1/sdk.sh. - Set up your
ROOTFSto point to thexilinx-versal-common-v2024.1/rootfs.ext4. - Set up your
IMAGEto point toxilinx-versal-common-v2024.1/Image. - Set up your
PLATFORM_REPO_PATHSenvironment variable based upon where you downloaded the platform.
If you are new with the AI Engine Architecture and tools, we recommend that you start with the :doc:`A to Z Bare-metal Flow <./Feature_Tutorials/01-aie_a_to_z/README>`, which will guide you through the entire flow from platform creation in AMD Vivado™ to AI Engine application creation, system integration, and testing on Hardware using the Vitis IDE.
To get started with AI Engine application development, we recommend that you look at the following tutorials:
- :doc:`DSP Library Tutorial <./Feature_Tutorials/08-dsp-library/README>` which will guide you to create an AI Engine using application using the AMD provided DSP library
- :doc:`AIE DSPLib and Model Composer <./Feature_Tutorials/10-aie-dsp-lib-model-composer/README>` which will also guide you to create an AI Engine using application using the AMD provided DSP library but using the ModelComposer tool which enables easy designs through a MATLAB Simulink environment.
- :doc:`Using GMIO with AIE <./Feature_Tutorials/02-using-gmio/README>` which goes through using the GMIOs for connectivity between the AI Engine and the DDR (through the NoC)
- :doc:`Implementing an IIR Filter on the AIE <./Feature_Tutorials/14-implementing-iir-filter/README>` will guide you into custom kernel coding using a IIR application
The following tutorials describe some features of the AI Engine, which might be useful for your application:
- :doc:`Runtime Parameter Reconfiguration <./Feature_Tutorials/03-rtp-reconfiguration/README>`
- :doc:`Packet Switching <./Feature_Tutorials/04-packet-switching/README>`
- :doc:`Using Floating-Point in the AIE <./Feature_Tutorials/07-AI-Engine-Floating-Point/README>`
After you have written your first AI Engine application you might want to verify the correct functionality of your graphs and kernels using x86 simulation and AI Engine simulation. In this regards, the following tutorials will be useful for you:
- :doc:`Debug Walkthrough Tutorial <./Feature_Tutorials/09-debug-walkthrough/README>` will guide you to analyze the performance of your AI Engine application and help you with debugging functional issues.
- :doc:`AIE Performance and Deadlock Analysis <./Feature_Tutorials/13-aie-performance-analysis/README>` which introduces you to performance analysis and optimization methods, and shows you how synchronization works in graph execution.
- :doc:`Python and C++ External Traffic Generators for AI Engine Simulation and Emulation Flows <./Feature_Tutorials/16-external-traffic-generator-aie/README>`: This tutorial demonstrates how to create external traffic generators as Python scripts or C++ applications to exercise the AI Engine kernels in the x86 simulator, AI Engine simulator, and in hardware emulation.
When your AI Engine Application meets your expectation (in terms of functionality and performances), it will be the right time to integrate it with the rest of the Versal System. At this stage, the following tutorials will be useful for you:
- :doc:`AIE Versal Integration <./Feature_Tutorials/05-AI-engine-versal-integration/README>` demonstrates creating a system design running on the AI Engine, PS, and Programmable Logic (PL).
- :doc:`Versal System Design Clocking <./Feature_Tutorials/06-versal-system-design-clocking-tutorial/README>` teaches clocking concepts for the Vitis compiler and how to define clocking for an ADF Graph, as well as PL kernels using clocking automation functionality.
- :doc:`Versal Emulation Waveform Analysis <./Feature_Tutorials/11-ai-engine-emulation-waveform-analysis/README>` demonstrates how you can use the AMD Vivado Design Suite logic simulator (XSIM) waveform GUI, and the Vitis analyzer to debug and analyze your design.
These tutorials target the VCK190 board. The table below lists the tutorials available, and the features and flows showcased in all of these tutorials. The various columns correspond to specific features/flows supported in these tutorials and will help you identify tutorials that showcase specific flows and features that you are interested in.
.. toctree:: :maxdepth: 3 :caption: Feature Tutorials :hidden: Feature Tutorials <./Feature_Tutorials/Feature_Tutorials.rst>
These tutorials target the VCK190 board. The table below lists the tutorials available, and the features and flows showcased in all of these tutorials. The various columns correspond to specific features/flows supported in these tutorials and will help you identify tutorials that showcase specific flows and features that you are interested in.
.. toctree:: :maxdepth: 3 :caption: Design Tutorials :hidden: Design Tutorials <./Design_Tutorials/Design_Tutorials.rst>