AI Engine Compiler Guidance - 2025.2 English - UG1076

AI Engine Tools and Flows User Guide (UG1076)

Document ID
UG1076
Release Date
2025-11-20
Version
2025.2 English

After the AI Engine compiler completes the compilation of an AI Engine design it analyzes the design. Using this analysis, the compiler provides guidance on how to improve the design based on AI Engine rules or best software practices. AI Engine compiler can automatically correct some guidance. The guidance file lists all findings including the following items:

  • Severity
  • Category with tile numbers
  • Details
  • Correction (if done by the AI Engine compiler)
  • Suggested resolutions

The Work/reports directory contains the guidance file (guidance.html). Use a web browser to review the guidance file.

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 implementation.

  • Array of data is not 128 bits (16 bytes) aligned.

  • Use of __restrict qualifier causes undefined behavior. This undefined behavior exhibits only when running on hardware.

    Note: The --xlopt ≥1 option is required to compile a design that allows the AI Engine compiler to generate the appropriate guidance file.