Managing AI Engine Components with the Python Command Line Interface - 2024.1 English

AI Engine Tools and Flows User Guide (UG1076)

Document ID
Release Date
2024.1 English

The Vitis Unified IDE supports Python APIs to automate the management of AI Engine components. There are two ways to use the Python APIs:

  1. Use the Python APIs as commands directly in the interactive mode.

    To launch the Vitis Unified IDE in interactive mode, use the following command:

    vitis -i

    The command is executed as follows:

    bash-4.2$ vitis -i
    ****** Vitis Development Environment
    ****** Vitis v2024.1 (64-bit)
    Welcome to Vitis Python Shell
    Python CLI API documentation is available at                              
    Do not use the file until the session is closed.

    Python API commands can now be used to manage the AI Engine components.

    The Python CLI API documentation (index.html) is available in the initial log of the Vitis interactive command. The documentation can be accessed through the Vitis unified IDE also. In the Vitis Unified IDE, select Help > Vitis CLI Documentation .

    For more information about the interactive mode, see Vitis Interactive Python Shell in the Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393).

  2. Run a Python script (.py), which contains the Python APIs, in one of two ways:
    • With vitis -i which launches the Vitis IDE interactive mode. For example, vitis [1]: run <.py>.
    • With vitis -s option which executes the provided Python script. For example, vitis -s <.py>.