NAM：神经放大器建模器

本仓库用于训练模型并将它们导出为 .nam 文件。如需在独立应用程序或插件中实时运行已训练的模型，请参阅配套仓库： NeuralAmpModelerPlugin。

有关 NAM 生态系统的更多信息，请访问 https://www.neuralampmodeler.com/。

文档

在线文档请见： https://neural-amp-modeler.readthedocs.io

在 Linux 系统上本地构建文档：

cd docs
make html

或在 Windows 上：

cd docs
make.bat html

Neural Amp Modeler (NAM) 快速上手指南

Neural Amp Modeler (NAM) 是一个用于训练吉他音箱建模神经网络并将模型导出为 .nam 格式的工具。本指南将帮助你快速搭建环境并开始训练。

环境准备

在开始之前，请确保你的系统满足以下要求：

• 操作系统：Linux、macOS 或 Windows。
• Python 版本：推荐 Python 3.8 或更高版本。
• 硬件建议：虽然可以在 CPU 上运行，但强烈建议使用 NVIDIA GPU 以加速训练过程（需安装对应的 CUDA 驱动）。
• 前置依赖：
  • Git（用于克隆代码库）
  • pip（Python 包管理工具）

国内加速建议：在安装 Python 依赖时，推荐使用清华或阿里镜像源以提升下载速度。

安装步骤

1. 克隆项目仓库 打开终端（Terminal 或 CMD），执行以下命令获取源代码：

   git clone https://github.com/sdatkinson/neural-amp-modeler.git
   cd neural-amp-modeler
   

2. 创建虚拟环境（推荐） 为了避免依赖冲突，建议创建一个独立的虚拟环境：

   python -m venv venv
   # Linux/macOS 激活环境
   source venv/bin/activate
   # Windows 激活环境
   venv\Scripts\activate
   

3. 安装依赖包 使用国内镜像源安装项目所需的 Python 库：

   pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
   

   (注：如果 requirements.txt 不存在，请直接安装主包：pip install neural-amp-modeler -i https://pypi.tuna.tsinghua.edu.cn/simple)

4. 安装本地开发版本 将当前目录下的包安装到环境中：

   pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
   

基本使用

NAM 的核心工作流通常包含数据录制、模型训练和模型导出。以下是最基础的训练命令示例。

1. 准备数据

你需要准备好输入信号（通常是干声吉他录音）和对应的输出信号（经过真实音箱录制后的声音）。文件通常为 WAV 格式。

2. 开始训练

使用 nam 命令行工具启动训练。以下是一个最简单的训练示例，假设你的数据位于 data/my_amp 目录下：

nam train data/my_amp --model-type lstm

• data/my_amp：包含训练数据（输入/输出对）的目录路径。
• --model-type：指定模型架构，常用选项包括 lstm 或 wavenet。

训练完成后，模型文件通常会保存在输出目录中，并可转换为 .nam 文件。

3. 查看文档

如需了解更详细的参数配置、数据结构要求或高级用法，可以查看官方在线文档： https://neural-amp-modeler.readthedocs.io

或者在本地构建文档（Linux）：

cd docs
make html

Windows 用户：

cd docs
make.bat html