[Mlir-commits] [mlir] 69cd6ae - [mlir][linalg][nfc] Clarify the description of linalg.matmul

[Andrzej Warzynski]

Author: Andrzej Warzynski
Date: 2023-08-02T12:54:26Z
New Revision: 69cd6ae02c4404e3d01581eee79b8e38b6ef6c09

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

LOG: [mlir][linalg][nfc] Clarify the description of linalg.matmul

Differential Revision: https://reviews.llvm.org/D156876

Added: 
    

Modified: 
    mlir/include/mlir/Dialect/Linalg/IR/LinalgNamedStructuredOps.yaml

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Dialect/Linalg/IR/LinalgNamedStructuredOps.yaml b/mlir/include/mlir/Dialect/Linalg/IR/LinalgNamedStructuredOps.yaml
index 10de4e2811eb44..bb5e9e3ffba1e2 100644
--- a/mlir/include/mlir/Dialect/Linalg/IR/LinalgNamedStructuredOps.yaml
+++ b/mlir/include/mlir/Dialect/Linalg/IR/LinalgNamedStructuredOps.yaml
@@ -668,10 +668,14 @@ metadata: !LinalgOpMetadata
   name: matmul
   cpp_class_name: MatmulOp
   doc: |-
-    Performs a matrix multiplication of two 2D inputs.
+    Performs an accumulative (C += A*B) matrix multiplication of two 2D inputs.
 
     Numeric casting is performed on the operands to the inner multiply, promoting
     them to the same data type as the accumulator/output.
+
+    Note this operation represents an accumulative matrix multiplication, `C +=
+    A*B` (as opposed to `C = A*B`). The appropriate initialisation of the output
+    matrix should be done prior to calling this Op.
   implements:
   - LinalgContractionOpInterface
 structured_op: !LinalgStructuredOpConfig