[PATCH] D73595: [mlir][Linalg][doc] Add Design Document for the Linalg Dialect

[Alex Zinenko via Phabricator via llvm-commits]

ftynse added a comment.

In D73595#1847054 <https://reviews.llvm.org/D73595#1847054>, @rriddle wrote:

> In D73595#1846944 <https://reviews.llvm.org/D73595#1846944>, @nicolasvasilache wrote:
>
> > @ftynse I fully agree hence my pushing back on the github comments.
>
>
> If you had started submitting this incrementally, you wouldn't have this problem ;)


>From my experience, you cannot write this kind of document (essentially a position paper more than documentation) incrementally in the same sense you would write code. There are no really separable components (functions, classes, features) that can be implemented independently. Worse, having only some parts available might make it convey a different message than what is actually intended. I would love to hear suggestions on how to iterate on such things.

> 
> 
>> @rriddle can we please move forward?
>>  I'll integrate the current review and then we can iterate like Alex suggests?
> 
> Is there a rush here? I have some strong concerns with the way this document is structured as-is, which are largely enumerated by Uday on the github commit:
> 
>> This file doesn't appear to be just the documentation or design doc of Linalg but also a rationale doc + past survey/experience + related work discussion + opinion + future thoughts > / side comments and some amount of vision. Writing these up is useful, but I think it's both misnamed and misplaced in the directory tree. For eg., other docs/Dialects/*.md file have > vastly different content.
> 
> What is the plan to resolve these?

I think most of this doc is the rationale for building Linalg, _not_ dialect documentation. It lists specific design decisions Linalg takes and needs the review of state-of-the-art to justify those decisions. How about renaming it to "Linalg Rationale" and linking to design decisions (aka core guiding principles) with an explanatory phrase that, unless you know the field well, you should read the survey first?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D73595/new/

https://reviews.llvm.org/D73595