Xilinx / Xilinx/XRT

Documentation of Python bindings

Open
#9,581 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
686
Forks
549
Avg merge
2d 4h
Merged PRs (30d)
70

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the empty pyxrt.html page, the pybind11 implementation in src/python/pybind11/src/pyxrt.cpp, and the linked host.py example. Determine which Python API resources are missing for students using XRT with XDNA NPUs, then document the relevant bindings and usage path. Done means the Python API has accessible, standalone guidance rather than requiring readers to infer it from implementation code.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.