[Mlir-commits] [mlir] 61f8ab3 - [mlir] [irdl] Improve IRDL documentation (#104928)
llvmlistbot at llvm.org
llvmlistbot at llvm.org
Tue Aug 20 09:03:44 PDT 2024
Author: Alex Rice
Date: 2024-08-20T17:03:40+01:00
New Revision: 61f8ab3a367505ac8fab900f9160ecd629a85859
URL: https://github.com/llvm/llvm-project/commit/61f8ab3a367505ac8fab900f9160ecd629a85859
DIFF: https://github.com/llvm/llvm-project/commit/61f8ab3a367505ac8fab900f9160ecd629a85859.diff
LOG: [mlir] [irdl] Improve IRDL documentation (#104928)
Updates some of the irdl documentation to be in line with the current
state of IRDL. Also removes some trailing spaces in this documentation.
Added:
Modified:
mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
Removed:
################################################################################
diff --git a/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td b/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
index b9177f8c594f9c..e822969fc575eb 100644
--- a/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
+++ b/mlir/include/mlir/Dialect/IRDL/IR/IRDL.td
@@ -37,17 +37,17 @@ def IRDL_Dialect : Dialect {
```mlir
irdl.dialect @cmath {
irdl.type @complex {
- %0 = irdl.is_type : f32
- %1 = irdl.is_type : f64
+ %0 = irdl.is f32
+ %1 = irdl.is f64
%2 = irdl.any_of(%0, %1)
irdl.parameters(%2)
}
irdl.operation @mul {
- %0 = irdl.is_type : f32
- %1 = irdl.is_type : f64
+ %0 = irdl.is f32
+ %1 = irdl.is f64
%2 = irdl.any_of(%0, %1)
- %3 = irdl.parametric_type : "cmath.complex"<%2>
+ %3 = irdl.parametric @cmath::@complex<%2>
irdl.operands(%3, %3)
irdl.results(%3)
}
diff --git a/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td b/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
index d2765dec420ac2..aa327b2fd869fc 100644
--- a/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
+++ b/mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td
@@ -182,7 +182,7 @@ def IRDL_OperationOp : IRDL_Op<"operation",
irdl.operation @norm {
%0 = irdl.any
- %1 = irdl.parametric @complex<%0>
+ %1 = irdl.parametric @cmath::@complex<%0>
irdl.results(%0)
irdl.operands(%1)
}
@@ -216,7 +216,7 @@ def IRDL_OperandsOp : IRDL_Op<"operands", [HasParent<"OperationOp">]> {
irdl.operation @mul {
%0 = irdl.any
- %1 = irdl.parametric @complex<%0>
+ %1 = irdl.parametric @cmath::@complex<%0>
irdl.results(%1)
irdl.operands(%1, %1)
}
@@ -230,7 +230,7 @@ def IRDL_OperandsOp : IRDL_Op<"operands", [HasParent<"OperationOp">]> {
```mlir
irdl.operands(%0, single %1, optional %2, variadic %3)
```
-
+
Here, %0 and %1 are required single operands, %2 is an optional operand,
and %3 is a variadic operand.
@@ -239,7 +239,7 @@ def IRDL_OperandsOp : IRDL_Op<"operands", [HasParent<"OperationOp">]> {
operands in each segment.
}];
- let arguments = (ins Variadic<IRDL_AttributeType>:$args,
+ let arguments = (ins Variadic<IRDL_AttributeType>:$args,
VariadicityArrayAttr:$variadicity);
let assemblyFormat =
"`` custom<ValuesWithVariadicity>($args, $variadicity) attr-dict";
@@ -262,7 +262,7 @@ def IRDL_ResultsOp : IRDL_Op<"results", [HasParent<"OperationOp">]> {
irdl.operation @get_values {
%0 = irdl.any
- %1 = irdl.parametric @complex<%0>
+ %1 = irdl.parametric @cmath::@complex<%0>
irdl.results(%0, %0)
irdl.operands(%1)
}
@@ -276,7 +276,7 @@ def IRDL_ResultsOp : IRDL_Op<"results", [HasParent<"OperationOp">]> {
```mlir
irdl.results(%0, single %1, optional %2, variadic %3)
```
-
+
Here, %0 and %1 are required single results, %2 is an optional result,
and %3 is a variadic result.
@@ -285,7 +285,7 @@ def IRDL_ResultsOp : IRDL_Op<"results", [HasParent<"OperationOp">]> {
results in each segment.
}];
- let arguments = (ins Variadic<IRDL_AttributeType>:$args,
+ let arguments = (ins Variadic<IRDL_AttributeType>:$args,
VariadicityArrayAttr:$variadicity);
let assemblyFormat =
" `` custom<ValuesWithVariadicity>($args, $variadicity) attr-dict";
@@ -296,7 +296,7 @@ def IRDL_AttributesOp : IRDL_Op<"attributes", [HasParent<"OperationOp">]> {
let summary = "Define the attributes of an operation";
let description = [{
- `irdl.attributes` defines the attributes of the `irdl.operation` parent
+ `irdl.attributes` defines the attributes of the `irdl.operation` parent
operation definition.
In the following example, `irdl.attributes` defines the attributes of the
@@ -320,10 +320,10 @@ def IRDL_AttributesOp : IRDL_Op<"attributes", [HasParent<"OperationOp">]> {
attribute "attr2" with value `i64`.
}];
- let arguments = (ins Variadic<IRDL_AttributeType>:$attributeValues,
+ let arguments = (ins Variadic<IRDL_AttributeType>:$attributeValues,
StrArrayAttr:$attributeValueNames);
let assemblyFormat = [{
- custom<AttributesOp>($attributeValues, $attributeValueNames) attr-dict
+ custom<AttributesOp>($attributeValues, $attributeValueNames) attr-dict
}];
let hasVerifier = true;
@@ -489,7 +489,7 @@ def IRDL_BaseOp : IRDL_ConstraintOp<"base",
OptionalAttr<StrAttr>:$base_name);
let results = (outs IRDL_AttributeType:$output);
let assemblyFormat = " ($base_ref^)? ($base_name^)? ` ` attr-dict";
-
+
let builders = [
OpBuilder<(ins "SymbolRefAttr":$base_ref), [{
build($_builder, $_state, base_ref, {});
@@ -521,7 +521,7 @@ def IRDL_ParametricOp : IRDL_ConstraintOp<"parametric",
irdl.operation @norm {
%0 = irdl.any
- %1 = irdl.parametric @complex<%0>
+ %1 = irdl.parametric @cmath::@complex<%0>
irdl.operands(%1)
irdl.results(%0)
}
@@ -574,8 +574,8 @@ def IRDL_AnyOfOp : IRDL_ConstraintOp<"any_of",
Example:
```mlir
- irdl.dialect cmath {
- irdl.type complex {
+ irdl.dialect @cmath {
+ irdl.type @complex {
%0 = irdl.is i32
%1 = irdl.is i64
%2 = irdl.is f32
@@ -607,8 +607,8 @@ def IRDL_AllOfOp : IRDL_ConstraintOp<"all_of",
Example:
```mlir
- irdl.dialect cmath {
- irdl.type complex_f32 {
+ irdl.dialect @cmath {
+ irdl.type @complex_f32 {
%0 = irdl.is i32
%1 = irdl.is f32
%2 = irdl.any_of(%0, %1) // is 32-bit
More information about the Mlir-commits
mailing list