Skip to content

Commit 39298b0

Browse files
authored
[mlir][docs] Capitalize "Transform" in "transform dialect" (llvm#76840)
A mix of "Transform dialect" and "transform dialect" is used ATM. This patch capitalizes the outstanding instances of "transform".
1 parent bdcd7c0 commit 39298b0

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

mlir/docs/Dialects/Transform.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ operations, and then applying loop unrolling to the inner loops produced by the
1919
previous transformations. As such, it is not intended as a replacement for the
2020
pass infrastructure, nor for the pattern rewriting infrastructure. In the most
2121
common case, the transform IR will be processed and applied to the payload IR by
22-
a pass. Transformations expressed by the transform dialect may be implemented
22+
a pass. Transformations expressed by the Transform dialect may be implemented
2323
using the pattern infrastructure or any other relevant MLIR component.
2424

2525
The following IR gives a rough idea of what the operations in this dialect
@@ -271,7 +271,7 @@ operation lists.
271271
272272
## Handle Invalidation
273273
274-
The execution model of the transform dialect allows a payload IR operation to be
274+
The execution model of the Transform dialect allows a payload IR operation to be
275275
associated with _multiple_ handles as well as nested payload IR operations to be
276276
associated with different handles. Similarly, a payload IR value may be
277277
associated with multiple transform IR value handles. When a transform IR
@@ -373,13 +373,13 @@ to specify which transformations the pass should run. The transform dialect
373373
provides a uniform, extensible mechanism for controlling transformations in
374374
such cases.
375375

376-
The transform dialect is supposed to be consumed by an "interpreter" pass
376+
The Transform dialect is supposed to be consumed by an "interpreter" pass
377377
that drives the application of transformations. To ensure extensibility and
378378
composability, this pass is not expected to actually perform the
379379
transformations specified by the ops. Instead, the transformations are
380380
implemented by the transform ops themselves via `TransformOpInterface`. The
381381
pass serves as the entry point, handles the flow of transform operations and
382-
takes care of bookkeeping. As such, the transform dialect does not provide
382+
takes care of bookkeeping. As such, the Transform dialect does not provide
383383
the interpreter pass. Instead, it provides a set of utilities that can be
384384
used by clients to define their own interpreter passes or as part of a more
385385
complex pass. For example, the mapping between values in the transform IR

mlir/docs/Tutorials/transform/Ch1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ transform.sequence failures(propagate) {
7979

8080
## Transform Dialect Interpreter
8181

82-
Since we don’t want to recompile the compiler every time we change a transformation, we can use a transform dialect interpreter pass to apply this transformation sequence to the payload IR. As we will see in the next chapter, it is possible to define custom passes or even integrate the transform interpreter into a larger pass. For now, we can use the existing test pass:
82+
Since we don’t want to recompile the compiler every time we change a transformation, we can use a Transform dialect interpreter pass to apply this transformation sequence to the payload IR. As we will see in the next chapter, it is possible to define custom passes or even integrate the transform interpreter into a larger pass. For now, we can use the existing test pass:
8383

8484

8585
```sh
@@ -168,7 +168,7 @@ Besides producing new handles, the tiling transform operation _consumes_ the ope
168168
169169
## Handle Invalidation and Expensive Checks Mode
170170
171-
Undefined behavior is difficult to grapple with when it does happen, so the transform dialect interpreter provides a set of additional expensive checks that detect most undefined behavior in the transform IR. For example, if we wanted to use the `%arg1` handle after it is consumed, it would cause undefined behavior that manifests as an assertion in the debug build, and likely as a segmentation fault in the release mode.
171+
Undefined behavior is difficult to grapple with when it does happen, so the Transform dialect interpreter provides a set of additional expensive checks that detect most undefined behavior in the transform IR. For example, if we wanted to use the `%arg1` handle after it is consumed, it would cause undefined behavior that manifests as an assertion in the debug build, and likely as a segmentation fault in the release mode.
172172
173173
```mlir
174174
transform.sequence failures(propagate) {
@@ -379,7 +379,7 @@ Finally, we would like to replace the call to the outlined function with a call
379379
380380
## Tracking IR Modifications
381381
382-
The transform dialect automatically tracks all IR changes that are made as part
382+
The Transform dialect automatically tracks all IR changes that are made as part
383383
of transform ops. (Implementations must use the provided rewriter to modify IR.)
384384
If a payload op is erased, it is automatically removed from all handles that it
385385
is currently associated with. If a payload op is replaced, the transform dialect

mlir/docs/Tutorials/transform/Ch2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Transform dialect uses the dialect extension mechanism to allow additional o
1010
// In MyExtension.cpp.
1111
#include "mlir/Dialect/Transform/IR/TransformDialect.h"
1212

13-
// Define a new transform dialect extension. This uses the CRTP idiom to identify
13+
// Define a new Transform dialect extension. This uses the CRTP idiom to identify
1414
// extensions.
1515
class MyExtension : public ::mlir::transform::TransformDialectExtension<MyExtension> {
1616
public:
@@ -200,7 +200,7 @@ must be modified with the provided rewriter.
200200
```c++
201201
// In MyExtension.cpp
202202

203-
// Implementation of our transform dialect operation.
203+
// Implementation of our Transform dialect operation.
204204
// This operation returns a tri-state result that can be one of:
205205
// - success when the transformation succeeded;
206206
// - definite failure when the transformation failed in such a way that
@@ -277,7 +277,7 @@ void registerMyExtension(::mlir::DialectRegistry &registry) {
277277
}
278278
```
279279
280-
After registering the extension, it becomes possible to use our new operation in the transform dialect interpreter. The upstream testing pass can be used as is.
280+
After registering the extension, it becomes possible to use our new operation in the Transform dialect interpreter. The upstream testing pass can be used as is.
281281
282282
```mlir
283283
transform.sequence failures(propagate) {

mlir/docs/Tutorials/transform/Ch3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ void MyExtension::init() {
138138
}
139139
```
140140

141-
This type is now directly available in the transform dialect and can be used in operations.
141+
This type is now directly available in the Transform dialect and can be used in operations.
142142

143143

144144
```mlir

mlir/docs/Tutorials/transform/ChH.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Chapter H: Reproducing Halide Schedule
22

33
This chapter demonstrates how a schedule from the [Halide
4-
DSL](http://halide-lang.org) can be implemented using transform dialect for
4+
DSL](http://halide-lang.org) can be implemented using Transform dialect for
55
structured ops.
66

77
Note that the IR below is pseudo-code with types removed for brevity. It may
@@ -408,7 +408,7 @@ identical_ to the code with the full schedule. Therefore, we will only unroll
408408
the corresponding loops corresponding to `xi` and `ci` dimensions that actually
409409
get unrolled by Halide.
410410

411-
As tiling in the transform dialect produces handles to the loops materialized by
411+
As tiling in the Transform dialect produces handles to the loops materialized by
412412
tiling, unrolling those loops is just a matter of chaining the corresponding
413413
transformation. Note that the inner loop must be unrolled first as unrolling the
414414
outer loop will invalidate the handles to the inner loop.
@@ -499,7 +499,7 @@ bufferization is directly available as a transform operation.
499499

500500
One-shot bufferization itself does not produce buffer deallocations, which may
501501
lead to leaks. So we have to run the buffer deallocation pass pipeline to avoid
502-
them. Note that the transform dialect seamlessly runs named passes and pass
502+
them. Note that the Transform dialect seamlessly runs named passes and pass
503503
pipelines: if desired, one could replace complex `--pass-pipeline expressions`
504504
with operations. Note that we apply the pipeline to functions rather than entire
505505
module to avoid running it on the transform IR that is contained in the module.

mlir/docs/Tutorials/transform/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ scheduling languages). This tutorial presents the concepts of the MLIR transform
88
dialect and related infrastructure. It will be accompanied by a practical
99
demonstration of three use scenarios:
1010

11-
- Composing transform dialect operations available in (upstream) MLIR to perform
11+
- Composing Transform dialect operations available in (upstream) MLIR to perform
1212
a sequence of optimizing transformations that results in efficient code for an
1313
MLIR linear algebra operation.
14-
- Defining new transform dialect operations and adapting existing transformation
15-
code to work with the transform dialect infrastructure.
16-
- Setting up and using the transform dialect infrastructure in a downstream
14+
- Defining new Transform dialect operations and adapting existing transformation
15+
code to work with the Transform dialect infrastructure.
16+
- Setting up and using the Transform dialect infrastructure in a downstream
1717
out-of-tree project with custom dialects, transformations and passes.
1818

19-
After following the tutorial, one will be able to apply the transform dialect in
19+
After following the tutorial, one will be able to apply the Transform dialect in
2020
their work and extend it when necessary. Basic familiarity with MLIR is a
2121
prerequisite. See [Toy tutorial](../Toy) for introduction to MLIR.
2222

0 commit comments

Comments
 (0)