Skip to content

[mlir][irdl] update documentation #103394

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 1 commit into from
Sep 1, 2024
Merged

Conversation

tim-hoffman
Copy link
Contributor

fixes #103300

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot
Copy link
Member

llvmbot commented Aug 13, 2024

@llvm/pr-subscribers-mlir-irdl

@llvm/pr-subscribers-mlir

Author: Timothy Hoffman (tim-hoffman)

Changes

fixes #103300


Full diff: https://github.com/llvm/llvm-project/pull/103394.diff

3 Files Affected:

  • (modified) mlir/include/mlir/Dialect/IRDL/IR/IRDL.td (+5-5)
  • (modified) mlir/include/mlir/Dialect/IRDL/IR/IRDLOps.td (+10-10)
  • (modified) mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td (+2-2)
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..89a5b5b58439ba 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)
       }
@@ -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)
       }
@@ -472,7 +472,7 @@ def IRDL_BaseOp : IRDL_ConstraintOp<"base",
       }
 
       irdl.type @complex_wrapper {
-        %0 = irdl.base @complex
+        %0 = irdl.base @cmath::@complex
         irdl.parameters(%0)
       }
     }
@@ -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
@@ -588,7 +588,7 @@ def IRDL_AnyOfOp : IRDL_ConstraintOp<"any_of",
 
     The above program defines a type `complex` inside the dialect `cmath` that
     can have a single type parameter that can be either `i32`, `i64`, `f32` or
-    `f32`.
+    `f64`.
   }];
 
   let arguments = (ins Variadic<IRDL_AttributeType>:$args);
@@ -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
diff --git a/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td b/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td
index 2fcf1b41ffd78f..9b17bf23df1825 100644
--- a/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td
+++ b/mlir/include/mlir/Dialect/IRDL/IR/IRDLTypes.td
@@ -32,13 +32,13 @@ def IRDL_AttributeType : IRDL_Type<"Attribute", "attribute"> {
     Example:
 
     ```mlir
-    irdl.dialect cmath {
+    irdl.dialect @cmath {
 
       irdl.type @complex { /* ... */ }
 
       irdl.operation @norm {
         %0 = irdl.any
-        %1 = irdl.parametric @complex<%0>
+        %1 = irdl.parametric @cmath::@complex<%0>
         irdl.operands(%1)
         irdl.results(%0)
       }

@math-fehr math-fehr self-requested a review August 13, 2024 18:59
Copy link
Contributor

@math-fehr math-fehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for updating this!!

@CoTinker
Copy link
Contributor

Hi, is this PR ready to merge?

@math-fehr
Copy link
Contributor

Hi, very sorry, I thought I merged it already!

@math-fehr math-fehr merged commit 84580a0 into llvm:main Sep 1, 2024
11 checks passed
@math-fehr
Copy link
Contributor

Thanks for pinging!

Copy link

github-actions bot commented Sep 1, 2024

@tim-hoffman Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

@tim-hoffman tim-hoffman deleted the th/103300 branch December 17, 2024 04:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[mlir][irdl] documentation is outdated
4 participants