-
Notifications
You must be signed in to change notification settings - Fork 14.3k
[mlir][ArmSME] Update docs #74527
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
[mlir][ArmSME] Update docs #74527
Conversation
@llvm/pr-subscribers-mlir Author: Andrzej Warzyński (banach-space) ChangesFull diff: https://github.com/llvm/llvm-project/pull/74527.diff 1 Files Affected:
diff --git a/mlir/docs/Dialects/ArmSME.md b/mlir/docs/Dialects/ArmSME.md
index 505b52938eacc..4af1594c3933c 100644
--- a/mlir/docs/Dialects/ArmSME.md
+++ b/mlir/docs/Dialects/ArmSME.md
@@ -1,13 +1,28 @@
# 'ArmSME' Dialect
-[TOC]
+Basic dialect to target Arm SME.
+
+This dialect defines custom and LLVM IR intrinsic operations that are used to
+target Arm Scalable Matrix Extension. Through the available lowerings one can,
+for example, lower a [linalg.matmul](https://mlir.llvm.org/docs/Dialects/Linalg/#linalgmatmul-linalgmatmulop)
+opereation to Arm SME
+[FMOPA](https://developer.arm.com/documentation/ddi0602/2023-03/SME-Instructions/FMOPA--widening---Half-precision-floating-point-sum-of-outer-products-and-accumulate-)
+(floating point outer product) operations. See one of the in-tree end-to-end
+integration tests for reference:
+
+* [Linalg/CPU/ArmSME/matmul.mlir](https://github.com/llvm/llvm-project/blob/main/mlir/test/Integration/Dialect/Linalg/CPU/ArmSME/matmul.mlir)
+* [Vector/CPU/ArmSME/test-outerproduct-f64.mlir](https://github.com/llvm/llvm-project/blob/main/mlir/test/Integration/Dialect/Vector/CPU/ArmSME/test-outerproduct-f64.mlir)
-Basic dialect to target Arm SME architectures This dialect contains the
-definitions necessary to target Arm SME scalable matrix operations.
+These tests are run "post-commit" by the
+[clang-aarch64-sve-vla](https://lab.llvm.org/buildbot/#/builders/197) LLVM
+BuildBot worker.
-## References
-* https://developer.arm.com/documentation/ddi0616
-* https://developer.arm.com/documentation/ddi0602/2023-03/SME-Instructions
+**References:**
+
+* [The Scalable Matrix Extension (SME), for Armv9-A](https://developer.arm.com/documentation/ddi0616)
+* [A64 -- SME Instructions (alphabetic order)](https://developer.arm.com/documentation/ddi0602/2023-03/SME-Instructions)
+
+[TOC]
## Operations
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commit/PR tile nit: ArmSME
not just sme
([mlir][ArmSME] Update docs
)
LGTM, just a few nits:
mlir/docs/Dialects/ArmSME.md
Outdated
for example, lower a [linalg.matmul](https://mlir.llvm.org/docs/Dialects/Linalg/#linalgmatmul-linalgmatmulop) | ||
opereation to Arm SME | ||
[FMOPA](https://developer.arm.com/documentation/ddi0602/2023-03/SME-Instructions/FMOPA--widening---Half-precision-floating-point-sum-of-outer-products-and-accumulate-) | ||
(floating point outer product) operations. See one of the in-tree end-to-end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit:
(floating point outer product) operations. See one of the in-tree end-to-end | |
(floating-point outer product) operations. See one of the in-tree end-to-end |
Address comments from Ben
No description provided.