ai.onnx.Flatten
ai.onnx · standard ONNX operator · ONNX opset ≥ 13
Description
Flattens the input tensor into a 2-D matrix by splitting its dimensions at axis: dimensions before axis are collapsed into the first output dimension, and dimensions from axis onward into the second. For input shape (d_0, ..., d_n), the output shape is (d_0 * ... * d_{axis-1}, d_axis * ... * d_n).
See the ONNX Flatten spec for the reference semantics.
Inputs
| Name | Bind key | Logical dtype | Rank | Shape | Description | Presence |
|---|---|---|---|---|---|---|
input |
input |
T |
— | — | Input tensor to flatten into a matrix. | required |
Outputs
| Name | Bind key | Logical dtype | Rank | Shape | Description | Presence |
|---|---|---|---|---|---|---|
output |
output |
T |
2 |
derived; see description | A 2-D tensor whose outer dimension combines axes before axis and whose inner dimension combines the remaining axes. |
required |
Attributes
Default values (overridable per request):
| Attribute | Default | Description |
|---|---|---|
axis |
1 |
The axis at which to split the input dimensions (exclusive upper bound for the outer dimension). Must be in [-r, r] where r is the input rank; negative values count from the back. When axis = 0 the output shape is (1, total_elements). |
Type constraints
| Variable | Allowed dtypes |
|---|---|
T |
float32, float16, int32, uint32, int16, int8, uint8, bool |
Files
metadata.json— kernel metadata (id, digests, provenance)manifest.json— the op contract (source of truth)test.json— correctness casesbench.json— benchmark + tuning casesdatamove-elementwise-copy.wgsl.jinjadatamove-flat-copy.wgsl.jinja
Use with @huggingface/kernels
The loader derives every required output's shape and logical dtype from the manifest contract and this call. It then allocates the result tensors automatically.
The version: 1 option selects the published kernel contract; it is independent of any operator opset, contrib since_version, or model version.
Replace each *Data placeholder with a typed array containing the corresponding input data.
import { getKernel } from "@huggingface/kernels";
const kernel = await getKernel("webgpu-kernels/ai.onnx.Flatten", { version: 1 });
const { output } = await kernel({ input: { data: inputData, shape: [2, 1] } });
- Downloads last month
- -
Requires WebGPU support. See the compatibility table.