Skip to content

[mlir][tensor] Document dest operand #71726

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 6 commits into from
Nov 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 24 additions & 20 deletions mlir/include/mlir/Dialect/Tensor/IR/TensorBase.td
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,35 @@ def Tensor_Dialect : Dialect {
let description = [{
The `tensor` dialect is intended to hold core tensor creation and
manipulation ops, which are not strongly associated with any particular
other dialect or domain abstraction. The primary smoke test of this is ops
that make sense for any tensor element type.

We leave it to other dialects to hold the vast swath of possible
computations one might want to do on a tensor.

The `tensor` type is (for better or for worse) used to represent all kinds
of things, and supports an open-ended set of element types. Examples:
other dialect or domain abstraction. The aim for ops in this dialect is
that they make sense for any tensor element type. When this is not the
case, the op is left to live in other dialects. Examples of element types
that could be supported by the `tensor` dialect include:

- representing large, dense aggregations of primitive types, suitable for
high-performance numerical computing.
- representing shapes in the `shape` dialect, which consist of small
1D tensors of `index` data type.
- representing shapes in the `shape` dialect, which consist of small 1D
tensors of `index` data type.
- representing aggregations of strings or “variant” types.
- representing large, sparse aggregations of primitive types, suitable
for high-performance numerical computing.

Thus, for the `tensor` dialect, we prefer for now to constrain the
scope as much as possible. The expectation is that at some point
in the future, the `tensor` dialect’s scope may be broadened through a
careful discussion of the tradeoffs.

The `tensor` type is actually a builtin type (it lives in the builtin
dialect), and does not live in this dialect.
- representing large, sparse aggregations of primitive types, suitable for
high-performance numerical computing.

Because of this broad element type support and because of the existence of
more dedicated dialects, such as the `sparse_tensor` and `linalg` dialects,
we prefer for now to keep the `tensor` dialect as small as possible. The
expectation is that at some point in the future, the `tensor` dialect’s
scope may be broadened through a careful discussion of the tradeoffs.

On the `tensor` type itself, note that it is actually a builtin type (it
lives in the builtin dialect), and does not live in this dialect.
Furthermore, a `tensor` is an immutable object. For example, this means
that a copy will always be made of the `tensor` object when it is passed to
the `dest` operand used by some ops in this dialect. As an optimization,
an implementation can eliminate these copies during lowering when they
are redundant and perform in-place mutation, see the [Destination-Passing
Style](
https://mlir.llvm.org/docs/Bufferization/#destination-passing-style)
documentation for more information.
}];

let hasCanonicalizer = 1;
Expand Down