---
library_name: kernels
license: apache-2.0
tags:
- kernel
- webgpu
- wgsl
---
# ai.onnx.Dropout

`ai.onnx`  ·  standard ONNX operator  ·  ONNX opset ≥ 13

## Description

Inference-only Dropout. Copies a floating-point tensor unchanged and optionally emits an all-true boolean mask. The `ratio` and `training_mode` inputs, seeded randomness, and training behavior are not supported by this package.

See the [ONNX `Dropout` spec](https://onnx.ai/onnx/operators/onnx__Dropout.html) for the reference semantics.

## Inputs

| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
| --- | --- | --- | --- | --- | --- | --- |
| `x` | `data` | `T` | — | — | The input floating-point tensor to copy unchanged. | required |

## Outputs

| Name | Upstream name | Logical dtype | Rank | Shape | Description | Presence |
| --- | --- | --- | --- | --- | --- | --- |
| `y` | `output` | `T` | same as `x` | same as `x` | The output tensor, same shape as the input; equals the input in inference mode. | required |
| `mask` | — | `M` | same as `x` | same as `x` | Boolean mask indicating which elements were kept (all-ones in inference mode). | optional |

## Type constraints

| Variable | Allowed dtypes |
| --- | --- |
| `T` | `float32`, `float16` |
| `M` | `bool` |

## 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
- [`dropout-vec4.wgsl.jinja`](build/webgpu/dropout-vec4.wgsl.jinja)
- [`dropout.wgsl.jinja`](build/webgpu/dropout.wgsl.jinja)

## Use with `@huggingface/kernels`

```sh
npm install --save-exact @huggingface/kernels@0.0.1-preview.3
```

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.

```js
import { getKernel } from "@huggingface/kernels";

const kernel = await getKernel("webgpu-kernels/ai.onnx.Dropout", { version: 1 });
const { y } = await kernel({ x: { data: xData, shape: [3] } });
```