You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Purpose
Improve readability and fix minor issues in README.
# New contributor declaration
- [x] I am not making a trivial change, such as fixing a typo in a
comment.
- [x] I have written a PR description following these
[rules](https://cbea.ms/git-commit/#why-not-how).
- [ ] I have run `pre-commit run --from-ref origin/main --to-ref HEAD`.
- Select one of the following.
- [ ] I have added tests.
- `/test` for `lit` tests
- `/unittest` for C++ tests
- `/python/test` for end-to-end tests
- [x] This PR does not need a test because `FILL THIS IN`.
- Select one of the following.
- [x] I have not added any `lit` tests.
- [ ] The `lit` tests I have added follow these [best
practices](https://mlir.llvm.org/getting_started/TestingGuide/#filecheck-best-practices),
including the "tests should be minimal" section. (Usually running Python
code
and using the instructions it generates is not minimal.)
@@ -140,7 +140,7 @@ Alternatively, follow these steps to build LLVM from source manually.
140
140
# Running tests
141
141
142
142
There currently isn't a turnkey way to run all the Triton tests, but you can
143
-
follow the following recipe.
143
+
follow the following recipe:
144
144
145
145
```shell
146
146
# One-time setup. Note this will reinstall local Triton because torch
@@ -164,7 +164,7 @@ See [`python/triton/knobs.py`](python/triton/knobs.py) for the full list of conf
164
164
165
165
-`MLIR_ENABLE_DUMP=1` dumps the IR before every MLIR pass Triton runs, for all
166
166
kernels. Use `MLIR_ENABLE_DUMP=kernelName` to dump for a specific kernel only.
167
-
- Triton cache can interfere with the dump. In cases where `MLIR_ENABLE_DUMP=1` does not work, try cleaning your triton cache: `rm -r ~/.triton/cache/*`
167
+
- Triton cache can interfere with the dump. In cases where `MLIR_ENABLE_DUMP=1` does not work, try cleaning your triton cache: `rm -r ~/.triton/cache/*`.
168
168
-`MLIR_DUMP_PATH` specifies where `MLIR_ENABLE_DUMP` will dump to. If unset will dump to stderr.
169
169
-`LLVM_IR_ENABLE_DUMP=1` dumps the IR before every pass run over the LLVM IR.
170
170
-`TRITON_REPRODUCER_PATH=<reproducer_path>` will generate an MLIR reproducer file
@@ -175,11 +175,11 @@ See [`python/triton/knobs.py`](python/triton/knobs.py) for the full list of conf
175
175
-`TRITON_ENABLE_LLVM_DEBUG=1` passes `-debug` to LLVM, printing a lot of
176
176
debugging information to stdout. If this is too noisy, run with just
177
177
`TRITON_LLVM_DEBUG_ONLY` instead to limit the output.
178
-
179
-
An alternative way to reduce output noisiness is running with
178
+
- An alternative way to reduce output noisiness is running with
180
179
`LLVM_IR_ENABLE_DUMP=1`, extract the IR before the LLVM pass of interest, and
181
180
then run LLVM's `opt` standalone, perhaps passing `-debug-only=foo` on the
182
181
command line.
182
+
183
183
-`TRITON_LLVM_DEBUG_ONLY=<comma-separated>` is the equivalent of LLVM's
184
184
`-debug-only` command-line option. This limits the LLVM debug output to
185
185
specific pass or component names (which are specified using `#define
@@ -191,8 +191,7 @@ See [`python/triton/knobs.py`](python/triton/knobs.py) for the full list of conf
191
191
-`TRITON_ENABLE_ASAN=1` invokes the LLVM address sanitizer for
192
192
memory leak and out of bounds access detection. Currently only supported on the AMD
193
193
backend. This must be run using the ASAN libraries documented [here](https://rocm.docs.amd.com/projects/llvm-project/en/latest/conceptual/using-gpu-sanitizer.html).
194
-
195
-
When enabling the address sanitizer it is recommended to disable various memory caching strategies
194
+
- When enabling the address sanitizer it is recommended to disable various memory caching strategies
196
195
both within the ROCm stack and PyTorch. This will give the address sanitizer the best chance at finding the
197
196
memory fault where it originates. See this [test](https://github.com/triton-lang/triton/blob/main/third_party/amd/python/test/test_address_sanitizer.py) for more details.
198
197
@@ -227,9 +226,10 @@ See [`python/triton/knobs.py`](python/triton/knobs.py) for the full list of conf
227
226
-`TRITON_OVERRIDE_DIR` specifies the directory from which to load the IR/ptx/amdgcn files when `TRITON_KERNEL_OVERRIDE` is set to 1.
228
227
-`TRITON_F32_DEFAULT` sets the default input precision of `tl.dot` when using 32-bit floats, which can be either `ieee`, `tf32`, or `tf32x3`.
229
228
-`TRITON_FRONT_END_DEBUGGING=1` disables exception wrapping when an error occurs in the compiler frontend, allowing the full stack trace to be seen.
230
-
-`TRITON_DISABLE_LINE_INFO=1` removes all line information from the module
229
+
-`TRITON_DISABLE_LINE_INFO=1` removes all line information from the module.
231
230
232
-
N.B. Some of these environment variables don't have a knob in `knobs.py`-- those are only relevant to the C++ layer(s), hence they don't exist in the python layer.
231
+
> [!NOTE]
232
+
> Some of these environment variables don't have a knob in `knobs.py`-- those are only relevant to the C++ layer(s), hence they don't exist in the python layer.
233
233
234
234
**Kernel Override Steps**
235
235
@@ -274,7 +274,7 @@ Supported Hardware:
274
274
# Development Container (Dev Container)
275
275
276
276
**Dev Containers** for the Triton project are available from
277
-
the [triton-dev-containers repository](https://github.com/redhat-et/triton-dev-containers)
277
+
the [triton-dev-containers repository](https://github.com/redhat-et/triton-dev-containers).
278
278
279
279
### Key Benefits:
280
280
-**Consistency**: All developers can work with the same development
@@ -286,5 +286,5 @@ the [triton-dev-containers repository](https://github.com/redhat-et/triton-dev-c
286
286
287
287
### How to Use the Dev Container:
288
288
289
-
For detailed instructions on how to use the dev containers please see
290
-
the [dev container user guide](https://github.com/redhat-et/triton-dev-containers/blob/main/.devcontainer/devcontainer.md)
289
+
For detailed instructions on how to use the dev containers, please see
290
+
the [dev container user guide](https://github.com/redhat-et/triton-dev-containers/blob/main/.devcontainer/devcontainer.md).
0 commit comments