[Mlir-commits] [mlir] 4d9fac6 - [mlir][Linalg] NFC: Add missing comments from earlier commit (D77965)

[llvmlistbot at llvm.org]

Author: MaheshRavishankar
Date: 2020-04-14T12:15:42-07:00
New Revision: 4d9fac6da5501727eaf19a8d50044a5adcbd433d

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

LOG: [mlir][Linalg] NFC: Add missing comments from earlier commit (D77965)

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

Added: 
    

Modified: 
    mlir/include/mlir/Dialect/Linalg/Transforms/LinalgTransforms.h

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Dialect/Linalg/Transforms/LinalgTransforms.h b/mlir/include/mlir/Dialect/Linalg/Transforms/LinalgTransforms.h
index 4340366845c1..c65909ec979e 100644
--- a/mlir/include/mlir/Dialect/Linalg/Transforms/LinalgTransforms.h
+++ b/mlir/include/mlir/Dialect/Linalg/Transforms/LinalgTransforms.h
@@ -49,10 +49,10 @@ bool isProducedByOpOfType(Operation *consumerOp, Value consumedView) {
 // success.
 ////////////////////////////////////////////////////////////////////////////////
 
-/// Tiles `op` by `sizes` permuting the loops according to `permutation`
-/// and sets the attribute `kLinalgTransformMarker` to `linalgMarker`.
-/// The permutation is expressed as a list of integers that specify
-/// the new ordering of the loop nest. The length of `permutation`
+/// Tiles `op` by `sizes` permuting the loops according to `permutation` and
+/// sets the attribute `kLinalgTransformMarker` to `linalgMarker`.  The
+/// permutation is expressed as a list of integers that specify the new ordering
+/// of the loop nest (using loop.for operations). The length of `permutation`
 /// must be equal to the length of `tileSizes`.
 /// E.g. the permutation `(i,j,k) -> (j,k,i)` will be expressed with
 /// `permutation = [1,2,0]`. All values in `permutation` must be
@@ -63,6 +63,9 @@ LogicalResult tileLinalgOpAndSetMarker(PatternRewriter &rewriter, Operation *op,
                                        ArrayRef<int64_t> sizes,
                                        StringRef linalgMarker,
                                        ArrayRef<unsigned> permutation);
+
+/// Tiles ops similar to `tileLinalgOpAndSetMarker` but generates loop.parallel
+/// operations instead.
 LogicalResult tileLinalgOpToParallelLoopsAndSetMarker(
     PatternRewriter &rewriter, Operation *op, ArrayRef<int64_t> sizes,
     StringRef linalgMarker, ArrayRef<unsigned> permutation);
@@ -72,6 +75,9 @@ LogicalResult tileLinalgOpToParallelLoopsAndSetMarker(
 LogicalResult tileAndFuseLinalgOpAndSetMarker(
     PatternRewriter &rewriter, Operation *op, ArrayRef<int64_t> sizes,
     ArrayRef<int64_t> operandIndicesToFuse, StringRef linalgMarker);
+
+/// Tiles ops similar to `tileAndFuseLinalgOpAndSetMarker` but generates
+/// loop.parallel operations instead.
 LogicalResult tileAndFuseLinalgOpToParallelLoopsAndSetMarker(
     PatternRewriter &rewriter, Operation *op, ArrayRef<int64_t> sizes,
     ArrayRef<int64_t> operandIndicesToFuse, StringRef linalgMarker);