cchiou-amba commited on
Commit
af6d397
·
verified ·
1 Parent(s): 0b02a33

Add LICENSE and upstream attribution/modification notices

Browse files
Files changed (2) hide show
  1. LICENSE +194 -0
  2. README.md +12 -1
LICENSE ADDED
@@ -0,0 +1,194 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Upstream Copyright & Attribution Notice
2
+ =======================================
3
+ - Original Model: NVIDIA NeMo `stt_en_conformer_ctc_small`
4
+ Copyright (c) 2020-2024, NVIDIA CORPORATION & Affiliates. All rights reserved.
5
+ Source: https://catalog.ngc.nvidia.com/orgs/nvidia/teams/nemo/models/stt_en_conformer_ctc_small
6
+ - ONNX Export: `csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small`
7
+ Copyright (c) Xiaomi Corporation and sherpa-onnx contributors.
8
+ Source: https://huggingface.co/csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small
9
+
10
+ Modification Notice (Apache License 2.0, Section 4(b))
11
+ ======================================================
12
+ Copyright (C) 2026, Ambarella International LLC.
13
+ Modified from the upstream ONNX export for execution on Ambarella CVflow v3
14
+ N1-655 (`vdg_arch = 0xB`) Neural Vector Processor (NVP):
15
+ 1. Fixed dynamic input shape to static `[1, 80, 1024]` IEEE FP16.
16
+ 2. Quantized and compiled graph via Ambarella Cooper SDK CNNGen 3.9.0
17
+ (`cavalry_gen 3.0.4`) into `n1-655_conformer_ctc_small_amba_optimized.bin`.
18
+
19
+ Apache License
20
+ Version 2.0, January 2004
21
+ http://www.apache.org/licenses/
22
+
23
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
24
+
25
+ 1. Definitions.
26
+
27
+ "License" shall mean the terms and conditions for use, reproduction,
28
+ and distribution as defined by Sections 1 through 9 of this document.
29
+
30
+ "Licensor" shall mean the copyright owner or entity authorized by
31
+ the copyright owner that is granting the License.
32
+
33
+ "Legal Entity" shall mean the union of the acting entity and all
34
+ other entities that control, are controlled by, or are under common
35
+ control with that entity. For the purposes of this definition,
36
+ "control" means (i) the power, direct or indirect, to cause the
37
+ direction or management of such entity, whether by contract or
38
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
39
+ outstanding shares, or (iii) beneficial ownership of such entity.
40
+
41
+ "You" (or "Your") shall mean an individual or Legal Entity
42
+ exercising permissions granted by this License.
43
+
44
+ "Source" form shall mean the preferred form for making modifications,
45
+ including but not limited to software source code, documentation
46
+ source, and configuration files.
47
+
48
+ "Object" form shall mean any form resulting from mechanical
49
+ transformation or translation of a Source form, including but
50
+ not limited to compiled object code, generated documentation,
51
+ and conversions to other media types.
52
+
53
+ "Work" shall mean the work of authorship, whether in Source or
54
+ Object form, made available under the License, as indicated by a
55
+ copyright notice that is included in or attached to the work
56
+ (an example is provided in the Appendix below).
57
+
58
+ "Derivative Works" shall mean any work, whether in Source or Object
59
+ form, that is based on (or derived from) the Work and for which the
60
+ editorial revisions, annotations, elaborations, or other modifications
61
+ represent, as a whole, an original work of authorship. For the purposes
62
+ of this License, Derivative Works shall not include works that remain
63
+ separable from, or merely link (or bind by name) to the interfaces of,
64
+ the Work and Derivative Works thereof.
65
+
66
+ "Contribution" shall mean any work of authorship, including
67
+ the original version of the Work and any modifications or additions
68
+ to that Work or Derivative Works thereof, that is intentionally
69
+ submitted to Licensor for inclusion in the Work by the copyright owner
70
+ or by an individual or Legal Entity authorized to submit on behalf of
71
+ the copyright owner. For the purposes of this definition, "submitted"
72
+ means any form of electronic, verbal, or written communication sent
73
+ to the Licensor or its representatives, including but not limited to
74
+ communication on electronic mailing lists, source code control systems,
75
+ and issue tracking systems that are managed by, or on behalf of, the
76
+ Licensor for the purpose of discussing and improving the Work, but
77
+ excluding communication that is conspicuously marked or otherwise
78
+ designated in writing by the copyright owner as "Not a Contribution."
79
+
80
+ "Contributor" shall mean Licensor and any individual or Legal Entity
81
+ on behalf of whom a Contribution has been received by Licensor and
82
+ subsequently incorporated within the Work.
83
+
84
+ 2. Grant of Copyright License. Subject to the terms and conditions of
85
+ this License, each Contributor hereby grants to You a perpetual,
86
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
87
+ copyright license to reproduce, prepare Derivative Works of,
88
+ publicly display, publicly perform, sublicense, and distribute the
89
+ Work and such Derivative Works in Source or Object form.
90
+
91
+ 3. Grant of Patent License. Subject to the terms and conditions of
92
+ this License, each Contributor hereby grants to You a perpetual,
93
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
94
+ (except as stated in this section) patent license to make, have made,
95
+ use, offer to sell, sell, import, and otherwise transfer the Work,
96
+ where such license applies only to those patent claims licensable
97
+ by such Contributor that are necessarily infringed by their
98
+ Contribution(s) alone or by combination of their Contribution(s)
99
+ with the Work to which such Contribution(s) was submitted. If You
100
+ institute patent litigation against any entity (including a
101
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
102
+ or a Contribution incorporated within the Work constitutes direct
103
+ or contributory patent infringement, then any patent licenses
104
+ granted to You under this License for that Work shall terminate
105
+ as of the date such litigation is filed.
106
+
107
+ 4. Redistribution. You may reproduce and distribute copies of the
108
+ Work or Derivative Works thereof in any medium, with or without
109
+ modifications, and in Source or Object form, provided that You
110
+ meet the following conditions:
111
+
112
+ (a) You must give any other recipients of the Work or
113
+ Derivative Works a copy of this License; and
114
+
115
+ (b) You must cause any modified files to carry prominent notices
116
+ stating that You changed the files; and
117
+
118
+ (c) You must retain, in the Source form of any Derivative Works
119
+ that You distribute, all copyright, patent, trademark, and
120
+ attribution notices from the Source form of the Work,
121
+ excluding those notices that do not pertain to any part of
122
+ the Derivative Works; and
123
+
124
+ (d) If the Work includes a "NOTICE" text file as part of its
125
+ distribution, then any Derivative Works that You distribute must
126
+ include a readable copy of the attribution notices contained
127
+ within such NOTICE file, excluding those notices that do not
128
+ pertain to any part of the Derivative Works, in at least one
129
+ of the following places: within a NOTICE text file distributed
130
+ as part of the Derivative Works; within the Source form or
131
+ documentation, if provided along with the Derivative Works; or,
132
+ within a display generated by the Derivative Works, if and
133
+ wherever such third-party notices normally appear. The contents
134
+ of the NOTICE file are for informational purposes only and
135
+ do not modify the License. You may add Your own attribution
136
+ notices within Derivative Works that You distribute, alongside
137
+ or as an addendum to the NOTICE text from the Work, provided
138
+ that such additional attribution notices cannot be construed
139
+ as modifying the License.
140
+
141
+ You may add Your own copyright statement to Your modifications and
142
+ may provide additional or different license terms and conditions
143
+ for use, reproduction, or distribution of Your modifications, or
144
+ for any such Derivative Works as a whole, provided Your use,
145
+ reproduction, and distribution of the Work otherwise complies with
146
+ the conditions stated in this License.
147
+
148
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
149
+ any Contribution intentionally submitted for inclusion in the Work
150
+ by You to the Licensor shall be under the terms and conditions of
151
+ this License, without any additional terms or conditions.
152
+ Notwithstanding the above, nothing herein shall supersede or modify
153
+ the terms of any separate license agreement you may have executed
154
+ with Licensor regarding such Contributions.
155
+
156
+ 6. Trademarks. This License does not grant permission to use the trade
157
+ names, trademarks, service marks, or product names of the Licensor,
158
+ except as required for reasonable and customary use in describing the
159
+ origin of the Work and reproducing the content of the NOTICE file.
160
+
161
+ 7. Disclaimer of Warranty. Unless required by applicable law or
162
+ agreed to in writing, Licensor provides the Work (and each
163
+ Contributor provides its Contributions) on an "AS IS" BASIS,
164
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
165
+ implied, including, without limitation, any warranties or conditions
166
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
167
+ PARTICULAR PURPOSE. You are solely responsible for determining the
168
+ appropriateness of using or redistributing the Work and assume any
169
+ risks associated with Your exercise of permissions under this License.
170
+
171
+ 8. Limitation of Liability. In no event and under no legal theory,
172
+ whether in tort (including negligence), contract, or otherwise,
173
+ unless required by applicable law (such as deliberate and grossly
174
+ negligent acts) or agreed to in writing, shall any Contributor be
175
+ liable to You for damages, including any direct, indirect, special,
176
+ incidental, or consequential damages of any character arising as a
177
+ result of this License or out of the use or inability to use the
178
+ Work (including but not limited to damages for loss of goodwill,
179
+ work stoppage, computer failure or malfunction, or any and all
180
+ other commercial damages or losses), even if such Contributor
181
+ has been advised of the possibility of such damages.
182
+
183
+ 9. Accepting Warranty or Additional Liability. While redistributing
184
+ the Work or Derivative Works thereof, You may choose to offer,
185
+ and charge a fee for, acceptance of support, warranty, indemnity,
186
+ or other liability obligations and/or rights consistent with this
187
+ License. However, in accepting such obligations, You may act only
188
+ on Your own behalf and on Your sole responsibility, not on behalf
189
+ of any other Contributor, and only if You agree to indemnify,
190
+ defend, and hold each Contributor harmless for any liability
191
+ incurred by, or claims asserted against, such Contributor by reason
192
+ of your accepting any such warranty or additional liability.
193
+
194
+ END OF TERMS AND CONDITIONS
README.md CHANGED
@@ -5,11 +5,22 @@ license: apache-2.0
5
 
6
  # Conformer-CTC Small (Ambarella N1-655 CVflow v3 NVP)
7
 
 
 
 
 
8
  Model Configuration:
9
- - Upstream source: [https://huggingface.co/csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small](https://huggingface.co/csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small)
 
 
 
10
  - Support Cooper version:
11
  - CNNGen: `[3.9.0 / n1-655x]` (`cavalry_gen 3.0.4`)
12
 
 
 
 
 
13
  ## NVP Port & Runtime Specification
14
  - **Target SoC**: Ambarella N1-655 (`vdg_arch = 0xB`, CVflow v3 `cavalry_gen` 3.0.4)
15
  - **Input port**: `audio_signal` `[1, 80, 1024]` IEEE FP16 (16 kHz PCM -> 80-bin Kaldi log-Mel, 25 ms Povey window, 10 ms hop, per-feature mean/std normalized)
 
5
 
6
  # Conformer-CTC Small (Ambarella N1-655 CVflow v3 NVP)
7
 
8
+ Conformer-CTC Small is a convolution-augmented Transformer speech recognition model trained with Connectionist Temporal Classification (CTC) loss for English automatic speech recognition (ASR).
9
+
10
+ Original paper: [Conformer: Convolution-augmented Transformer for Speech Recognition](https://arxiv.org/abs/2005.08100)
11
+
12
  Model Configuration:
13
+ - Reference implementation: [https://github.com/NVIDIA/NeMo](https://github.com/NVIDIA/NeMo)
14
+ - Original Weight: [https://huggingface.co/csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small](https://huggingface.co/csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small)
15
+ - Dataset: NeMo ASRSet (LibriSpeech, Fisher, Switchboard, WSJ, NSC, Mozilla Common Voice)
16
+ - License: Apache-2.0 (`LICENSE`)
17
  - Support Cooper version:
18
  - CNNGen: `[3.9.0 / n1-655x]` (`cavalry_gen 3.0.4`)
19
 
20
+ ## Upstream Attribution & Modification Notice
21
+ - **Upstream Copyright**: Copyright (c) NVIDIA CORPORATION & Affiliates (NVIDIA NeMo `stt_en_conformer_ctc_small`) and Copyright (c) Xiaomi Corporation / `sherpa-onnx` contributors (`csukuangfj/sherpa-onnx-nemo-ctc-en-conformer-small`), licensed under the Apache License, Version 2.0.
22
+ - **Modification Notice (Apache-2.0 Section 4(b))**: Modified by Ambarella International LLC (2026). Fixed dynamic time dimension to static `[1, 80, 1024]` (10.24 s window), quantized to mixed FP16/INT8 via Ambarella CNNGen (`onnx_surgery` -> `vas` -> `cavalry_gen 3.0.4`), and compiled to CVflow v3 N1-655 (`vdg_arch = 0xB`) Cavalry DAG binary format (`n1-655_conformer_ctc_small_amba_optimized.bin`).
23
+
24
  ## NVP Port & Runtime Specification
25
  - **Target SoC**: Ambarella N1-655 (`vdg_arch = 0xB`, CVflow v3 `cavalry_gen` 3.0.4)
26
  - **Input port**: `audio_signal` `[1, 80, 1024]` IEEE FP16 (16 kHz PCM -> 80-bin Kaldi log-Mel, 25 ms Povey window, 10 ms hop, per-feature mean/std normalized)