Documentation of Python bindings

[z4m1n0]

Hello all,

I'm looking for documentation on the XRT Python API bindings.

I am currently working on a class with an hands-on approach that covers XDNA NPUs. Therefore, the students have to use XRT to launch kernels on the NPU. My current XRT setup uses the C++ bindings. However, to keep things simple for the students, I would like to use Python wherever possible. The documentation (1, 2) states that XRT provides a Python API. However, the pyxrt page is empty. Am I missing something?

I think I can rewrite my setup in Python by reading the pybind11 implementation and looking at example code, but that is not an option for the bachelor's degree students who are new to this topic. Are there any further resources available for the XRT Python API?

Best, Tamino

[z4m1n0]

The python bindings are maturing and the documentation will be included in the top level XRT doc.

Would you like to work on creating the xrt module? You can make the changes and provided a Pull Request./

Have you looked into pyxrt pybind11 binding that is coming in 2021.1?

Originally posted by @sonals in #5229

As @sonals stated in 2021, the Python API should be documented in the top-level XRT documentation. This documentation is still missing.