llvm/llvm-project

[mlir] Auto generate docs for dialect op interfaces

Open

#104,593 opened on 2024年8月16日

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
 (平均マージ 1d 2h) (30d で 1,000 merged PRs)

説明

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.

コントリビューターガイド

調査方針
OpDocGen.cpp 内の既存の自動ドキュメント生成コードを調査し、attr/type/op/enum ドキュメントがどのように生成されるかを理解した上で、' gen op interface *' バックエンドのサポートを追加して、操作インターフェースを処理するように拡張します。
技術スタック
cpp
領域
backenddocumentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
C++MLIR
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50