File size: 3,010 Bytes
c29a609 21b9606 c29a609 21b9606 c29a609 21b9606 10d110d 21b9606 10d110d 21b9606 10d110d 21b9606 10d110d 21b9606 5816062 21b9606 10d110d 5816062 10d110d 21b9606 10d110d 21b9606 10d110d 21b9606 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | ---
library_name: kernels
license: apache-2.0
tags:
- kernel
- webgpu
- wgsl
---
# ai.onnx.BlackmanWindow
`ai.onnx` · standard ONNX operator · ONNX opset ≥ 17
## Description
Generates a Blackman window of a given length using the cosine-sum formula `0.42 - 0.5*cos(2πn/N) + 0.08*cos(4πn/N)`. Supports periodic mode (divides by `size`) or symmetric mode (divides by `size - 1`).
See the [ONNX `BlackmanWindow` spec](https://onnx.ai/onnx/operators/onnx__BlackmanWindow.html) for the reference semantics.
## Inputs
| Name | Logical dtype | Rank | Shape | Description | Presence |
| --- | --- | --- | --- | --- | --- |
| `size` | `T1` | `0` | — | Scalar length of the window to generate. | required |
## Outputs
| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
| --- | --- | --- | --- | --- | --- | --- |
| `y` | `output` | `T2` | `1` | — | 1-D Blackman window of shape `[size]`. | required |
## Attributes
Default values (overridable per request):
| Attribute | Default | Description |
| --- | --- | --- |
| `output_datatype` | `1` | Data type of the output tensor, specified as a TensorProto DataType enum integer; defaults to 1 (FLOAT). |
| `periodic` | `1` | If 1, generates a periodic window (length `size + 1` trimmed to `size`); if 0, generates a symmetric window. |
## Type constraints
| Variable | Allowed dtypes |
| --- | --- |
| `T1` | `int32` |
| `T2` | `float32`, `float16`, `uint32`, `int32`, `uint8`, `int8`, `int16` |
## 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 cases
- [`window-cosine-sum.wgsl.jinja`](build/webgpu/window-cosine-sum.wgsl.jinja)
## Use with `@huggingface/kernels`
```sh
npm install --save-exact @huggingface/kernels@0.0.1-preview.3
```
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.
```js
import { getKernel } from "@huggingface/kernels";
const kernel = await getKernel("webgpu-kernels/ai.onnx.BlackmanWindow", { version: 1 });
// Explicit destinations request optional results or supply metadata that cannot be inferred.
const { y } = await kernel({ size: { data: sizeData, shape: [] } }, {
outputs: { y: { shape: [1], dtype: "float32" } },
});
```
|