llvm/llvm-project

[mlir] Auto generate docs for dialect op interfaces

Open

#104 593 ouverte le 16 août 2024

Voir sur GitHub
 (9 commentaires) (0 réactions) (1 assigné)C++ (10 782 forks)batch import
good first issuemlir:core

Métriques du dépôt

Stars
 (26 378 stars)
Métriques de merge PR
 (Merge moyen 1j 2h) (1 000 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez le code existant de génération automatique de documentation dans OpDocGen.cpp pour comprendre comment les documents attr/type/op/enum sont générés, puis étendez le pour gérer les interfaces d'opération en ajoutant la prise en charge des backends ' gen op interface *'.
Stack technique
cpp
Domaine
backenddocumentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++MLIR
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50