llvm/llvm-project

[mlir] Auto generate docs for dialect op interfaces

Open

#104,593 opened on Aug 16, 2024

View on GitHub
 (9 comments) (0 reactions) (1 assignee)C++ (10,782 forks)batch import
good first issuemlir:core

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description

MLIR tblgen support auto generating attr/type/op/enum docs, and a dialect doc that contains them all. This is done in OpDocGen.cpp. However, it doesn't support generating docs for op interfaces (generated via -gen-op-interface-*).

It would be great to add support for that, such that the generated doc will show the following info for each op-interafce - summary, description, base interfaces, and methods.

Contributor guide

Research direction
Study the existing auto doc generation code in OpDocGen.cpp to understand how attr/type/op/enum docs are generated, then extend it to handle op interfaces by adding support for the ' gen op interface *' backends.
Tech stack
cpp
Domain
backenddocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++MLIR
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50