SayedShaun commited on
Commit
fd3221a
·
verified ·
1 Parent(s): 38d3eee

Add DeepFilterNet3 ONNX export (converted from upstream checkpoint, MIT/Apache-2.0)

Browse files
Files changed (9) hide show
  1. LICENSE-APACHE +201 -0
  2. LICENSE-MIT +19 -0
  3. README.md +44 -0
  4. SHA256SUMS.txt +5 -0
  5. config.ini +125 -0
  6. df_dec.onnx +3 -0
  7. enc.onnx +3 -0
  8. erb_dec.onnx +3 -0
  9. version.txt +1 -0
LICENSE-APACHE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2021 Hendrik Schröter
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
LICENSE-MIT ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ The MIT License (MIT)
2
+ Copyright (c) 2021 Hendrik Schröter
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
5
+ this software and associated documentation files (the "Software"), to deal in
6
+ the Software without restriction, including without limitation the rights to
7
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
8
+ the Software, and to permit persons to whom the Software is furnished to do so,
9
+ subject to the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in all
12
+ copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
16
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
17
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
18
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
README.md ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: mit-or-apache-2.0
4
+ license_link: https://github.com/Rikorose/DeepFilterNet/blob/main/LICENSE-MIT
5
+ tags:
6
+ - audio
7
+ - speech-enhancement
8
+ - denoising
9
+ - onnx
10
+ - deepfilternet
11
+ ---
12
+
13
+ # DeepFilterNet3 (ONNX)
14
+
15
+ ONNX export of the DeepFilterNet3 pretrained model, converted from the PyTorch checkpoint with the upstream export script.
16
+
17
+ This is an unofficial conversion by a third party. It is not published by the DeepFilterNet authors.
18
+
19
+ - **Original author:** Hendrik Schröter and the DeepFilterNet contributors
20
+ - **Upstream project:** https://github.com/Rikorose/DeepFilterNet
21
+ - **Source checkpoint:** `DeepFilterNet3.zip` from upstream commit `82b0c7ad33fc756284104053817d1e855d8d8386`, the PyTorch mirror at https://huggingface.co/SayedShaun/DeepFilterNet3-mirror. Checkpoint epoch 120.
22
+ - **Export script:** `df/scripts/export.py` from upstream commit `7b14b895fe7fc42cab72b4a4c1e49c982bd6404b` (2026-11-06), run with default options: opset 12, no simplification, no post-filter.
23
+ - **Versions:** PyTorch 2.2.2 (CPU), ONNX 1.23.2, ONNX Runtime 1.32.0.
24
+
25
+ ## Files
26
+
27
+ - `enc.onnx`: encoder
28
+ - `erb_dec.onnx`: ERB decoder
29
+ - `df_dec.onnx`: deep-filter decoder
30
+ - `config.ini`: model configuration from the checkpoint
31
+ - `version.txt`: model name and epoch
32
+ - `SHA256SUMS.txt`: checksums of the files above
33
+
34
+ ## Verification
35
+
36
+ The three ONNX models were run with ONNX Runtime on the input tensors saved during export, and compared with the PyTorch outputs. The maximum absolute difference was 4.8e-6 (encoder), 6.3e-7 (ERB decoder) and 1.2e-7 (DF decoder).
37
+
38
+ Compared with upstream's `DeepFilterNet3_onnx.tar.gz`, the sizes of the three ONNX files are within a few kilobytes of upstream's. The bytes are not identical, which is expected for a different PyTorch and ONNX version. Upstream's archive is the reference if you need the exact upstream files.
39
+
40
+ ## License
41
+
42
+ The code and model weights of DeepFilterNet are dual-licensed under the MIT License or the Apache License, Version 2.0, at your option. The license texts are included as `LICENSE-MIT` and `LICENSE-APACHE`. Copyright (c) 2021 Hendrik Schröter (per the upstream MIT license).
43
+
44
+ Upstream license statement: https://github.com/Rikorose/DeepFilterNet#license
SHA256SUMS.txt ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ 346076860ef95c49e2e6f853f4e35ed2b4f78d4809191c0cadf74ca886bb2c27 df_dec.onnx
2
+ 0e2ff9c82926e92391a2c3997c9bf1d6baf928193ccc5588b01559ba6b99c761 enc.onnx
3
+ 3904877411f20101f38f4fcd1b73f98afdd4257539618c3bb1e51e3f2baf6bd6 erb_dec.onnx
4
+ 415eb925d44990d938fb739f514aa3662c1ec0ea836cff044fa1291b82cb4290 config.ini
5
+ 2d841d2e859d3a312c974ec17ca578b0186677c3d99e89fb8b8604a90ad21314 version.txt
config.ini ADDED
@@ -0,0 +1,125 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [train]
2
+ seed = 43
3
+ device =
4
+ model = deepfilternet3
5
+ jit = false
6
+ mask_only = false
7
+ df_only = false
8
+ batch_size = 64
9
+ batch_size_eval = 64
10
+ num_workers = 16
11
+ max_sample_len_s = 3.0
12
+ p_atten_lim = 0.0
13
+ overfit = false
14
+ max_epochs = 120
15
+ log_freq = 100
16
+ log_timings = True
17
+ validation_criteria = loss
18
+ validation_criteria_rule = min
19
+ early_stopping_patience = 25
20
+ global_ds_sampling_f = 1
21
+ num_prefetch_batches = 8
22
+ dataloader_snrs = -100,-5,0,5,10,20,40
23
+ detect_anomaly = false
24
+ batch_size_scheduling = 0/16,2/24,5/32,10/64,20/128,40/9999
25
+ start_eval = false
26
+ validation_set_caching = false
27
+ cp_blacklist =
28
+
29
+ [distortion]
30
+ p_reverb = 0.1
31
+ p_bandwidth_ext = 0.0
32
+ p_clipping = 0.0
33
+ p_air_absorption = 0.0
34
+ p_zeroing = 0.0
35
+ p_interfer_sp = 0.0
36
+
37
+ [df]
38
+ sr = 48000
39
+ fft_size = 960
40
+ hop_size = 480
41
+ nb_erb = 32
42
+ nb_df = 96
43
+ norm_tau = 1
44
+ lsnr_max = 35
45
+ lsnr_min = -15
46
+ min_nb_erb_freqs = 2
47
+ pad_mode = output
48
+ df_order = 5
49
+ df_lookahead = 2
50
+
51
+ [deepfilternet]
52
+ conv_lookahead = 2
53
+ conv_ch = 64
54
+ conv_depthwise = True
55
+ emb_hidden_dim = 256
56
+ emb_num_layers = 3
57
+ enc_linear_groups = 32
58
+ linear_groups = 16
59
+ conv_dec_mode = transposed
60
+ convt_depthwise = False
61
+ mask_pf = False
62
+ df_hidden_dim = 256
63
+ df_num_layers = 2
64
+ dfop_method = df
65
+ group_shuffle = False
66
+ conv_kernel = 1,3
67
+ df_gru_skip = groupedlinear
68
+ df_pathway_kernel_size_t = 5
69
+ enc_concat = False
70
+ conv_kernel_inp = 3,3
71
+ emb_gru_skip = none
72
+ df_n_iter = 1
73
+ convt_kernel = 1,3
74
+ lsnr_dropout = False
75
+
76
+ [localsnrloss]
77
+ factor = 1e-3
78
+
79
+ [maskloss]
80
+ factor = 0
81
+ mask = spec
82
+ gamma = 0.3
83
+ gamma_pred = 0.3
84
+ f_under = 1
85
+
86
+ [spectralloss]
87
+ factor_magnitude = 0
88
+ factor_complex = 0
89
+ gamma = 0.3
90
+ factor_under = 1
91
+
92
+ [dfalphaloss]
93
+ factor = 0.0
94
+
95
+ [multiresspecloss]
96
+ factor = 500
97
+ factor_complex = 500
98
+ gamma = 0.3
99
+ fft_sizes = 256,512,1024,2048
100
+
101
+ [optim]
102
+ lr = 0.001
103
+ momentum = 0
104
+ weight_decay = 1e-12
105
+ weight_decay_end = 0.01
106
+ optimizer = adamw
107
+ lr_min = 1e-06
108
+ lr_warmup = 0.0001
109
+ warmup_epochs = 3
110
+ lr_cycle_mul = 1.0
111
+ lr_cycle_decay = 0.5
112
+ lr_cycle_limit = 1
113
+ lr_update_per_epoch = False
114
+ lr_cycle_epochs = -1
115
+
116
+ [sdrloss]
117
+ factor = 0.0
118
+ segmental_ws = 0
119
+
120
+ [asrloss]
121
+ factor = 0
122
+ factor_lm = 0
123
+ loss_lm = CrossEntropy
124
+ model = base.en
125
+
df_dec.onnx ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:346076860ef95c49e2e6f853f4e35ed2b4f78d4809191c0cadf74ca886bb2c27
3
+ size 3339362
enc.onnx ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:0e2ff9c82926e92391a2c3997c9bf1d6baf928193ccc5588b01559ba6b99c761
3
+ size 1954046
erb_dec.onnx ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3904877411f20101f38f4fcd1b73f98afdd4257539618c3bb1e51e3f2baf6bd6
3
+ size 3292401
version.txt ADDED
@@ -0,0 +1 @@
 
 
1
+ DeepFilterNet3_epoch_120