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

[Docs] Document most scheduling functions. #214

Merged
merged 8 commits into from
Oct 8, 2024

Conversation

jku20
Copy link
Contributor

@jku20 jku20 commented Oct 2, 2024

Description

Documents the functions exposed by the scheduling language and by the dsl.

Problems

Documentation (or the lack thereof).

Proposed Solutions

Added documentation.

Examples

N/A

Checklist

  • PR's title starts with a category (e.g. [Bugfix], [IR], [Builder], etc)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage (It would be better to provide ~2 different test cases to test the robustness of your code)
  • Code is well-documented

@chhzh123
Copy link
Member

chhzh123 commented Oct 3, 2024

Hi @jku20, thanks for your contribution! This is really helpful! Could you follow this guide to format your files before I take a closer look?
https://cornell-zhang.github.io/allo/developer/index.html#id1

@jku20
Copy link
Contributor Author

jku20 commented Oct 3, 2024

Of course! I'll un-draft this PR and request a review when it is ready (it should pass all the CI formatting, and non-formatting for that matter, checks then too). At current, this is just the quick, lightly edited copy-past of the scheduling functions.

@jku20
Copy link
Contributor Author

jku20 commented Oct 7, 2024

I haven't got around to doing the functions in the dsl, but here is reasonably usable, though not really complete, documentation of the scheduling functions and types.

@jku20 jku20 marked this pull request as ready for review October 7, 2024 02:11
@jku20
Copy link
Contributor Author

jku20 commented Oct 8, 2024

The above PR should be functional (whatever that means for docs). Do double check it though as I'm not 100% confident on everything.

Especially check the documentation of to. I couldn't figure out what axis was doing (or what depth=-1 means) so I just copied the docs from the tablegen of the op the thing schedule gets lowered to.

@chhzh123 chhzh123 merged commit d3b2816 into cornell-zhang:main Oct 8, 2024
2 checks passed
@jku20 jku20 deleted the dsl-documentation branch October 8, 2024 22:50
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

Successfully merging this pull request may close these issues.

2 participants