DeepFilterNet 项目教程

1. 项目目录结构及介绍

DeepFilterNet 项目的目录结构如下：

DeepFilterNet/
├── assets/
├── demo/
├── ladspa/
├── libDF/
├── models/
├── pyDF-data/
├── pyDF/
├── scripts/
├── Cargo.lock
├── Cargo.toml
├── LICENSE
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── cbindgen.toml
├── clippy.toml
├── post-release.sh
├── pyproject.toml
├── release.sh
├── rustfmt.toml

目录介绍：

• assets/: 存放项目相关的资源文件。
• demo/: 存放演示相关的文件，包括演示视频和演示代码。
• ladspa/: 包含 LADSPA 插件的代码，用于实时噪声抑制。
• libDF/: 包含 Rust 代码，用于数据加载和增强。
• models/: 存放预训练模型的权重文件。
• pyDF-data/: 包含 Python 包装器，用于数据集功能和 PyTorch 数据加载器。
• pyDF/: 包含 Python 包装器，用于 libDF 的 STFT/ISTFT 处理循环。
• scripts/: 存放一些脚本文件，如发布脚本等。
• Cargo.lock: Rust 项目的依赖锁定文件。
• Cargo.toml: Rust 项目的配置文件。
• LICENSE: 项目的许可证文件。
• LICENSE-APACHE: Apache 许可证文件。
• LICENSE-MIT: MIT 许可证文件。
• README.md: 项目的说明文档。
• cbindgen.toml: 用于生成 C 绑定的配置文件。
• clippy.toml: Clippy（Rust 静态分析工具）的配置文件。
• post-release.sh: 发布后的脚本文件。
• pyproject.toml: Python 项目的配置文件。
• release.sh: 发布脚本文件。
• rustfmt.toml: Rust 格式化工具的配置文件。

2. 项目的启动文件介绍

DeepFilterNet 项目的启动文件主要是 df-demo 和 enhance.py。

df-demo

df-demo 是一个演示程序，用于展示 DeepFilterNet 的实时噪声抑制功能。你可以通过以下命令运行它：

cargo +nightly run -p df-demo --features ui --bin df-demo --release

enhance.py

enhance.py 是一个 Python 脚本，用于增强噪声音频文件。你可以通过以下命令运行它：

python DeepFilterNet/df/enhance.py --help

该脚本支持多种选项，如指定模型目录、输出目录、日志级别等。

3. 项目的配置文件介绍

DeepFilterNet 项目中有多个配置文件，主要用于 Rust 和 Python 项目的配置。

Cargo.toml

Cargo.toml 是 Rust 项目的配置文件，定义了项目的依赖、构建选项等。

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，定义了 Python 包的依赖、构建选项等。

rustfmt.toml

rustfmt.toml 是 Rust 格式化工具的配置文件，定义了代码格式化的规则。

clippy.toml

clippy.toml 是 Clippy（Rust 静态分析工具）的配置文件，定义了静态分析的规则。

cbindgen.toml

cbindgen.toml 是用于生成 C 绑定的配置文件，定义了生成 C 绑定的规则。

这些配置文件共同确保了项目的正确构建和运行。