Skip to content

[docs] Clarify when to use optimization options #4114

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 7, 2025
Merged

[docs] Clarify when to use optimization options #4114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f280a5
docs(development.md): moves notes to bottom of build optimization sec…
bjacobgordon Dec 20, 2024
356226d
docs(development.md): clarifies deciding factor between "in-tree" opt…
bjacobgordon Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ Two setups are possible to build: in-tree and out-of-tree. The in-tree setup is
The following commands generate configuration files to build the project *in-tree*, that is, using llvm/llvm-project as the main build. This will build LLVM as well as torch-mlir and its subprojects.

###### ...Base + Optimization Options
This will build `libtorch` / `PyTorch` wheels from source and requires [the enablement mentioned earlier](#optional-enable-quicker-builds). If you encounter issues when you run this, try the [simplified build command](#base-options) instead.

If you do anticipate needing to frequently rebuild LLVM "in-tree", run:

```shell
cmake -GNinja -Bbuild \
Expand Down Expand Up @@ -136,9 +137,12 @@ cmake -GNinja -Bbuild \
-DLIBTORCH_VARIANT=shared
```

- This will build `libtorch` / `PyTorch` wheels from source and requires [the enablement mentioned earlier](#optional-enable-quicker-builds).
- If you encounter issues when you run this, try the [simplified build command](#base-options) instead.

###### ...Base Options

If you're running into issues with the above build command, consider using the following:
If you don't anticipate needing to frequently rebuild LLVM "in-tree", run:

```shell
cmake -GNinja -Bbuild \
Expand Down
Loading