-
Notifications
You must be signed in to change notification settings - Fork 13.6k
[mlir][gpu] Update descriptions format of GPU ops(NFC) #141395
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
Merged
Merged
Conversation
This file contains hidden or 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
@llvm/pr-subscribers-mlir Author: Longsheng Mou (CoTinker) ChangesFull diff: https://github.com/llvm/llvm-project/pull/141395.diff 1 Files Affected:
diff --git a/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td b/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td
index 68095b7bf5c59..ea04202082626 100644
--- a/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td
+++ b/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td
@@ -146,7 +146,7 @@ def GPU_ClusterBlockIdOp : GPU_IndexOp<"cluster_block_id"> {
```
If `upper_bound` is set, then executing (a lowering of) this operation in an
- environment where the number of thread blocks per cluster along `dimension`
+ environment where the number of thread blocks per cluster along `dimension`
is greater than `upper_bound` causes undefined behavior.
There is an implicit upper bound of `kMaxClusterDim` (currently 8).
@@ -1064,7 +1064,7 @@ def GPU_ReturnOp : GPU_Op<"return", [HasParent<"GPUFuncOp">, Pure,
Arguments<(ins Variadic<AnyType>:$operands)>, Results<(outs)> {
let summary = "Terminator for GPU functions.";
let description = [{
- A terminator operation for regions that appear in the body of `gpu.func`
+ A terminator operation for regions that appear in the body of `gpu.func`
functions. The operands to the `gpu.return` are the result values returned
by an invocation of the `gpu.func`.
}];
@@ -1092,7 +1092,7 @@ def GPU_YieldOp : GPU_Op<"yield", [Pure, ReturnLike, Terminator]>,
Arguments<(ins Variadic<AnyType>:$values)> {
let summary = "GPU yield operation";
let description = [{
- gpu.yield` is a special terminator operation for blocks inside regions
+ `gpu.yield` is a special terminator operation for blocks inside regions
in gpu ops. It returns values to the immediately enclosing gpu op.
Example:
@@ -1367,7 +1367,7 @@ def GPU_ShuffleOp : GPU_Op<
def GPU_BarrierOp : GPU_Op<"barrier"> {
let summary = "Synchronizes all work items of a workgroup.";
let description = [{
- The "barrier" op synchronizes all work items of a workgroup. It is used
+ The `barrier` op synchronizes all work items of a workgroup. It is used
to coordinate communication between the work items of the workgroup.
```mlir
|
@llvm/pr-subscribers-mlir-gpu Author: Longsheng Mou (CoTinker) ChangesFull diff: https://github.com/llvm/llvm-project/pull/141395.diff 1 Files Affected:
diff --git a/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td b/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td
index 68095b7bf5c59..ea04202082626 100644
--- a/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td
+++ b/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td
@@ -146,7 +146,7 @@ def GPU_ClusterBlockIdOp : GPU_IndexOp<"cluster_block_id"> {
```
If `upper_bound` is set, then executing (a lowering of) this operation in an
- environment where the number of thread blocks per cluster along `dimension`
+ environment where the number of thread blocks per cluster along `dimension`
is greater than `upper_bound` causes undefined behavior.
There is an implicit upper bound of `kMaxClusterDim` (currently 8).
@@ -1064,7 +1064,7 @@ def GPU_ReturnOp : GPU_Op<"return", [HasParent<"GPUFuncOp">, Pure,
Arguments<(ins Variadic<AnyType>:$operands)>, Results<(outs)> {
let summary = "Terminator for GPU functions.";
let description = [{
- A terminator operation for regions that appear in the body of `gpu.func`
+ A terminator operation for regions that appear in the body of `gpu.func`
functions. The operands to the `gpu.return` are the result values returned
by an invocation of the `gpu.func`.
}];
@@ -1092,7 +1092,7 @@ def GPU_YieldOp : GPU_Op<"yield", [Pure, ReturnLike, Terminator]>,
Arguments<(ins Variadic<AnyType>:$values)> {
let summary = "GPU yield operation";
let description = [{
- gpu.yield` is a special terminator operation for blocks inside regions
+ `gpu.yield` is a special terminator operation for blocks inside regions
in gpu ops. It returns values to the immediately enclosing gpu op.
Example:
@@ -1367,7 +1367,7 @@ def GPU_ShuffleOp : GPU_Op<
def GPU_BarrierOp : GPU_Op<"barrier"> {
let summary = "Synchronizes all work items of a workgroup.";
let description = [{
- The "barrier" op synchronizes all work items of a workgroup. It is used
+ The `barrier` op synchronizes all work items of a workgroup. It is used
to coordinate communication between the work items of the workgroup.
```mlir
|
hstk30-hw
approved these changes
May 29, 2025
svkeerthy
pushed a commit
that referenced
this pull request
May 29, 2025
google-yfyang
pushed a commit
to google-yfyang/llvm-project
that referenced
this pull request
May 29, 2025
sivan-shani
pushed a commit
to sivan-shani/llvm-project
that referenced
this pull request
Jun 3, 2025
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.
No description provided.