Add TurnSense.cpp GGUF model card and licensing

LICENSE

@@ -0,0 +1,73 @@
+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,7 @@
+TurnSense.cpp GGUF model artifacts
+
+Derived from the TurnSense model by Latisha Besariani Hendra:
+https://huggingface.co/latishab/turnsense
+
+The artifacts contain deterministic format conversion, LoRA merging, and
+selective Q8_0 quantization changes. See README.md for exact provenance.

README.md

@@ -0,0 +1,142 @@
+---
+license: apache-2.0
+language:
+  - en
+base_model: latishab/turnsense
+base_model_relation: quantized
+pipeline_tag: text-classification
+library_name: ggml
+tags:
+  - gguf
+  - ggml
+  - turn-taking
+  - end-of-utterance
+  - voice-agents
+  - text-classification
+---
+
+# TurnSense.cpp GGUF
+
+Canonical F32 and selective Q8_0 GGUF artifacts for
+[TurnSense.cpp](https://github.com/simonfxr/turnsense.cpp), a native C/C++
+end-of-utterance classifier built on official upstream ggml.
+
+These files are converted from
+[`latishab/turnsense`](https://huggingface.co/latishab/turnsense) at immutable
+revision `1ddc8f679abf3d9a42a93373b0e709f0c9d7fe63`. The model architecture and
+weights are unchanged except for deterministic LoRA merging and, for the Q8_0
+artifact, weight quantization. The production runtime has no ONNX Runtime or
+Python dependency.
+
+## Files
+
+| File | Purpose | Size | SHA-256 |
+|---|---|---:|---|
+| `turnsense-q8_0.gguf` | Recommended CPU/Vulkan runtime model | 145,012,704 bytes | `e978f2462e1887c2959173066e2f534f3c02fea686323bfc454aa37842970966` |
+| `turnsense-f32.gguf` | Canonical conversion and quantization source | 540,047,168 bytes | `0eb7d0ea7bccbcd2f9aa4b722ee202efbf53b4e430ba90c527548f8578d2460e` |
+
+`SHA256SUMS` contains the same checksums in machine-readable form.
+
+## Q8_0 policy
+
+The Q8_0 artifact is produced from the canonical F32 GGUF with the native
+`turnsense_quantize` tool and upstream `ggml_quantize_chunk`:
+
+- **Q8_0:** `token_embd.weight` and all 210 transformer attention/FFN
+  projection matrices.
+- **F32:** all 61 RMS normalization vectors and `classifier.weight`.
+
+This quantizes 211 tensors and retains 62 tensors as F32. Tensor payload drops
+from 513.14 MiB to 136.40 MiB, a 3.76x reduction. Repeated conversion produces
+a byte-identical Q8_0 file. The runtime validates this policy exactly and
+rejects incompatible layouts.
+
+The dynamically quantized upstream ONNX model is **not** the source of this
+Q8_0 artifact.
+
+## Usage
+
+Download the recommended model:
+
+```bash
+hf download simonfxr/turnsense.cpp-GGUF turnsense-q8_0.gguf \
+  --local-dir models
+```
+
+Build and run the native runtime:
+
+```bash
+git clone --recurse-submodules https://github.com/simonfxr/turnsense.cpp.git
+cd turnsense.cpp
+cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
+cmake --build build -j
+
+./build/turnsense_cli \
+  --model models/turnsense-q8_0.gguf \
+  --backend cpu \
+  --json "Could you send that report tomorrow?"
+```
+
+Use `--backend vulkan` for the Vulkan backend. The stable C API is documented
+in the [source repository README](https://github.com/simonfxr/turnsense.cpp#c-api).
+
+TurnSense operates on text, not audio. A voice agent should evaluate the latest
+punctuated STT transcript at candidate pauses and combine `prob_eou` with VAD,
+latency, and product policy.
+
+## Validation
+
+The runtime graph uses official ggml operations and optimized backend kernels.
+For Q8_0, it verifies that every quantized `get_rows` and `mul_mat` node remains
+on the selected CPU or Vulkan backend rather than unexpectedly falling back.
+
+Measured maximum absolute probability differences on the bundled seven-case
+fixture suite:
+
+| Backend / artifact | Reference | Maximum delta | Classifications |
+|---|---|---:|---|
+| CPU F32 | FP32 ONNX Runtime | `9.84e-7` | identical |
+| Vulkan F32 | FP32 ONNX Runtime | `5.69e-4` | identical |
+| CPU Q8_0 | native CPU F32 | `0.04161` | identical |
+| Vulkan Q8_0 | native Vulkan F32 | `0.01413` | identical |
+
+Vulkan was validated on an AMD Radeon RX 7900 XTX. Backend floating-point
+accumulation is not expected to be bit-identical.
+
+## Prompt and labels
+
+The runtime prepends the literal prompt prefix `<|user|> ` and applies the
+embedded GPT-2 byte-level BPE tokenizer. Do not append `<|im_end|>`.
+
+- Label `0`: `NON_EOU`
+- Label `1`: `EOU`
+
+Applications should normally use `prob_eou` with a product-specific threshold
+rather than treating argmax as a fixed policy.
+
+## Limitations
+
+- The upstream model is English-focused.
+- Predictions are sensitive to punctuation and STT transcript quality.
+- Turn-taking decisions should also incorporate VAD, timing, and application
+  context.
+- The fixture suite validates conversion parity; it is not a broad task-quality
+  benchmark.
+- This model is not intended for safety-critical decisions.
+
+## Provenance
+
+- Upstream source: <https://github.com/latishab/turnsense>
+- Upstream source revision: `b40a25b4da94c961b64393752e507f59295061ad`
+- Upstream model: <https://huggingface.co/latishab/turnsense>
+- Upstream model revision: `1ddc8f679abf3d9a42a93373b0e709f0c9d7fe63`
+- Runtime source: <https://github.com/simonfxr/turnsense.cpp>
+
+Full source artifact hashes and deterministic conversion instructions are in
+[`docs/model-provenance.md`](https://github.com/simonfxr/turnsense.cpp/blob/main/docs/model-provenance.md).
+
+## License
+
+The model artifacts are distributed under the Apache License 2.0, matching the
+upstream TurnSense model. See `LICENSE`. The TurnSense.cpp runtime source is
+separately distributed under the MIT License.

SHA256SUMS

@@ -0,0 +1,2 @@
+e978f2462e1887c2959173066e2f534f3c02fea686323bfc454aa37842970966  turnsense-q8_0.gguf
+0eb7d0ea7bccbcd2f9aa4b722ee202efbf53b4e430ba90c527548f8578d2460e  turnsense-f32.gguf