torch-mlir/include/npcomp/Dialect/Torch/IR/GeneratedPrimOps.td

212 lines
5.8 KiB
TableGen
Raw Normal View History

Significantly restructure torch/aten import design. This is a really major and invasive restructuring of the way we get torch operators (`torch::jit::Operator` / `c10::OperatorHandle`) into MLIR. Please forgive the challenging review, but due to the sheer invasiveness, it wasn't really practical do do it in sane smaller pieces. This fully replaces everything that was already working on the TorchScript path (actually, more -- we added tanh support to TorchToLinalg in order to delete the older code paths). Additionally, I've kept the lights on for the acap path too, including what little e2e stuff was working before (for expediency I made a few tiny compromises along the way that will be easy to undo when we give that path proper attention). Overview of the new design: - The torch operator `somens::someunqualname.someoverloadname` is imported as `torch.somens.someunqualname.someoverloadname` (skip the last dotted part if the overload name is empty), OR, if we don't have such an op registered, it is imported as `torch.operator "somens.someunqualname.someoverloadname" (...) : ...`. - The addition of the "overload name" is a critical element here, as the `(ns,unqual,overload)` triple is unique, which solves a lot of problems we were having. - This involves having separate MLIR ops for the `trailing_` and `.out` variants and all the different overloads. This seemed necessary, because the set of overloads is so wild and varied and unstructured. The previous design was leaning into some underlying structure that just isn't there -- the default situation is the "random overload that we want to manage on the MLIR side", rather than that being an exception. E.g. `aten::ne` (not-equal) has 21 overloads, only 4 of which are c10 dispatcher ops see [gist](https://gist.github.com/silvasean/190ba918c550c956260e21254e1b8aa1), and the "out" variant is really called `.Tensor_out` instead of `.out` as it frequently is for other ops. - Rationale for all being in `torch` namespace: the set of operators are so varied and unstructured that "dialect per namespace" doesn't result in anything resembling the typical MLIR dialect boundary expectations. We could maybe draw the boundary at dispatcher ops vs non-dispatcher ops, but that doesn't seem to really result in very much useful structure at this point in time. - Note: within the torch operator registry, we effectively have a mini-basicpy subdialect (already type-resolved), which is reasonably structured. - The existing Torch op interfaces are also removed -- now that we track the overload name, we can losslessly find the original operator. - Instead of `ATenRecognizeKernelsPass`, we now have a `ReduceOpVariantsPass` that keys off certain traits (and perhaps eventually interfaces) to reduce variants of ops to a smaller set, ideally operating on immutable tensors and using surrounding ops to model the mutability/aliasing aspects. - Note: `torch.ns.unqual.overload` ops allow both immutable and mutable tensors (unlike the previous hard distinction in the common case). This is a premonition for a future change that will introduce a bona fide `!torch.tensor` type that will clean up a bunch of stuff. - `TorchToLinalg` / `TorchToStd` supercede the existing "ATen->TCF->TCP->Linalg" path. - The new `torch_ods_gen.py` supercedes `torch_signature_ods_gen.py`. It should look somewhat familiar, but the benefit of hindsight has allowed a lot of simplifications. The overall trend seems to be to make the `torch` dialect a nice layer independent of anything else. It feels like as a natural result of various future changes we will be removing the reliance on basicpy+numpy dialects and have a nice self-contained type system too that properly models the TorchScript type system (including proper subtyping, mutable/immutable tensors, optional dtype, etc.). Recommended review order: - Start at some of the new import IR, e.g. in `frontends/pytorch/test/node_import/prim.py`, `frontends/pytorch/test/acap_export/test_export_add3.py`, and other tests. - `frontends/pytorch/python/torch_mlir_utils/codegen/torch_ods_gen.py` and associated generated files: - `include/npcomp/Dialect/Torch/IR/GeneratedAtenOps.td` - `include/npcomp/Dialect/Torch/IR/GeneratedPrimOps.td` - Inspect `ReduceOpVariants.cpp` / `reduce-op-variants.mlir` and the new traits in `include/npcomp/Dialect/Torch/IR/TorchTraits.h` - Various code changes in the import path in `frontends/pytorch/csrc/builder`. Probably most interesting is the new code in `torch_to_mlir_utils.cpp` that has the logic to create the `torch.operator` ops or `torch.ns.unqual.overload` ops. This is the [new ResNet IR](https://gist.github.com/silvasean/5407aafb710d07612b7b5b92eabecebe), just to be able to look at a substantial sample of IR in the new style.
2021-05-05 05:42:50 +08:00
//===-------------------------------------------------------*- tablegen -*-===//
//
// This file is licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
// Operation summaries and descriptions were systematically derived from public
// API docstrings and are licensed accordingly:
// https://github.com/pytorch/pytorch/blob/master/LICENSE
//===----------------------------------------------------------------------===//
//
// This file is automatically generated. Please do not edit.
// Generated via:
// python -m torch_mlir_utils.codegen.torch_ods_gen
//
//===----------------------------------------------------------------------===//
def Torch_PrimLayoutOp : Torch_Op<"prim.layout", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::layout : (Tensor) -> (int)`";
let arguments = (ins
AnyTorchTensorType:$a
);
let results = (outs
AnyTorchIntType:$result
);
let assemblyFormat = "$a attr-dict `:` type($a) `->` type($result)";
}
def Torch_PrimTupleIndexOp : Torch_Op<"prim.TupleIndex", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::TupleIndex : (Any, int) -> (Any)`";
let arguments = (ins
AnyTorchType:$tup,
AnyTorchIntType:$i
);
let results = (outs
AnyTorchType:$result
);
let assemblyFormat = "$tup `,` $i attr-dict `:` type($tup) `,` type($i) `->` type($result)";
}
def Torch_PrimDeviceOp : Torch_Op<"prim.device", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::device : (Tensor) -> (Device)`";
let arguments = (ins
AnyTorchTensorType:$a
);
let results = (outs
Torch_DeviceType:$result
);
let assemblyFormat = "$a attr-dict `:` type($a) `->` type($result)";
}
def Torch_PrimDtypeOp : Torch_Op<"prim.dtype", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::dtype : (Tensor) -> (int)`";
let arguments = (ins
AnyTorchTensorType:$a
);
let results = (outs
AnyTorchIntType:$result
);
let assemblyFormat = "$a attr-dict `:` type($a) `->` type($result)";
}
def Torch_PrimTupleUnpackOp : Torch_Op<"prim.TupleUnpack", [
AllowsTypeRefinement
]> {
let summary = "Generated op for `prim::TupleUnpack : (Any) -> (...)`";
let arguments = (ins
AnyTorchType:$tup
);
let results = (outs
Variadic<AnyTorchType>:$results
);
let assemblyFormat = "$tup attr-dict `:` type($tup) `->` type($results)";
}
def Torch_PrimNumToTensorScalarOp : Torch_Op<"prim.NumToTensor.Scalar", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::NumToTensor.Scalar : (Scalar) -> (Tensor)`";
let arguments = (ins
AnyTorchScalarType:$a
);
let results = (outs
AnyTorchTensorType:$result
);
let assemblyFormat = "$a attr-dict `:` type($a) `->` type($result)";
}
def Torch_PrimMinSelfIntOp : Torch_Op<"prim.min.self_int", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::min.self_int : (int[]) -> (int)`";
let arguments = (ins
AnyTorchIntListType:$self
);
let results = (outs
AnyTorchIntType:$result
);
let assemblyFormat = "$self attr-dict `:` type($self) `->` type($result)";
}
def Torch_PrimMinIntOp : Torch_Op<"prim.min.int", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::min.int : (int, int) -> (int)`";
let arguments = (ins
AnyTorchIntType:$a,
AnyTorchIntType:$b
);
let results = (outs
AnyTorchIntType:$result
);
let assemblyFormat = "$a `,` $b attr-dict `:` type($a) `,` type($b) `->` type($result)";
}
def Torch_PrimMaxSelfIntOp : Torch_Op<"prim.max.self_int", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::max.self_int : (int[]) -> (int)`";
let arguments = (ins
AnyTorchIntListType:$self
);
let results = (outs
AnyTorchIntType:$result
);
let assemblyFormat = "$self attr-dict `:` type($self) `->` type($result)";
}
def Torch_PrimMaxIntOp : Torch_Op<"prim.max.int", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::max.int : (int, int) -> (int)`";
let arguments = (ins
AnyTorchIntType:$a,
AnyTorchIntType:$b
);
let results = (outs
AnyTorchIntType:$result
);
let assemblyFormat = "$a `,` $b attr-dict `:` type($a) `,` type($b) `->` type($result)";
}
def Torch_PrimRaiseExceptionOp : Torch_Op<"prim.RaiseException", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::RaiseException : (str) -> ()`";
let arguments = (ins
Basicpy_BytesType:$msg
);
let results = (outs
);
let assemblyFormat = "$msg attr-dict `:` type($msg)";
}
def Torch_PrimUninitializedOp : Torch_Op<"prim.Uninitialized", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::Uninitialized : () -> (Any)`";
let arguments = (ins
);
let results = (outs
AnyTorchType:$result
);
let assemblyFormat = " attr-dict `:` type($result)";
}
def Torch_PrimUncheckedCastOp : Torch_Op<"prim.unchecked_cast", [
AllowsTypeRefinement,
HasValueSemantics
]> {
let summary = "Generated op for `prim::unchecked_cast : (t) -> (t)`";
let arguments = (ins
AnyTorchType:$x
);
let results = (outs
AnyTorchType:$result
);
let assemblyFormat = "$x attr-dict `:` type($x) `->` type($result)";
}
def Torch_PrimPrintOp : Torch_Op<"prim.Print", [
AllowsTypeRefinement
]> {
let summary = "Generated op for `prim::Print : (...) -> ()`";
let arguments = (ins
Variadic<AnyTorchType>:$operands
);
let results = (outs
);
let assemblyFormat = "`(` $operands `)` attr-dict `:` type($operands)";
}