LFADS-torch 开源项目启动和配置教程

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

lfads-torch 项目是一个基于 PyTorch 的 Latent Factor Analysis via Dynamical Systems (LFADS) 实现。以下是项目的目录结构及其简要介绍：

lfads-torch/
├── configs/           # 配置文件目录，包含数据模块和模型配置
│   ├── datamodule/    # 数据模块配置文件
│   └── model/         # 模型配置文件
├── datasets/          # 示例数据集目录
├── lfads_torch/       # LFADS-torch 的主要代码模块
├── scripts/           # 脚本目录，包含启动和训练项目的脚本
├── tutorials/         # 教程目录，包含多会话模型初始化的教程
├── .gitignore         # Git 忽略文件
├── CITATION.cff       # 项目引用文件
├── LICENSE            # 项目许可证文件
├── README.md          # 项目说明文件
├── requirements.txt   # 项目依赖文件
└── setup.py           # 项目设置文件

2. 项目的启动文件介绍

项目的启动主要通过 scripts 目录下的脚本进行。以下是一些主要的启动文件及其功能：

• run_single.py: 用于在单个数据集上启动和训练单一模型的脚本。
• run_multi.py: 用于执行随机搜索来寻找最佳超参数的脚本。
• run_pbt.py: 用于执行基于种群训练的脚本，以寻找数据集上表现良好的超参数。

启动一个模型的基本步骤如下：

1. 克隆项目仓库：git clone https://github.com/arsedler9/lfads-torch.git
2. 创建并激活虚拟环境：conda create --name lfads-torch python=3.9 和 conda activate lfads-torch
3. 安装项目依赖：pip install -e .
4. 安装 pre-commit 钩子：pre-commit install
5. 修改 scripts/run_single.py 中的 RUN_DIR 和 overrides 参数以指定模型目录和配置。
6. 在虚拟环境中运行 scripts/run_single.py 脚本以启动训练。

3. 项目的配置文件介绍

配置文件位于 configs 目录中，分为数据模块配置和模型配置两部分。

• 数据模块配置 (configs/datamodule/): 包含数据文件的路径、批量大小等数据加载相关的配置。例如，对于单会话运行，配置文件可能如下所示：

_target_: lfads_torch.datamodules.BasicDataModule
datafile_pattern: "path/to/your/data.hdf5"
batch_size: 64

• 模型配置 (configs/model/): 包含 LFADS 模型的架构和超参数设置。例如，对于一个单会话模型，配置文件可能如下所示：

encod_data_dim: 32
encod_seq_len: 100
recon_seq_len: 100
readout:
  modules:
    - out_features: 32

用户需要根据自己数据集的特点调整配置文件中的参数，以优化模型的性能。