[Mlir-commits] [mlir] fb62a18 - [mlir][ArmSME] Update docs (#74527)

[llvmlistbot at llvm.org]

Author: Andrzej Warzyński
Date: 2023-12-06T21:35:23Z
New Revision: fb62a18615d28694f1a16a3e23915190703a2e98

URL: https://github.com/llvm/llvm-project/commit/fb62a18615d28694f1a16a3e23915190703a2e98
DIFF: https://github.com/llvm/llvm-project/commit/fb62a18615d28694f1a16a3e23915190703a2e98.diff

LOG: [mlir][ArmSME] Update docs (#74527)

Added: 
    

Modified: 
    mlir/docs/Dialects/ArmSME.md

Removed: 
    


################################################################################
diff  --git a/mlir/docs/Dialects/ArmSME.md b/mlir/docs/Dialects/ArmSME.md
index 505b52938eacc..7326150bcd115 100644
--- a/mlir/docs/Dialects/ArmSME.md
+++ b/mlir/docs/Dialects/ArmSME.md
@@ -1,13 +1,29 @@
 # '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 conversion and
+ArmSME passes you 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