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][Tuner] Add initial tuning spec docs #19462

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Conversation

kuhar
Copy link
Member

@kuhar kuhar commented Dec 11, 2024

General intro, list the main flags, show an example.

Issue: #19214

Copy link
Member

@ScottTodd ScottTodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start, thanks. This location under "Reference / Other topics" SGTM. I could also see a page living under "Guides / General topics" for "program optimization" that covers compilation options, runtime options, tuning, etc.

docs/website/docs/reference/index.md Show resolved Hide resolved
docs/website/docs/reference/tuning.md Show resolved Hide resolved
docs/website/docs/reference/tuning.md Outdated Show resolved Hide resolved
docs/website/docs/reference/tuning.md Outdated Show resolved Hide resolved
docs/website/docs/reference/tuning.md Outdated Show resolved Hide resolved
docs/website/docs/reference/tuning.md Show resolved Hide resolved
docs/website/docs/reference/tuning.md Outdated Show resolved Hide resolved
docs/website/docs/reference/tuning.md Outdated Show resolved Hide resolved
@ScottTodd ScottTodd added documentation ✏️ Improvements or additions to documentation codegen Shared code generation infrastructure and dialects performance ⚡ Performance/optimization related work across the compiler and runtime labels Dec 11, 2024
Signed-off-by: Jakub Kuderski <jakub@nod-labs.com>
Signed-off-by: Jakub Kuderski <jakub@nod-labs.com>
@kuhar kuhar added the tuner label Dec 11, 2024
@kuhar kuhar requested a review from ScottTodd December 11, 2024 20:34
@kuhar
Copy link
Member Author

kuhar commented Dec 11, 2024

Great start, thanks. This location under "Reference / Other topics" SGTM. I could also see a page living under "Guides / General topics" for "program optimization" that covers compilation options, runtime options, tuning, etc.

I had this dilemma when writing these docs, and decided that this more of a 'reference' than a design doc or something strictly focused on performance

Signed-off-by: Jakub Kuderski <jakub@nod-labs.com>
Signed-off-by: Jakub Kuderski <jakub@nod-labs.com>
docs/website/docs/reference/tuning.md Outdated Show resolved Hide resolved
docs/website/docs/reference/tuning.md Show resolved Hide resolved
Signed-off-by: Jakub Kuderski <jakub@nod-labs.com>
@kuhar
Copy link
Member Author

kuhar commented Dec 11, 2024

Thanks for thorough reviews @ScottTodd, very appreciated!

@kuhar kuhar merged commit 52ce3d3 into iree-org:main Dec 11, 2024
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codegen Shared code generation infrastructure and dialects documentation ✏️ Improvements or additions to documentation performance ⚡ Performance/optimization related work across the compiler and runtime tuner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants