llvm/llvm-project

[mlir] Auto generate docs for dialect op interfaces

Open

#104.593 aberto em 16 de ago. de 2024

Ver no GitHub
 (9 comments) (0 reactions) (1 assignee)C++ (10.782 forks)batch import
good first issuemlir:core

Métricas do repositório

Stars
 (26.378 stars)
Métricas de merge de PR
 (Mesclagem média 1d 2h) (1.000 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Estude o código de geração automática de documentação existente em OpDocGen.cpp para entender como os documentos de attr/type/op/enum são gerados e, em seguida, estenda o para lidar com interfaces de operação adicionando suporte aos backends ' gen op interface *'.
Pilha de tecnologia
cpp
Domain
backenddocumentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C++MLIR
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50