ai.onnx.Einsum

ai.onnx · standard ONNX operator · ONNX opset ≥ 12

Description

Evaluates algebraic tensor operations using the Einstein summation convention, specified by an equation string of the form term1,term2,...->output-term. Output elements are computed as the product of the input operands summed over any indices that appear in the input terms but not in the output term; if no -> is given, output indices are the alphabetically sorted set of indices that appear exactly once across all terms.

See the ONNX Einsum spec for the reference semantics.

Inputs

Outputs

Attributes

Attributes and default values (overridable per request):

Type constraints

Device requirements

Some implementation variants require subgroup-matrix and 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, provenance)
• manifest.json — the op contract (source of truth)
• test.json — correctness cases
• bench.json — benchmark + tuning cases
• datamove-elementwise-copy.wgsl.jinja
• dot-splitk-partial.wgsl.jinja
• einsum-4d-contract.wgsl.jinja
• einsum-ab-ba-ab.wgsl.jinja
• einsum-abc-contract.wgsl.jinja
• einsum-batch-diagonal-iij-j.wgsl.jinja
• einsum-batch-diagonal.wgsl.jinja
• einsum-batch-matmul.wgsl.jinja
• einsum-batch-reduce-all-split-scalar.wgsl.jinja
• einsum-batch-reduce-all-split.wgsl.jinja
• einsum-batch-reduce-all.wgsl.jinja
• einsum-batch-reduce-last.wgsl.jinja
• einsum-bilinear-split.wgsl.jinja
• einsum-diag-matmul-iij-jk.wgsl.jinja
• einsum-diagonal-extract.wgsl.jinja
• einsum-diagonal-iji-reduce.wgsl.jinja
• einsum-indexed-2d-output.wgsl.jinja
• einsum-matmul.wgsl.jinja
• einsum-mul.wgsl.jinja
• einsum-nd-generic.wgsl.jinja
• einsum-reduce-cols-splitk-cooperative.wgsl.jinja
• einsum-reduce-middle-transpose.wgsl.jinja
• einsum-reduce-rows.wgsl.jinja
• einsum-serial-scalar.wgsl.jinja
• einsum-transpose.wgsl.jinja
• matmul-subgroup-matrix-ext.wgsl.jinja
• matmul-tiled-general-reg.wgsl.jinja
• matmul-tiled-general.wgsl.jinja
• matmul-vector-matrix-vec4.wgsl.jinja
• reduce-axis0-splitk-combine.wgsl.jinja
• reduce-axis0-splitk-reduce.wgsl.jinja
• reduce-flat-partial.wgsl.jinja

Use with @huggingface/kernels

The loader automatically allocates outputs whose metadata it can derive from the manifest contract and this call.

The explicit outputs entries provide shape and logical dtype metadata for the results listed below:

• y

Each entry either requests an optional result or supplies metadata that cannot be inferred from the inputs.

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.Einsum", { version: 1 });
// Explicit destinations request optional results or supply metadata that cannot be inferred.
const { y } = await kernel({ a: { data: aData, shape: [2, 3] }, b: { data: bData, shape: [3, 2] } }, {
  attrs: { equation: "ij,jk->ik" },
  outputs: { y: { shape: [2, 2], dtype: "float32" } },
});