Add ExecuTorch WebGPU program for whisper-base

.gitattributes

@@ -33,3 +33,9 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+whisper_cross_kv.pte filter=lfs diff=lfs merge=lfs -text
+whisper_decode_stream.pte filter=lfs diff=lfs merge=lfs -text
+whisper_decoder_split.pte filter=lfs diff=lfs merge=lfs -text
+whisper_encoder.pte filter=lfs diff=lfs merge=lfs -text
+whisper_lmhead.pte filter=lfs diff=lfs merge=lfs -text
+whisper_mel.pte filter=lfs diff=lfs merge=lfs -text

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

NOTICE

@@ -0,0 +1,6 @@
+This repository contains a modified version of openai/whisper-base.
+
+Modifications by Meta Platforms, Inc.: conversion to the ExecuTorch program format (.pte) for the
+ExecuTorch WebGPU backend, and quantization as described in README.md.
+
+The original work and these modifications are distributed under the license in LICENSE.

README.md

@@ -0,0 +1,62 @@
+---
+license: apache-2.0
+base_model:
+- openai/whisper-base
+base_model_relation: quantized
+library_name: executorch
+pipeline_tag: automatic-speech-recognition
+tags:
+- executorch
+- webgpu
+- on-device
+- browser
+---
+# Whisper base for ExecuTorch WebGPU
+
+This repository contains an [ExecuTorch](https://github.com/pytorch/executorch) conversion of
+[openai/whisper-base](https://huggingface.co/openai/whisper-base) for the ExecuTorch **WebGPU** backend, so the model runs entirely in a web browser on
+the visitor's GPU. It powers the corresponding demo in the
+[ExecuTorch Playground](https://executorch.ai/playground/webgpu/).
+
+- **Base model:** [openai/whisper-base](https://huggingface.co/openai/whisper-base)
+- **Format:** ExecuTorch `.pte` programs delegated to the WebGPU backend
+- **Quantization:** int8 token embeddings; other graphs as exported
+- **Total size:** 158.3 MB
+
+> **Note:** The Hugging Face model card lists Apache-2.0; the original code release is MIT. Confirm with legal which applies to redistributed weights.
+
+## Files
+
+| File | Size | SHA-256 |
+|---|---|---|
+| `vocab.json` | 816.0 KB | `8f680bba319e01a6…` |
+| `whisper_cross_kv.pte` | 1.7 MB | `9ade21df20193271…` |
+| `whisper_decode_stream.pte` | 22.6 MB | `9b77ad9d5e003b06…` |
+| `whisper_decoder_split.pte` | 13.1 MB | `84d9427851420bf7…` |
+| `whisper_embed.i8.bin` | 25.3 MB | `bc7f8d8336ad935e…` |
+| `whisper_embed.scale.f32.bin` | 202.6 KB | `1f58851911611b96…` |
+| `whisper_encoder.pte` | 78.6 MB | `951972490d33f680…` |
+| `whisper_lmhead.pte` | 14.4 MB | `1dfce892767b535b…` |
+| `whisper_mel.pte` | 696.8 KB | `d0b2759497debae4…` |
+| `whisper_pos_embed.f32.bin` | 896.0 KB | `88fa1cdbf2b06f86…` |
+
+Full checksums are in `manifest.json`. The playground verifies them after download.
+
+## Running it
+
+These programs need the ExecuTorch WebGPU runtime compiled to WebAssembly
+([backends/webgpu](https://github.com/pytorch/executorch/tree/main/backends/webgpu)). The easiest way to
+try the model is the [ExecuTorch Playground](https://executorch.ai/playground/webgpu/), which downloads these
+files once, caches them in the browser, and runs everything locally.
+
+## Provenance
+
+- Converted from the upstream checkpoint with ExecuTorch's WebGPU export path.
+- Upstream revision: _to be recorded at export time_.
+- Export recipe: _to be published with the ExecuTorch release that ships the WebGPU runtime_.
+
+## License
+
+This is a derivative of the upstream model and is distributed under the same terms
+(`apache-2.0`); see `LICENSE`.
+Modifications (conversion to the ExecuTorch format and quantization) by Meta Platforms, Inc.

manifest.json

@@ -0,0 +1,56 @@
+{
+  "model": "whisper-base",
+  "repo": "executorch-community/Whisper-Base-ExecuTorch-WebGPU",
+  "files": [
+    {
+      "path": "vocab.json",
+      "bytes": 835550,
+      "sha256": "8f680bba319e01a653d2e8a5dbc17a9157179e0576e6ce74ce0c06356c6e24f9"
+    },
+    {
+      "path": "whisper_cross_kv.pte",
+      "bytes": 1801728,
+      "sha256": "9ade21df201932715c97143e59936519ca2680743fa33fc3967f61d97dcbc40d"
+    },
+    {
+      "path": "whisper_decode_stream.pte",
+      "bytes": 23680256,
+      "sha256": "9b77ad9d5e003b063dcff55eab5f5ac70025beadc2aa7ef4ab1c3994380a72d5"
+    },
+    {
+      "path": "whisper_decoder_split.pte",
+      "bytes": 13719936,
+      "sha256": "84d9427851420bf73d521649e1bb6af52458b36906d9a9a064d6057239e0dd1e"
+    },
+    {
+      "path": "whisper_embed.i8.bin",
+      "bytes": 26554880,
+      "sha256": "bc7f8d8336ad935eb8b6374036478d92d679eae156a1d4188d5cc016b5f2dda2"
+    },
+    {
+      "path": "whisper_embed.scale.f32.bin",
+      "bytes": 207460,
+      "sha256": "1f58851911611b9686851c586365df2fcaaa0727957c05bd163d7c3ccc231f4d"
+    },
+    {
+      "path": "whisper_encoder.pte",
+      "bytes": 82419712,
+      "sha256": "951972490d33f680cb55861e7feb19f1661311f975582bc5074f2acb03855c25"
+    },
+    {
+      "path": "whisper_lmhead.pte",
+      "bytes": 15149056,
+      "sha256": "1dfce892767b535b823742fd3cfabf0ba9ae28ab9a0e54384b32c842faf01ae5"
+    },
+    {
+      "path": "whisper_mel.pte",
+      "bytes": 713536,
+      "sha256": "d0b2759497debae49d05f089c4971d42f38a0ad87c8a45831a2987e0db09b06b"
+    },
+    {
+      "path": "whisper_pos_embed.f32.bin",
+      "bytes": 917504,
+      "sha256": "88fa1cdbf2b06f86b0ecb7be0fccfc39e906502986572b8cf5319c250e857169"
+    }
+  ]
+}

whisper_cross_kv.pte

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9ade21df201932715c97143e59936519ca2680743fa33fc3967f61d97dcbc40d
+size 1801728

whisper_decode_stream.pte

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9b77ad9d5e003b063dcff55eab5f5ac70025beadc2aa7ef4ab1c3994380a72d5
+size 23680256

whisper_decoder_split.pte

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:84d9427851420bf73d521649e1bb6af52458b36906d9a9a064d6057239e0dd1e
+size 13719936

whisper_embed.i8.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bc7f8d8336ad935eb8b6374036478d92d679eae156a1d4188d5cc016b5f2dda2
+size 26554880

whisper_embed.scale.f32.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1f58851911611b9686851c586365df2fcaaa0727957c05bd163d7c3ccc231f4d
+size 207460

whisper_encoder.pte

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:951972490d33f680cb55861e7feb19f1661311f975582bc5074f2acb03855c25
+size 82419712

whisper_lmhead.pte

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1dfce892767b535b823742fd3cfabf0ba9ae28ab9a0e54384b32c842faf01ae5
+size 15149056

whisper_mel.pte

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d0b2759497debae49d05f089c4971d42f38a0ad87c8a45831a2987e0db09b06b
+size 713536

whisper_pos_embed.f32.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:88fa1cdbf2b06f86b0ecb7be0fccfc39e906502986572b8cf5319c250e857169
+size 917504