ai.onnx.ReduceL2
ai.onnx · standard ONNX operator · ONNX opset ≥ 18
Description
Computes the L2 norm (Euclidean norm) of the input tensor along the specified axes: sqrt(sum(x^2)). The output rank matches the input when keepdims is 1; otherwise reduced dimensions are pruned. Reduction over an empty set of values yields 0.
See the ONNX ReduceL2 spec for the reference semantics.
Inputs
| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
|---|---|---|---|---|---|---|
x |
data |
T |
— | — | Input tensor to reduce. | required |
Outputs
| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
|---|---|---|---|---|---|---|
y |
reduced |
T |
derived | — | Reduced output tensor containing the L2 norm along the specified axes. | required |
Attributes
Default values (overridable per request):
| Attribute | Default | Description |
|---|---|---|
axes |
[] |
Values of the optional ONNX axes tensor input, supplied through this request attribute; an empty list follows noop_with_empty_axes. |
keepdims |
1 |
If 1, retains reduced dimensions with size 1 in the output; if 0, removed dimensions are pruned. |
noop_with_empty_axes |
0 |
When 1 and axes is empty, skips reduction but still applies the elementwise square and square-root steps, yielding abs(x); when 0 (default), reduces over all axes. |
Type constraints
| Variable | Allowed dtypes |
|---|---|
T |
float32, float16, int32 |
Implementation variants
One implementation is selected per call from the device capabilities, the request shapes and the dtypes; these notes say what each one covers.
strided_axis_serial— Flatten a single non-last reduction axis into outer/axis/inner geometry. Compile its strides and loop bound, keep one output per lane and float32 accumulation, and cap the workgroup by the device limits.
Device requirements
Some implementation variants require subgroups. These are route-specific capabilities, not package-wide requirements; availability also depends on the request shape and dtype.
Files
metadata.json— kernel metadata (id, digests, per-variant templates, provenance)manifest.json— the op contract (source of truth)test.json— correctness casesbench.json— benchmark + tuning casesreduce-axis-split-reduce.wgsl.jinjareduce-axis0-splitk-combine.wgsl.jinjareduce-axis0-splitk-reduce.wgsl.jinjareduce-axis0-tilecols.wgsl.jinjareduce-flat-partial.wgsl.jinjareduce-multi-axis-coop.wgsl.jinjareduce-noop-empty-axes.wgsl.jinjareduce-row-subgroup-rows.wgsl.jinjareduce-row-subgroup.wgsl.jinjareduce-row-tree.wgsl.jinjareduce-serial-axis.wgsl.jinjareduce-strided-axis.wgsl.jinja
Use with @huggingface/kernels
npm install --save-exact @huggingface/kernels@0.0.1-preview.2
Outputs with inferable metadata are allocated automatically. Explicit outputs entries request optional results or provide metadata that cannot be inferred from the supplied inputs and attributes.
This example supplies explicit metadata for:
y
The version: 1 option selects the published kernel contract; it is independent of any operator opset, contrib since_version, or model version.
It follows the v1 branch as fixes land. To pin exact artifact bytes, pass a 40-character commit revision instead of 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.ReduceL2", { version: 1 });
// Explicit destinations request optional results or supply metadata that cannot be inferred.
const { y } = await kernel({ x: { data: xData, shape: [] } }, {
outputs: { y: { shape: [], dtype: "float32" } },
});
- Downloads last month
- -
Requires WebGPU support. See the compatibility table.