Wavetorch 开源项目启动与配置教程

1. 项目的目录结构及介绍

Wavetorch 是一个基于 PyTorch 的开源项目，用于数值求解标量波动方程并进行波传播的机器学习研究。项目的主要目录结构如下：

• wavetorch/: 包含项目的核心代码，包括模块定义和类实现。
  • data/: 存储数据集，如原始音频记录。
  • img/: 存储项目相关的图像文件，例如波形图和结果图。
  • study/: 包含用于训练、优化和分析的脚本。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 设置项目的基本信息和依赖。
• LICENSE.md: 项目的 MIT 许可证。
• README.md: 项目的说明文件。

2. 项目的启动文件介绍

项目的启动主要涉及 study/ 目录下的脚本。以下是一些主要脚本的简要介绍：

• propagate.py: 用于传播波形的脚本，可以查看波在时间域中的传播情况。
• optimize_lens.py: 用于优化透镜设计的脚本，通过调整材料分布以优化波前。
• vowel_train.py: 用于训练 vowel 识别模型的脚本，根据配置文件进行模型训练。

使用这些脚本时，通常需要在项目顶层目录下通过 Python 命令运行相应的脚本。

3. 项目的配置文件介绍

项目的配置主要通过 study/ 目录下的 YAML 文件进行。以下是一个典型的配置文件 example.yml 的介绍：

# example.yml
data:
  vowel_data_path: ./data/vowels
  sample_rate: 16000
  batch_size: 32
  window_length: 256

physics:
  material_density: [1.0, 1.5]
  wave_speed: 340.0

training:
  learning_rate: 0.001
  epochs: 100
  loss_function: mse

配置文件中包含了以下部分：

• data: 数据相关的配置，如数据路径、采样率和批次大小。
• physics: 物理相关的配置，如材料密度和波速。
• training: 训练相关的配置，如学习率、迭代次数和损失函数。

启动项目时，需要指定配置文件的路径，例如：

python ./study/vowel_train.py ./study/example.yml

通过修改配置文件，用户可以调整模型的训练过程和波传播的物理参数，以适应不同的研究和应用需求。