After the AI Engine compiler completes the compilation of an AI Engine design it analyzes the design and provides guidance on how to improve the design based on AI Engine rules or best software practices. Some guidance might be corrected by AI Engine compiler automatically. The guidance file lists all the findings with severity, category with tile number, details, correction if done by the AI Engine compiler and suggested resolutions.
The guidance file, guidance.html, is located in the Work/reports directory. Use a web browser to review this guidance file. It is recommended that you update your design per the design guidance report before running the design in the simulator or on hardware.
The following are examples of the AI Engine compiler-generated guidance available in Work/reports/guidance.html.
- Variables are referenced before being initialized.
- Global variables are initialized locally from a kernel
- Array of data is not 128 bits (16 bytes) aligned.
- Use of
__restrictqualifier causes undefined behavior. This undefined behavior is exhibited running on hardware only.
--xlopt≥1 option is required to compile a design that allows the AI Engine compiler to generate the appropriate guidance file.