DeepFilterNet3 3.0-stream-t100-fp16

DeepFilterNet3-Stream-T100-fp16.mlpackage/Data/com.apple.CoreML/model.mlmodel

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

DeepFilterNet3-Stream-T100-fp16.mlpackage/Data/com.apple.CoreML/weights/weight.bin

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

DeepFilterNet3-Stream-T100-fp16.mlpackage/Manifest.json

@@ -0,0 +1,18 @@
+{
+    "fileFormatVersion": "1.0.0",
+    "itemInfoEntries": {
+        "106285B0-C8D9-49D4-8722-EC4A42CC3947": {
+            "author": "com.apple.CoreML",
+            "description": "CoreML Model Specification",
+            "name": "model.mlmodel",
+            "path": "com.apple.CoreML/model.mlmodel"
+        },
+        "3ACE77A6-CD9D-4851-9143-6A0514664F7A": {
+            "author": "com.apple.CoreML",
+            "description": "CoreML Model Weights",
+            "name": "weights",
+            "path": "com.apple.CoreML/weights"
+        }
+    },
+    "rootModelIdentifier": "106285B0-C8D9-49D4-8722-EC4A42CC3947"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Hendrik Schröter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,32 @@
+---
+license: mit
+tags:
+  - coreml
+  - audio
+  - speech-enhancement
+  - noise-suppression
+---
+
+# DeepFilterNet3 for Core ML (streaming, 100 frames, FP16)
+
+A Core ML conversion of [DeepFilterNet3](https://github.com/Rikorose/DeepFilterNet) by Hendrik Schröter, used for noise reduction in Clarity Sound Studio, a free, open-source macOS app.
+
+Only the network is converted. The DSP around it (STFT, ERB and complex features, the mask, the deep filter and the inverse STFT) runs in the app. `dfn3_dsp.json` records that contract: window, ERB band widths, normalisation constants and the coefficient layout. The same JSON is in the model's `user_defined_metadata["dsp"]`.
+
+| | |
+| --- | --- |
+| File | `DeepFilterNet3-Stream-T100-fp16.mlpackage` (ML Program, FP16, macOS 14+) |
+| Upstream | DeepFilterNet3 weights at commit `d375b2d` (`dfn3-epoch120-best`) |
+| Conversion | `convert.py --frames 100 --precision fp16 --gru unrolled`: stateful in chunks of 100 frames (10 ms hop at 48 kHz), the GRU and convolution state passed in and out as tensors |
+| Inputs | `feat_erb`, `feat_spec` and six state tensors (zero at the start) |
+| Outputs | `mask`, `coefs` and the next state |
+
+The weights are unchanged apart from the conversion to FP16.
+
+## Licence
+
+DeepFilterNet is dual-licensed under MIT or Apache-2.0. This conversion is distributed under the MIT licence; see `LICENSE`.
+
+Copyright (c) 2021 Hendrik Schröter.
+
+> H. Schröter, T. Rosenkranz, A. N. Escalante-B. and A. Maier, "DeepFilterNet: Perceptually Motivated Real-Time Speech Enhancement", Interspeech 2023.

dfn3_dsp.json

@@ -0,0 +1,57 @@
+{
+ "sample_rate": 48000,
+ "fft_size": 960,
+ "hop_size": 480,
+ "nb_erb": 32,
+ "nb_df": 96,
+ "df_order": 5,
+ "df_lookahead": 2,
+ "conv_lookahead": 2,
+ "norm_alpha": 0.99,
+ "erb_widths": [
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  2,
+  5,
+  5,
+  7,
+  7,
+  8,
+  10,
+  12,
+  13,
+  15,
+  18,
+  20,
+  24,
+  28,
+  31,
+  37,
+  42,
+  50,
+  56,
+  67
+ ],
+ "wnorm": 0.0010416666666666667,
+ "window": "vorbis: sin(pi/2 * sin^2(pi*(n+0.5)/N))",
+ "erb_norm_init": [
+  -60.0,
+  -90.0
+ ],
+ "unit_norm_init": [
+  0.001,
+  0.0001
+ ],
+ "frames_per_call": 100,
+ "coefs_layout": "[1,T,96,10]: tap-major, (re,im) interleaved; tap n multiplies spectrum frame t+n-2"
+}