sync 91d990483a17

Browse files

Files changed (7) hide show

README.md +11 -7
build/webgpu/bench.json +0 -1
build/webgpu/manifest.json +92 -50
build/webgpu/metadata.json +15 -8
build/webgpu/test.json +1 -2
build/webgpu/unary-scalar.wgsl.jinja +18 -7
build/webgpu/unary-vec4.wgsl.jinja +27 -8

README.md CHANGED Viewed

@@ -18,15 +18,15 @@ See the [ONNX `Softplus` spec](https://onnx.ai/onnx/operators/onnx__Softplus.htm
 ## Inputs
-| Name | Bind key | Logical dtype | Rank | Shape | Description | Presence |
 | --- | --- | --- | --- | --- | --- | --- |
-| `X` | `x` | `T` | — | — | Values transformed elementwise by the smooth softplus activation. | required |
 ## Outputs
-| Name | Bind key | Logical dtype | Rank | Shape | Description | Presence |
 | --- | --- | --- | --- | --- | --- | --- |
-| `Y` | `y` | `T` | same as `X` | same as `X` | Output tensor with softplus applied elementwise; same shape as `X`. | required |
 ## Type constraints
@@ -36,7 +36,7 @@ See the [ONNX `Softplus` spec](https://onnx.ai/onnx/operators/onnx__Softplus.htm
 ## Files
-- [`metadata.json`](build/webgpu/metadata.json) — kernel metadata (id, digests, provenance)
 - [`manifest.json`](build/webgpu/manifest.json) — the op contract (source of truth)
 - [`test.json`](build/webgpu/test.json) — correctness cases
 - [`bench.json`](build/webgpu/bench.json) — benchmark + tuning cases
@@ -45,10 +45,14 @@ See the [ONNX `Softplus` spec](https://onnx.ai/onnx/operators/onnx__Softplus.htm
 ## 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.

 ## Inputs
+| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
 | --- | --- | --- | --- | --- | --- | --- |
+| `x` | `X` | `T` | — | — | Values transformed elementwise by the smooth softplus activation. | required |
 ## Outputs
+| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
 | --- | --- | --- | --- | --- | --- | --- |
+| `y` | `Y` | `T` | same as `x` | same as `x` | Output tensor with softplus applied elementwise; same shape as `X`. | required |
 ## Type constraints
 ## Files
+- [`metadata.json`](build/webgpu/metadata.json) — kernel metadata (id, digests, per-variant templates, provenance)
 - [`manifest.json`](build/webgpu/manifest.json) — the op contract (source of truth)
 - [`test.json`](build/webgpu/test.json) — correctness cases
 - [`bench.json`](build/webgpu/bench.json) — benchmark + tuning cases
 ## Use with `@huggingface/kernels`
+```sh
+npm install --save-exact @huggingface/kernels@0.0.1-preview.2
+```
+Required output shapes and logical data types are inferred from the supplied inputs and attributes; result tensors are allocated automatically.
 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.

build/webgpu/bench.json CHANGED Viewed

@@ -1,5 +1,4 @@
 {
-  "op": "ai.onnx.Softplus",
   "cases": [
     {
       "name": "1m_f32",

 {
   "cases": [
     {
       "name": "1m_f32",

build/webgpu/manifest.json CHANGED Viewed

@@ -2,30 +2,16 @@
   "domain": "ai.onnx",
   "name": "Softplus",
   "sinceVersion": 1,
-  "description": "Applies the softplus activation elementwise: `y = ln(exp(x) + 1)`. The output has the same shape as the input.",
-  "inputs": [
-    { "role": "X", "dtype": "T", "description": "Values transformed elementwise by the smooth softplus activation." }
-  ],
-  "outputs": [
-    {
-      "role": "Y",
-      "dtype": "T",
-      "rank": "ranks.X",
-      "description": "Output tensor with softplus applied elementwise; same shape as `X`.",
-      "shape": "shapes.X"
-    }
-  ],
   "typeConstraints": { "T": ["float32", "float16"] },
-  "args": {
-    "x": { "kind": "tensor", "semantic": "X", "role": "input" },
-    "y": { "kind": "tensor", "semantic": "Y", "role": "output" }
-  },
-  "tunables": { "WORKGROUP_SIZE": 256 },
   "variants": [
     {
       "id": "same_layout_vec4",
       "when": ["numel(shapes.x) > 0", "numel(shapes.x) % 4 == 0", "numel(shapes.x) == numel(shapes.y)", "f16Ok(dtypes.T)"],
-      "constants": {
         "scalar": "dtypes.T",
         "usesF16": "dtypes.T == \"f16\"",
         "vectorScalar": "\"vec4<\" ~ dtypes.T ~ \">\""
@@ -34,47 +20,103 @@
         {
           "id": "main",
           "name": "Softplus.vec4",
-          "source": { "shader": "unary-vec4.wgsl.jinja", "inputs": { "op": "\"softplus\"" } },
-          "bindings": [
-            { "name": "x", "arg": "x", "buffer": { "type": "read-only-storage" }, "elementType": "$vectorScalar" },
-            { "name": "y", "arg": "y", "buffer": { "type": "storage" }, "elementType": "$vectorScalar" },
-            {
-              "name": "params",
-              "semantic": "kernel.params",
-              "buffer": { "type": "uniform" },
-              "struct": {
-                "name": "Params",
-                "fields": [{ "name": "count", "type": "u32", "value": "numel(shapes.y) / 4" }]
-              }
-            }
-          ],
-          "dispatch": { "threads": "numel(shapes.y) / 4", "workgroupSize": "tunables.WORKGROUP_SIZE" }
         }
-      ],
-      "priority": 20
     },
     {
       "id": "elementwise",
       "when": ["numel(shapes.x) == numel(shapes.y)", "f16Ok(dtypes.T)"],
-      "constants": { "scalar": "dtypes.T", "usesF16": "dtypes.T == \"f16\"" },
       "passes": [
         {
           "id": "main",
           "name": "Softplus",
-          "source": { "shader": "unary-scalar.wgsl.jinja", "inputs": { "op": "\"softplus\"", "itemsPerInvocation": 4 } },
-          "bindings": [
-            { "name": "x", "arg": "x", "buffer": { "type": "read-only-storage" }, "elementType": "$scalar" },
-            { "name": "y", "arg": "y", "buffer": { "type": "storage" }, "elementType": "$scalar" },
-            {
-              "name": "params",
-              "semantic": "kernel.params",
-              "buffer": { "type": "uniform" },
-              "struct": { "name": "Params", "fields": [{ "name": "count", "type": "u32", "value": "numel(shapes.y)" }] }
-            }
-          ],
-          "dispatch": { "threads": "ceilDiv(numel(shapes.y), 4)", "workgroupSize": "tunables.WORKGROUP_SIZE" }
         }
       ]
     }
-  ]
 }

   "domain": "ai.onnx",
   "name": "Softplus",
   "sinceVersion": 1,
+  "inputs": { "x": { "onnx": "X", "dtype": "T" } },
+  "outputs": { "y": { "onnx": "Y", "dtype": "T", "rank": "ranks.x", "shape": "shapes.x" } },
   "typeConstraints": { "T": ["float32", "float16"] },
+  "tunables": { "WORKGROUP_SIZE": { "default": 256 } },
   "variants": [
     {
       "id": "same_layout_vec4",
+      "priority": 20,
       "when": ["numel(shapes.x) > 0", "numel(shapes.x) % 4 == 0", "numel(shapes.x) == numel(shapes.y)", "f16Ok(dtypes.T)"],
+      "derive": {
         "scalar": "dtypes.T",
         "usesF16": "dtypes.T == \"f16\"",
         "vectorScalar": "\"vec4<\" ~ dtypes.T ~ \">\""
         {
           "id": "main",
           "name": "Softplus.vec4",
+          "shader": "unary-vec4.wgsl.jinja",
+          "derive": {
+            "op": "\"softplus\"",
+            "vec4PerThread": "4 if numel(shapes.y) * dtypeBytes(tensorDtypes.y) <= 16777216 else 1"
+          },
+          "bindings": ["x", "y", "params_unary"],
+          "dispatch": {
+            "x": "min(ceilDiv((ceilDiv(numel(shapes.y) / 4, 4 if numel(shapes.y) * dtypeBytes(tensorDtypes.y) <= 16777216 else 1)), (tunables.WORKGROUP_SIZE)), 65535)",
+            "y": "ceilDiv(ceilDiv((ceilDiv(numel(shapes.y) / 4, 4 if numel(shapes.y) * dtypeBytes(tensorDtypes.y) <= 16777216 else 1)), (tunables.WORKGROUP_SIZE)), 65535)",
+            "z": 1
+          }
         }
+      ]
     },
     {
       "id": "elementwise",
       "when": ["numel(shapes.x) == numel(shapes.y)", "f16Ok(dtypes.T)"],
+      "derive": { "scalar": "dtypes.T", "usesF16": "dtypes.T == \"f16\"" },
       "passes": [
         {
           "id": "main",
           "name": "Softplus",
+          "shader": "unary-scalar.wgsl.jinja",
+          "derive": { "op": "\"softplus\"", "itemsPerInvocation": 4 },
+          "bindings": ["x_2", "y_2", "params_2_unary"],
+          "dispatch": {
+            "x": "min(ceilDiv((ceilDiv(numel(shapes.y), 4)), (tunables.WORKGROUP_SIZE)), 65535)",
+            "y": "ceilDiv(ceilDiv((ceilDiv(numel(shapes.y), 4)), (tunables.WORKGROUP_SIZE)), 65535)",
+            "z": 1
+          }
         }
       ]
+    },
+    {
+      "id": "same_layout_vec4_tail",
+      "priority": 19,
+      "when": ["numel(shapes.x) > 4", "numel(shapes.x) % 4 != 0", "numel(shapes.x) == numel(shapes.y)", "f16Ok(dtypes.T)"],
+      "derive": {
+        "scalar": "dtypes.T",
+        "usesF16": "dtypes.T == \"f16\"",
+        "vectorScalar": "\"vec4<\" ~ dtypes.T ~ \">\""
+      },
+      "passes": [
+        {
+          "id": "bulk",
+          "name": "Softplus.vec4Bulk",
+          "shader": "unary-vec4.wgsl.jinja",
+          "derive": {
+            "op": "\"softplus\"",
+            "vec4PerThread": "4 if numel(shapes.y) * dtypeBytes(tensorDtypes.y) <= 16777216 else 1"
+          },
+          "bindings": ["x", "y", "params_unary_tail"],
+          "dispatch": {
+            "x": "min(ceilDiv((ceilDiv(floor(numel(shapes.y) / 4), 4 if numel(shapes.y) * dtypeBytes(tensorDtypes.y) <= 16777216 else 1)), (tunables.WORKGROUP_SIZE)), 65535)",
+            "y": "ceilDiv(ceilDiv((ceilDiv(floor(numel(shapes.y) / 4), 4 if numel(shapes.y) * dtypeBytes(tensorDtypes.y) <= 16777216 else 1)), (tunables.WORKGROUP_SIZE)), 65535)",
+            "z": 1
+          }
+        },
+        {
+          "id": "tail",
+          "name": "Softplus.tail",
+          "shader": "unary-scalar.wgsl.jinja",
+          "derive": { "op": "\"softplus\"", "itemsPerInvocation": 4, "tailOnly": true },
+          "bindings": ["x_2", "y_2", "params_2_unary_tail"],
+          "dispatch": {
+            "x": "min(ceilDiv((1), (tunables.WORKGROUP_SIZE)), 65535)",
+            "y": "ceilDiv(ceilDiv((1), (tunables.WORKGROUP_SIZE)), 65535)",
+            "z": 1
+          }
+        }
+      ]
+    }
+  ],
+  "bindings": {
+    "x": { "buffer": "read-only-storage", "elementType": "$vectorScalar" },
+    "y": { "buffer": "storage", "elementType": "$vectorScalar" },
+    "params_unary": {
+      "buffer": "uniform",
+      "struct": [{ "name": "count", "type": "u32", "value": "numel(shapes.y) / 4" }],
+      "name": "params"
+    },
+    "x_2": { "buffer": "read-only-storage", "name": "x", "elementType": "$scalar" },
+    "y_2": { "buffer": "storage", "name": "y", "elementType": "$scalar" },
+    "params_2_unary": {
+      "buffer": "uniform",
+      "name": "params",
+      "struct": [{ "name": "count", "type": "u32", "value": "numel(shapes.y)" }]
+    },
+    "params_unary_tail": {
+      "buffer": "uniform",
+      "struct": [{ "name": "count", "type": "u32", "value": "floor(numel(shapes.y) / 4)" }],
+      "name": "params"
+    },
+    "params_2_unary_tail": {
+      "buffer": "uniform",
+      "name": "params",
+      "struct": [{ "name": "count", "type": "u32", "value": "numel(shapes.y)" }]
     }
+  }
 }

build/webgpu/metadata.json CHANGED Viewed

@@ -1,19 +1,26 @@
 {
   "name": "ai.onnx.Softplus",
-  "id": "_ai_onnx_softplus_webgpu_ef21ab2",
   "version": 1,
   "license": "Apache-2.0",
   "backend": { "type": "webgpu" },
   "digest": {
     "algorithm": "sha256",
     "files": {
-      "bench.json": "tlYCCPu78ZtIpxVmMV4qReJFTW2N1wTBPyYhkK7WrDc=",
-      "manifest.json": "4xpCC6+qT1khNxgVa4uNS/idV9SJ16S2kXSorFox1Ag=",
-      "test.json": "uXlEurXcHVZtkfsjNrzO2xzmskC049RqywccYpooB7w=",
-      "unary-scalar.wgsl.jinja": "ovYCHDPxbtSPhqAHIlBpqk31JktAcJsteDn1qtkeaDg=",
-      "unary-vec4.wgsl.jinja": "5CwSPN+M7k2FzFB558XA+Ld2lj/lyVJigL7YAZvZf0M="
     }
   },
-  "provenance": { "kernel": { "sha": "2e7068faf55e7f43df740015f6d1ee49391a41c5", "dirty": false } },
-  "webgpu": { "manifestSpec": "1.0", "specialized": true, "opPath": "ops/ai.onnx.Softplus" }
 }

 {
   "name": "ai.onnx.Softplus",
+  "id": "_ai_onnx_softplus_webgpu_b469e0f",
   "version": 1,
   "license": "Apache-2.0",
   "backend": { "type": "webgpu" },
   "digest": {
     "algorithm": "sha256",
     "files": {
+      "bench.json": "mkmdJjYz59jONtwNKYEziTe5Lm9kEiwf3kFFLKBdOp4=",
+      "manifest.json": "aCHo4wuGXtA6LlIKnQfRxEthv4n8dr5cevNBlAFT/5E=",
+      "test.json": "T671WTaU4UEK8e/RLc8PRBhFsHu2dp9fIzNqCROpr4M=",
+      "unary-scalar.wgsl.jinja": "hrIOCeU5eTtNJyqrJ25ccbIWNQxLRe+T9TCAb2oucW8=",
+      "unary-vec4.wgsl.jinja": "oQHYtByBE/SSMn9Zq5og2N7LggCR/IzbecjcLKaHuR4="
     }
   },
+  "provenance": { "kernel": { "sha": "91d990483a174128daf7673f3f37a7c890493ae1", "dirty": false } },
+  "webgpu": {
+    "manifestSpec": "2.0",
+    "variants": {
+      "same_layout_vec4": ["unary-vec4.wgsl.jinja"],
+      "elementwise": ["unary-scalar.wgsl.jinja"],
+      "same_layout_vec4_tail": ["unary-scalar.wgsl.jinja", "unary-vec4.wgsl.jinja"]
+    }
+  }
 }

build/webgpu/test.json CHANGED Viewed

@@ -1,5 +1,4 @@
 {
-  "op": "ai.onnx.Softplus",
   "cases": [
     {
       "name": "f32_values",
@@ -62,7 +61,7 @@
       "provenance": {
         "source": "onnxruntime/test/providers/cpu/activation/activation_op_test.cc",
         "test": "ActivationOpTest.Softplus",
-        "notes": "Scalar-path companion: large negative inputs produce a valid subnormal Softplus tail."
       },
       "inputs": {
         "x": { "dtype": "float32", "shape": [3], "data": { "kind": "values", "values": [-90.0, -95.0, -100.0] } }

 {
   "cases": [
     {
       "name": "f32_values",
       "provenance": {
         "source": "onnxruntime/test/providers/cpu/activation/activation_op_test.cc",
         "test": "ActivationOpTest.Softplus",
+        "notes": "Scalar Softplus maps large negative inputs to valid subnormal tail values."
       },
       "inputs": {
         "x": { "dtype": "float32", "shape": [3], "data": { "kind": "values", "values": [-90.0, -95.0, -100.0] } }

build/webgpu/unary-scalar.wgsl.jinja CHANGED Viewed

@@ -1,21 +1,32 @@
 {% macro flat_tail_open() %}
 @compute @workgroup_size({{ tunables.WORKGROUP_SIZE }})
-fn main(@builtin(global_invocation_id) gid: vec3<u32>, @builtin(num_workgroups) nwg: vec3<u32>) {
   // 2D-folded flat index: gid.y carries the high bits when the element count exceeds the
-  // maxComputeWorkgroupsPerDimension limit (the dispatch caps x and spills the rest into y).
-  let invocation = gid.x + gid.y * nwg.x * {{ tunables.WORKGROUP_SIZE }}u;
   // Tail-safe scalar x4 keeps vector-like dispatch density without requiring
   // the logical tensor length (or its storage binding) to be vec4 aligned.
-  let begin = invocation * {{ source.itemsPerInvocation }}u;
-  let end = min(begin + {{ source.itemsPerInvocation }}u, params.count);
   for (var i = begin; i < end; i = i + 1u) {
 {%- endmacro %}
 {% macro flat_tail_close() %}
   }
 {% endmacro %}
-// Scalar unary fallback. Each branch retains the operation's numeric hardening,
-// including Payne-Hanek trigonometric range reduction and NaN/overflow guards.
 {% if usesF16 %}
 enable f16;
 {% endif %}

 {% macro flat_tail_open() %}
 @compute @workgroup_size({{ tunables.WORKGROUP_SIZE }})
+fn main(@builtin(global_invocation_id) gid: vec3<u32>) {
   // 2D-folded flat index: gid.y carries the high bits when the element count exceeds the
+  // dispatch's per-axis workgroup fold width (the dispatch caps x and spills the rest into y).
+  let invocation = gid.x + gid.y * {{ DISPATCH_FOLD_WIDTH }}u * {{ tunables.WORKGROUP_SIZE }}u;
   // Tail-safe scalar x4 keeps vector-like dispatch density without requiring
   // the logical tensor length (or its storage binding) to be vec4 aligned.
+{% set itemsPerInvocation = itemsPerInvocation if itemsPerInvocation is defined else 4 %}
+{% if tailOnly is defined and tailOnly %}
+  // Tail of a vec4 bulk pass: lane zero alone covers the elements the packed
+  // pass left behind, from the last multiple of the item count to the end.
+  if (invocation != 0u) {
+    return;
+  }
+  let begin = params.count - params.count % {{ itemsPerInvocation }}u;
+  let end = params.count;
+{% else %}
+  let begin = invocation * {{ itemsPerInvocation }}u;
+  let end = min(begin + {{ itemsPerInvocation }}u, params.count);
+{% endif %}
   for (var i = begin; i < end; i = i + 1u) {
 {%- endmacro %}
 {% macro flat_tail_close() %}
   }
 {% endmacro %}
+// Scalar unary elementwise implementation. Specialization emits only the
+// selected operation and any numerical helper it requires.
 {% if usesF16 %}
 enable f16;
 {% endif %}

build/webgpu/unary-vec4.wgsl.jinja CHANGED Viewed

@@ -1,8 +1,5 @@
-// Loads and stores vec4<T> (128 bits) while retaining scalar per-component
-// arithmetic, including per-component helper calls for guard-heavy operations.
-{% if usesF16 %}
-enable f16;
-{% endif %}
 {{ env.wgsl.resourceDeclarations }}
 {% macro emit_log1p_small_positive() %}
@@ -27,15 +24,37 @@ const SOFTPLUS_LOG1P_SERIES_THRESHOLD: f32 = {% if usesF16 %}-4.0{% else %}-8.0{
 {{ emit_softplus() }}
 @compute @workgroup_size({{ tunables.WORKGROUP_SIZE }})
-fn main(@builtin(global_invocation_id) gid: vec3<u32>, @builtin(num_workgroups) nwg: vec3<u32>) {
   // 2D-folded flat index: gid.y carries the high bits when the element count exceeds the
-  // maxComputeWorkgroupsPerDimension limit (the dispatch caps x and spills the rest into y).
-  let i = gid.x + gid.y * nwg.x * {{ tunables.WORKGROUP_SIZE }}u;
   if (i >= params.count) {
     return;
   }
   let xv = x[i];
   let fv = vec4<f32>(xv);
   y[i] = {{ vectorScalar }}(vec4<f32>(softplus(fv.x), softplus(fv.y), softplus(fv.z), softplus(fv.w)));
 }

+// Loads and stores vec4<T> while evaluating the selected unary operation per
+// component.
 {{ env.wgsl.resourceDeclarations }}
 {% macro emit_log1p_small_positive() %}
 {{ emit_softplus() }}
+{% set vec4PerThread = vec4PerThread %}
+{% if vec4PerThread > 1 %}
+const ITEMS: u32 = {{ vec4PerThread }}u;
+{% endif %}
 @compute @workgroup_size({{ tunables.WORKGROUP_SIZE }})
+fn main(@builtin(global_invocation_id) gid: vec3<u32>) {
   // 2D-folded flat index: gid.y carries the high bits when the element count exceeds the
+  // per-axis dispatch fold width (the dispatch caps x and spills the rest into y).
+{% if vec4PerThread > 1 %}
+  // Each invocation walks ITEMS vec4 groups a span apart. Consecutive lanes
+  // access consecutive words on every step, while each lane can keep several
+  // independent loads in flight.
+  let tid = gid.x + gid.y * {{ DISPATCH_FOLD_WIDTH }}u * {{ tunables.WORKGROUP_SIZE }}u;
+  let span = (params.count + ITEMS - 1u) / ITEMS;
+  for (var j = 0u; j < ITEMS; j = j + 1u) {
+    let i = tid + j * span;
+    if (i >= params.count) {
+      break;
+    }
+{% else %}
+  let i = gid.x + gid.y * {{ DISPATCH_FOLD_WIDTH }}u * {{ tunables.WORKGROUP_SIZE }}u;
   if (i >= params.count) {
     return;
   }
+{% endif %}
   let xv = x[i];
   let fv = vec4<f32>(xv);
   y[i] = {{ vectorScalar }}(vec4<f32>(softplus(fv.x), softplus(fv.y), softplus(fv.z), softplus(fv.w)));
+{% if vec4PerThread > 1 %}
+  }
+{% endif %}
 }