Skip to content

Commit 90541b3

Browse files
jungmairDocs Action Bot
andauthored
Generated docs (#5)
* Update MLIR dialect documentation * Update MLIR dialect documentation --------- Co-authored-by: Docs Action Bot <[email protected]>
1 parent a913dc9 commit 90541b3

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

docs/ForDevelopers/MLIR/Dialects/Arrow/ArrowDialect.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,11 @@ operation ::= `arrow.array.is_valid` $array `,` $offset attr-dict
2323
```
2424

2525

26-
Interfaces: `InferTypeOpInterface`
26+
Traits: `AlwaysSpeculatableImplTrait`
27+
28+
Interfaces: `ConditionallySpeculatable`, `InferTypeOpInterface`, `NoMemoryEffect (MemoryEffectOpInterface)`
29+
30+
Effects: `MemoryEffects::Effect{}`
2731

2832
#### Operands:
2933

@@ -52,7 +56,11 @@ operation ::= `arrow.array.load_bool` $array `,` $offset attr-dict
5256

5357
This special operation is necessary, since Arrow stores boolean values as bitset, and not individual bytes.
5458

55-
Interfaces: `InferTypeOpInterface`
59+
Traits: `AlwaysSpeculatableImplTrait`
60+
61+
Interfaces: `ConditionallySpeculatable`, `InferTypeOpInterface`, `NoMemoryEffect (MemoryEffectOpInterface)`
62+
63+
Effects: `MemoryEffects::Effect{}`
5664

5765
#### Operands:
5866

@@ -82,6 +90,12 @@ operation ::= `arrow.array.load_fixed_sized` $array `,` $offset `->` type($value
8290
Used for loading types that are of fixed size from an arrow array (e.g., integers, floats, decimals, dates, timestamp).
8391
There are now runtime checks to ensure that the type of the value matches the type of the array, so this operation can be used for any fixed sized type.
8492

93+
Traits: `AlwaysSpeculatableImplTrait`
94+
95+
Interfaces: `ConditionallySpeculatable`, `NoMemoryEffect (MemoryEffectOpInterface)`
96+
97+
Effects: `MemoryEffects::Effect{}`
98+
8599
#### Operands:
86100

87101
| Operand | Description |
@@ -110,7 +124,11 @@ operation ::= `arrow.array.load_variable_size_binary` $array `,` $offset `->` ty
110124
Used for loading variable sized binary values from an arrow array (e.g., strings, binary data).
111125
It returns both a pointer to the data and the length of the data.
112126

113-
Interfaces: `InferTypeOpInterface`
127+
Traits: `AlwaysSpeculatableImplTrait`
128+
129+
Interfaces: `ConditionallySpeculatable`, `InferTypeOpInterface`, `NoMemoryEffect (MemoryEffectOpInterface)`
130+
131+
Effects: `MemoryEffects::Effect{}`
114132

115133
#### Operands:
116134

@@ -209,7 +227,11 @@ operation ::= `arrow.array_builder.from_ptr` $ptr `->` type($builder) attr-dict
209227
```
210228

211229

212-
Interfaces: `InferTypeOpInterface`
230+
Traits: `AlwaysSpeculatableImplTrait`
231+
232+
Interfaces: `ConditionallySpeculatable`, `InferTypeOpInterface`, `NoMemoryEffect (MemoryEffectOpInterface)`
233+
234+
Effects: `MemoryEffects::Effect{}`
213235

214236
#### Operands:
215237

docs/ForDevelopers/MLIR/Dialects/SubOperator/SubOperatorDialect.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ Effects: `MemoryEffects::Effect{}`
496496

497497
### `subop.gather` (::lingodb::compiler::dialect::subop::GatherOp)
498498

499-
_Scatter_
499+
_Gather_
500500

501501

502502
Syntax:
@@ -806,6 +806,8 @@ Interfaces: `InferTypeOpInterface`, `StateUsingSubOperator`, `SubOperator`
806806

807807
_Performs a lookup in a state and annotates the result as attribute_
808808

809+
Currently LookupOp returns an optional reference when the state is a map structure.
810+
It is therefore necessary to combine it with an UnwrapOptionalRefOp
809811

810812
Interfaces: `InferTypeOpInterface`, `ReferenceProducer`, `StateUsingSubOperator`, `SubOperator`
811813

0 commit comments

Comments
 (0)