🧪 AI Research Template

AI/ML 实验管理系统模板 - 结构化管理研究实验、文档和知识

---

✨ 特性

• 📁 结构化实验管理 - 智库导航(Hub) + 实验追踪(Roadmap) + 实验报告(Exp)
• 🤖 Cursor AI 集成 - 快捷命令驱动的工作流
• 📝 模板系统 - 预定义的实验报告、知识卡片、Coding Prompt 模板
• 🔄 知识提炼 - 从实验中提炼设计原则和知识卡片

---

🚀 快速开始

1. 使用此模板创建新项目

点击 GitHub 页面上的 "Use this template" 按钮，或：

gh repo create my-research-project --template YOUR_USERNAME/AI_Research_Template

2. 克隆并初始化

git clone https://github.com/YOUR_USERNAME/my-research-project.git
cd my-research-project

3. 配置项目

编辑 .cursorrules 文件，更新项目特定信息：

• 报告输出路径
• 项目背景和目标
• 常用指标和实验变量

---

📁 项目结构

AI_Research_Template/
├── .cursorrules           # Cursor AI 规则配置
├── COMMANDS.md            # 命令速查手册
├── README.md              # 本文件
│
├── experiments/           # 📗 实验文档
│   └── [topic]/           # 按主题分类
│       ├── [topic]_hub.md         # 智库导航
│       ├── [topic]_roadmap.md     # 实验追踪
│       ├── exp_*.md               # 实验报告
│       ├── card/                  # 知识卡片
│       ├── sessions/              # GPT 会话
│       ├── prompts/               # Coding Prompt
│       └── img/                   # 图表
│
├── status/                # 📋 状态追踪
│   ├── next_steps.md      # 下一步计划
│   ├── archive_queue.md   # 归档队列
│   └── kanban.md          # 看板
│
├── design/                # 📐 设计原则
│   └── principles.md      # 原则汇总
│
├── reports/               # 📊 报告
│   └── drafts/            # 报告草稿
│
├── scripts/               # 🔧 脚本
├── configs/               # ⚙️ 配置文件
├── data/                  # 📦 数据
├── logs/                  # 📝 日志
├── results/               # 📈 结果
│
└── _backend/              # 🔒 后端
    ├── template/          # 模板文件
    │   ├── exp.md         # 实验报告模板
    │   ├── hub.md         # 智库导航模板
    │   ├── roadmap.md     # 实验追踪模板
    │   ├── card.md        # 知识卡片模板
    │   ├── session.md     # 会话模板
    │   └── prompt_coding.md # Coding Prompt 模板
    └── scripts/           # 辅助脚本

---

📖 命令速查

在 Cursor 中使用这些快捷命令：

命令	作用
?	查看进度状态
n	新建实验计划
a	归档实验结果
u	更新文档
p	生成 Coding Prompt
card	创建知识卡片
design	提取设计原则
next	管理待办
merge	合并实验
session	GPT 会话归档

详细说明请查看 COMMANDS.md

---

🔄 工作流

规划实验 (n)
    ↓
执行实验 (python scripts/xxx.py)
    ↓
归档结果 (a)
    ↓
更新文档 (u)
    ↓
提炼知识 (card)
    ↓
规划下一步 (next)

---

📝 文档层级

层级	文件	职责
1	session.md	GPT 脑暴对话
2a	hub.md	问题树、假设、战略导航
2b	roadmap.md	MVP 列表、进度追踪
3	exp.md	单实验详细记录
4	card.md	跨实验知识卡片
5	next_steps.md	日常待办

---

🏷️ Experiment ID 格式

EXP-YYYYMMDD-topic-XX

示例：EXP-20250108-model-01

---

📚 模板位置

所有模板文件位于 _backend/template/

模板	用途
exp.md	实验报告
hub.md	智库导航
roadmap.md	实验追踪
card.md	知识卡片
session.md	GPT 会话
prompt_coding.md	Coding Prompt

---

🛠️ 自定义

修改 Cursor 规则

编辑 .cursorrules 文件来自定义：

1. 报告输出位置 - 修改 experiments/ 路径
2. 项目背景 - 添加你的研究目标和方向
3. 常用指标 - 定义项目特定的评估指标
4. 作者信息 - 更新默认作者

添加新模板

在 _backend/template/ 目录下添加新的 .md 模板文件。

---

📋 使用前检查清单

使用此模板创建新项目后：

• 更新 .cursorrules 中的项目信息
• 更新 README.md 中的项目名称和描述
• 配置 status/next_steps.md 初始待办
• 创建第一个实验主题目录 experiments/[topic]/

---

👤 作者

Viska Wei

---

📄 License

MIT License - 自由使用、修改和分发