You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Shardy currently has the following WIP documentation:
A very basic README file
Auto generated MLIR docs from shardy/dialect/sdy/ir/*.td and shardy/dialect/sdy/transforms/*/passes.td.
An RFC that is a bit outdated.
Proposed documentation structure:
README (should be improved to provide a good user facing entry point to the repo)
Dialect / IR documentation (auto generated, can be improved).
Transforms / passes documentation (auto generated, can be improved).
Concepts: Sharding and Propagation - higher level understanding of how sharding / propagation works, and what compiler API we provide.
Using Shardy from JAX (user journey, perhaps with a colab).
Adding sharding to your compiler / dialect (or frontend framework like JAX).
Tooling
Debugging sharding annotations / propagation (follow up with internal users on what was useful in debugging).
The Dialect / IR documentation can be improved in general, but it's specifically missing the following:
Invariants of each operation / attribute, those are verified in the code, and the code comments there can be used as reference. The Invariants should be documented in a similar way to StableHLO spec.
Parameters/arguments of operations/attribute are sometimes missing a summary that populates the Description column in the auto generated doc.
More information will be added to this feature request later on.
The text was updated successfully, but these errors were encountered:
Shardy currently has the following WIP documentation:
shardy/dialect/sdy/ir/*.td
andshardy/dialect/sdy/transforms/*/passes.td
.Proposed documentation structure:
The Dialect / IR documentation can be improved in general, but it's specifically missing the following:
Description
column in the auto generated doc.More information will be added to this feature request later on.
The text was updated successfully, but these errors were encountered: