deepfilternet3-assets

DeepFilterNet3 WASM and model assets for noise suppression.

Installation

``bash
npm install deepfilternet3-assets


or


yarn add deepfilternet3-assets
`

Contents

This package includes:
- pkg/df_bg.wasm - DeepFilterNet3 WebAssembly binary
- models/DeepFilterNet3_onnx.tar.gz - DeepFilterNet3 ONNX model

Usage

$3

`javascript
const { getWasmPath, getModelPath, getAssetPaths } = require('deepfilternet3-assets');

// Get individual paths
const wasmPath = getWasmPath();
const modelPath = getModelPath();

// Or get both at once
const { wasm, model } = getAssetPaths();
`

$3

For web applications, you can use the relative paths:

`javascript
const { WASM_RELATIVE_PATH, MODEL_RELATIVE_PATH } = require('deepfilternet3-assets');

// Then use with your bundler's asset handling
// For example, with Webpack or Vite
`

$3

You can copy these files to your static assets directory or CDN:

`javascript
const fs = require('fs');
const { getAssetPaths } = require('deepfilternet3-assets');

const assets = getAssetPaths();

// Copy to your public directory
fs.copyFileSync(assets.wasm, './public/wasm/df_bg.wasm');
fs.copyFileSync(assets.model, './public/models/DeepFilterNet3_onnx.tar.gz');
`

$3

This package includes TypeScript type definitions:

`typescript
import { getAssetPaths, WASM_RELATIVE_PATH, MODEL_RELATIVE_PATH } from 'deepfilternet3-assets';

const { wasm, model } = getAssetPaths();

// Use relative paths for URLs
console.log(WASM_RELATIVE_PATH); // 'pkg/df_bg.wasm'
console.log(MODEL_RELATIVE_PATH); // 'models/DeepFilterNet3_onnx.tar.gz'
`

File Sizes

- WASM file: 8.8 MB
- Model file: 7.7 MB
- Total package size: ~10.4 MB (compressed), ~17.1 MB (unpacked)

Make sure your CDN or server can handle these file sizes efficiently.

API Reference

$3

- getWasmPath() - Returns absolute path to the WASM file
- getModelPath() - Returns absolute path to the model file
- getAssetPaths() - Returns object with both asset paths: { wasm: string, model: string }

$3

- WASM_RELATIVE_PATH - Relative path to WASM file: 'pkg/df_bg.wasm'
- MODEL_RELATIVE_PATH - Relative path to model file: 'models/DeepFilterNet3_onnx.tar.gz'`

Example

See example.js for a complete working example.

License

(Apache-2.0 OR MIT)

Credits

DeepFilterNet3 is developed by Rikorose. This package only distributes the compiled assets.