Google Git
Sign in
llvm / llvm-project / mlir / cd58859fa7ddf14d88df507779c4fc085738da55
commitcd58859fa7ddf14d88df507779c4fc085738da55[log] [tgz]
authorTwice <twice@apache.org>Tue Sep 16 11:16:28 2025 +0800
committerCopybara-Service <copybara-worker@google.com>Mon Sep 15 20:18:54 2025 -0700
treef891afa7e6c74c666e2bf9553a6e0af780d3716f
parent559d5e4843da87fbf1c000876ec75b596bf2f8f4 [diff]
[MLIR][Python] Add docstring for generated python op classes (#158198)

This PR adds support in mlir-tblgen for generating docstrings for each
Python class corresponding to an MLIR op. The docstrings are currently
derived from the op’s description in ODS, with indentation adjusted to
display nicely in Python. This makes it easier for Python users to see
the op descriptions directly in their IDE or LSP while coding.

In the future, we can extend the docstrings to include explanations for
each method, attribute, and so on.

This idea was previously discussed in the `#mlir-python` channel on
Discord with @makslevental and @superbobry.

---------

Co-authored-by: Maksim Levental <maksim.levental@gmail.com>
GitOrigin-RevId: 10d0d955e22be43abab8fe7e339e99068aaac030
3 files changed
tree: f891afa7e6c74c666e2bf9553a6e0af780d3716f
  1. benchmark/
  2. cmake/
  3. docs/
  4. examples/
  5. include/
  6. lib/
  7. python/
  8. test/
  9. tools/
  10. unittests/
  11. utils/
  12. .clang-format
  13. .clang-tidy
  14. CMakeLists.txt
  15. LICENSE.TXT
  16. Maintainers.md
  17. README.md
README.md

Multi-Level Intermediate Representation

See https://mlir.llvm.org/ for more information.