Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Shardy documentation #127

Open
tomnatan30 opened this issue Oct 7, 2024 · 0 comments
Open

Improve Shardy documentation #127

tomnatan30 opened this issue Oct 7, 2024 · 0 comments

Comments

@tomnatan30
Copy link
Collaborator

Shardy currently has the following WIP documentation:

  1. A very basic README file
  2. Auto generated MLIR docs from shardy/dialect/sdy/ir/*.td and shardy/dialect/sdy/transforms/*/passes.td.
  3. 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:

  1. 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.
  2. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant