[MLIR] Documentation updates and typo fixes (#125273)
This commit is contained in:
parent
ccbbb1722f
commit
3266f9c3d6
@ -248,7 +248,7 @@ To declare a variadic operand that has a variadic number of sub-ranges, wrap the
|
|||||||
`TypeConstraint` for the operand with `VariadicOfVariadic<...,
|
`TypeConstraint` for the operand with `VariadicOfVariadic<...,
|
||||||
"<segment-attribute-name>">`.
|
"<segment-attribute-name>">`.
|
||||||
|
|
||||||
The second field of the `VariadicOfVariadic` is the name of an `I32ElementsAttr`
|
The second field of the `VariadicOfVariadic` is the name of a `DenseI32ArrayAttr`
|
||||||
argument that contains the sizes of the variadic sub-ranges. This attribute will
|
argument that contains the sizes of the variadic sub-ranges. This attribute will
|
||||||
be used when determining the size of sub-ranges, or when updating the size of
|
be used when determining the size of sub-ranges, or when updating the size of
|
||||||
sub-ranges.
|
sub-ranges.
|
||||||
@ -906,11 +906,12 @@ declarative parameter to `parse` method argument is detailed below:
|
|||||||
- Variadic: `SmallVectorImpl<Type> &`
|
- Variadic: `SmallVectorImpl<Type> &`
|
||||||
- VariadicOfVariadic: `SmallVectorImpl<SmallVector<Type>> &`
|
- VariadicOfVariadic: `SmallVectorImpl<SmallVector<Type>> &`
|
||||||
* `attr-dict` Directive: `NamedAttrList &`
|
* `attr-dict` Directive: `NamedAttrList &`
|
||||||
|
* `prop-dict` Directive: `OperationState &`
|
||||||
|
|
||||||
When a variable is optional, the value should only be specified if the variable
|
When a variable is optional, the value should only be specified if the variable
|
||||||
is present. Otherwise, the value should remain `None` or null.
|
is present. Otherwise, the value should remain `None` or null.
|
||||||
|
|
||||||
The arguments to the `print<UserDirective>` method is firstly a reference to the
|
The arguments to the `print<UserDirective>` method are firstly a reference to the
|
||||||
`OpAsmPrinter`(`OpAsmPrinter &`), second the op (e.g. `FooOp op` which can be
|
`OpAsmPrinter`(`OpAsmPrinter &`), second the op (e.g. `FooOp op` which can be
|
||||||
`Operation *op` alternatively), and finally a set of output parameters
|
`Operation *op` alternatively), and finally a set of output parameters
|
||||||
corresponding to the parameters specified in the format. The mapping of
|
corresponding to the parameters specified in the format. The mapping of
|
||||||
@ -940,6 +941,7 @@ declarative parameter to `print` method argument is detailed below:
|
|||||||
- Variadic: `TypeRange`
|
- Variadic: `TypeRange`
|
||||||
- VariadicOfVariadic: `TypeRangeRange`
|
- VariadicOfVariadic: `TypeRangeRange`
|
||||||
* `attr-dict` Directive: `DictionaryAttr`
|
* `attr-dict` Directive: `DictionaryAttr`
|
||||||
|
* `prop-dict` Directive: `FooOp::Properties`
|
||||||
|
|
||||||
When a variable is optional, the provided value may be null. When a variable is
|
When a variable is optional, the provided value may be null. When a variable is
|
||||||
referenced in a custom directive parameter using `ref`, it is passed in by
|
referenced in a custom directive parameter using `ref`, it is passed in by
|
||||||
|
@ -8,10 +8,9 @@ mechanism which abstracts implementation details and properties that are common
|
|||||||
across many different attributes/operations/types/etc.. `Traits` may be used to
|
across many different attributes/operations/types/etc.. `Traits` may be used to
|
||||||
specify special properties and constraints of the object, including whether an
|
specify special properties and constraints of the object, including whether an
|
||||||
operation has side effects or that its output has the same type as the input.
|
operation has side effects or that its output has the same type as the input.
|
||||||
Some examples of operation traits are `Commutative`, `SingleResult`,
|
Some examples of operation traits are `Commutative`, `Terminator`, etc. See the
|
||||||
`Terminator`, etc. See the more comprehensive list of
|
more comprehensive list of [operation traits](#operation-traits-list) below for
|
||||||
[operation traits](#operation-traits-list) below for more examples of what is
|
more examples of what is possible.
|
||||||
possible.
|
|
||||||
|
|
||||||
## Defining a Trait
|
## Defining a Trait
|
||||||
|
|
||||||
|
@ -481,7 +481,7 @@ def MemRefLayoutAttrInterface : AttrInterface<"MemRefLayoutAttrInterface"> {
|
|||||||
Note: the MemRef type's layout is assumed to represent simple strided buffer
|
Note: the MemRef type's layout is assumed to represent simple strided buffer
|
||||||
layout. For more complicated case, like sparse storage buffers,
|
layout. For more complicated case, like sparse storage buffers,
|
||||||
it is preferable to use separate type with more specic layout, rather then
|
it is preferable to use separate type with more specic layout, rather then
|
||||||
introducing extra complexity to the builin MemRef type.
|
introducing extra complexity to the builtin MemRef type.
|
||||||
}];
|
}];
|
||||||
|
|
||||||
let methods = [
|
let methods = [
|
||||||
|
@ -808,9 +808,9 @@ static std::optional<SymbolTable::UseRange> getSymbolUsesImpl(SymbolT symbol,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Get all of the uses of the given symbol that are nested within the given
|
/// Get all of the uses of the given symbol that are nested within the given
|
||||||
/// operation 'from', invoking the provided callback for each. This does not
|
/// operation 'from'. This does not traverse into any nested symbol tables.
|
||||||
/// traverse into any nested symbol tables. This function returns std::nullopt
|
/// This function returns std::nullopt if there are any unknown operations that
|
||||||
/// if there are any unknown operations that may potentially be symbol tables.
|
/// may potentially be symbol tables.
|
||||||
auto SymbolTable::getSymbolUses(StringAttr symbol, Operation *from)
|
auto SymbolTable::getSymbolUses(StringAttr symbol, Operation *from)
|
||||||
-> std::optional<UseRange> {
|
-> std::optional<UseRange> {
|
||||||
return getSymbolUsesImpl(symbol, from);
|
return getSymbolUsesImpl(symbol, from);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user