lightning-hydra-template

环境要求

• Python 环境（也可用 conda 创建独立环境）
• 已按 PyTorch 官方说明安装好 PyTorch
• 可联网安装 requirements.txt 中的依赖
• 能运行 pytest 的测试环境（可选，用于验证）

安装与启动步骤

1. 1获取项目代码

   README 要求点击 Use this template 按钮初始化自己的仓库，或直接下载代码；README 未给出 git clone 命令，此处不执行命令。

2. 2安装 PyTorch

   README 明确要求先按 PyTorch 官方安装说明装好对应 CUDA/CPU 版本的 PyTorch，但未给出具体安装命令。

3. 3安装依赖

   进入项目根目录后，按 Quickstart 安装 requirements.txt 中的依赖，需在装好 PyTorch 之后执行。

   pip install -r requirements.txt

   复制

4. 4可选 conda 环境

   README 另提供 conda 方式，用 environment.yaml 创建名为 myenv 的环境并安装依赖，二选一即可。

   conda env create -f environment.yaml -n myenv

   复制

5. 5启动训练

   模板自带 MNIST 分类示例，用默认配置启动训练，README 说明运行后应看到训练输出。

   python src/train.py

   复制

6. 6调试模式运行

   debug=default 启用调试友好配置，debug=fdr 只跑 1 个 train/val/test 循环且仅用 1 个 batch。

   python train.py debug=default
   python train.py debug=fdr

   复制

7. 7运行测试

   README 提供 pytest 验证命令，可跑全部测试、指定文件或跳过标记为 slow 的用例。

   pytest
   pytest tests/test_train.py
   pytest -k "not slow"

   复制

关键配置

如何确认成功

执行 python src/train.py 后终端出现 MNIST 训练日志与进度条，且无异常报错退出，即视为启动成功。

常见问题

注意事项

• README 未提供 git clone 命令，请通过 Use this template 按钮或下载代码包获取项目。
• Hydra 当前不支持从命令行追加列表，tags 传参时可能需按 README 提示转义方括号。
• 该模板更适合基于现成数据的模型原型开发，不太适合构建相互依赖的数据工程管道。
• 命令中出现的 train.py 与 src/train.py 均来自 README，请按实际所在目录执行。