llvm/llvm-project

[mlir] Auto generate docs for dialect op interfaces

Open

#104.593 aperta il 16 ago 2024

Vedi su GitHub
 (9 commenti) (0 reazioni) (1 assegnatario)C++ (10.782 fork)batch import
good first issuemlir:core

Metriche repository

Star
 (26.378 star)
Metriche merge PR
 (Merge medio 1g 2h) (1000 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia il codice esistente di generazione automatica della documentazione in OpDocGen.cpp per capire come vengono generati i documenti per attr/type/op/enum, quindi estendilo per gestire le interfacce operazionali aggiungendo il supporto per i backend ' gen op interface *'.
Tech stack
cpp
Dominio
backenddocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C++MLIR
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50