Refreshes docs/development.md #3932
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… by blank lines - enforced by markdown linter
- splits CLI commands so copy button can be used individually - nests details for step 3 accordingly
- was formatted as an afterthought, not clear that it was needed to proceed
…"Set up the Python environment" section
- environment activation now has a header for hyperlinking deeper into the doc
- Before, they were easy to miss and required you to back track a bit
…ails - Makes the "in-tree" and "out-of-tree" variants adjacent to each other
…y of "in-tree" vs "out-of-tree"
…plified Build" section
- emphasizes the common options between "in-tree extended", "in-of-tree base", and "out-of-tree"
…uild using base options
- tweaks existing headers to communicate command construction rather than immediate execution - adds new header to indicate when the command should actually be executed
- was repeated 3 times!
- the use-case for this doc leans more toward "development" rather than "release"
- leverages numbering and indentation to reduce cognitive load
…fore configuring with CMake
CMake issued a warning upon fresh build: """ Manually-specified variables were not used by the project: LIBTORCH_CACHE LIBTORCH_SRC_BUILD LIBTORCH_VARIANT """
… to numbered list
…arate code blocks - makes them individually copyable from GitHub
… Build" - makes it so that the GitHub copy button only grabs the code snippet itself
…er "Initiate Build" section
- less repetitive - emphasizes that the targets can be superimposed
|
@marbre The only thing I'm unsure about is removing the libtorch flags |
|
Thanks! Marius/Jacob, please review and land as you see fit. I'll have a closer look when I'm back and can contribute any adjustments then. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First PR, super stoked! 🥳
Context
As part of Turbine Camp, I was referred to this doc to build Torch-MLIR on my Linux VM. It has a lot of potential, and I decided it to nudge it in a productive direction a bunch of times as I actually used the doc.
Approach
I tried to make the commits here "atomic", i.e. each one is a singular unit of work such that the file "works better"/"makes more sense" post-commit than pre-commit.
The majority of the commits in this PR is the story of how I "refactored" the doc step by step to look the way it does. I wrote them with Future Us in mind, so please don't squash haha.
Ready when you are, @marbre!