Perch生物声学研究项目安装与使用指南

Perch生物声学研究项目安装与使用指南

1. 项目目录结构及介绍

Perch项目是一个由Google Research维护的生物声学研究工具，专注于鸟类声音的分类。以下是其核心目录结构概览及其主要组件：

• [google-research]/perch

  • AUTHORS: 作者列表。

  • CONTRIBUTING.md: 贡献者指南。

  • Dockerfile: Docker容器构建指令。

  • LICENSE: 许可证文件，遵循Apache-2.0许可协议。

  • README.md: 项目概述和快速入门指南。

  • agile_modeling.ipynb: 教程笔记本，展示如何快速构建针对新概念的分类器，结合搜索和主动学习。

  • analysis.ipynb: 分析笔记本，用于运行推断和进行呼叫密度估计。

  • embed_audio.ipynb: 大规模音频嵌入处理的笔记本。

  • call_density.py, call_density_test.py: 工具脚本，用于估计目标呼叫类型在数据集中音频窗口的比例。

  • github/workflows: 包含CI/CD相关的工作流程定义。

  • chirp: 子目录，内含BIRB基准评估、训练和评估代码等。

  • inference: 包含推理相关代码，尤其是对于敏捷建模部分。

  • pyproject.toml, poetry.lock: 项目管理和依赖配置文件。

2. 项目的启动文件介绍

Perch项目没有明确指出一个单一的“启动”文件，但主要通过Python脚本或Jupyter notebook进行交互和执行任务。 若要运行Perch或SurfPerch模型相关的任务，您将主要利用Jupyter Notebook如agile_modeling.ipynb或者通过命令行执行Python脚本，比如模型训练或推理过程中的脚本，这些通常分散在不同的目录下，需根据具体任务手动调用或通过Poetry管理的虚拟环境执行测试和脚本。

3. 项目的配置文件介绍

• pyproject.toml 和 poetry.lock: 这些文件是现代Python项目常用的依赖管理配置。pyproject.toml 定义了项目的元数据以及依赖关系，而poetry.lock则锁定了当前环境中所有依赖的确切版本，确保每次构建时的一致性。
• 在实际的训练和实验配置上，Perch更倾向于通过代码内（例如在训练脚本或Notebook内部）来设定参数和配置，而不是传统的独立配置文件方式。因此，配置细节更多地体现为模型超参数、数据路径、模型输出路径等，这些往往通过变量的形式在代码中指定。

为了开始使用Perch，首先需要设置好相应的开发环境，安装必要的依赖，并且选择合适的入口点（如上述提到的Notebook或是特定的Python脚本来开始你的生物声学研究之旅。