Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .trae/specs/radarmotr-beginner-guide/checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# RadarMOTR 小白学习指南 - Verification Checklist

## 文档完整性
- [x] 学习计划总览文档已创建 (`tutorials/00_学习计划总览.md`)
- [x] 阶段 1-10 文档全部创建
- [x] 所有文档在 `tutorials/` 目录下

## 内容质量
- [x] 每个阶段文档有明确的学习目标
- [x] 文档使用通俗易懂的中文
- [x] 文档结构清晰,易于导航
- [x] 对关键代码有详细的解释

## 代码链接
- [x] 每个文档包含相关文件的可点击链接
- [x] 所有链接指向正确的位置
- [x] 重要函数有行号锚点

## 学习体验
- [x] 学习路径由易到难排列
- [x] 各阶段学习时间分配合理
- [x] 有代码示例和解释
75 changes: 75 additions & 0 deletions .trae/specs/radarmotr-beginner-guide/spec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# RadarMOTR 小白学习指南 - Product Requirement Document

## Overview
- **Summary**: 创建一套完整的、循序渐进的小白学习指南,帮助初学者从零基础理解 RadarMOTR 多目标跟踪项目。
- **Purpose**: 解决小白面对复杂项目不知道从何入手的问题,提供清晰的学习路径和详细讲解。
- **Target Users**: 计算机视觉/深度学习初学者、雷达数据处理爱好者、多目标跟踪入门者。

## Goals
- 提供清晰的学习路径,按照由浅入深的顺序排列
- 对每个学习阶段提供详细的文档和代码注释
- 帮助小白理解项目的架构、核心逻辑和运行流程
- 最终让小白能够独立运行、调试和扩展项目

## Non-Goals (Out of Scope)
- 不修改任何项目源代码(纯讲解性质)
- 不创建新的算法或模型
- 不进行性能优化或新功能开发
- 不替代官方文档或论文

## Background & Context
RadarMOTR 是一个基于 Transformer 的雷达多目标跟踪项目,代码结构复杂,包含多个子系统。对于小白来说,直接看代码很容易迷失方向。需要一套系统性的学习方案。

## Functional Requirements
- **FR-1**: 创建学习计划总览文档
- **FR-2**: 为每个学习阶段创建详细的讲解文档
- **FR-3**: 标注关键代码位置和功能说明
- **FR-4**: 提供流程图和架构图辅助理解

## Non-Functional Requirements
- **NFR-1**: 文档使用中文编写,通俗易懂
- **NFR-2**: 提供可点击的代码链接,方便跳转
- **NFR-3**: 文档结构清晰,易于导航
- **NFR-4**: 各阶段学习时间估计合理

## Constraints
- **Technical**: 基于现有项目结构,不改变代码
- **Business**: 不影响现有项目功能
- **Dependencies**: 需要利用已有的 CODE_WIKI.md 和代码

## Assumptions
- 小白有基础的 Python 知识
- 小白了解基本的深度学习概念
- 小白已经完成环境搭建

## Acceptance Criteria

### AC-1: 学习计划总览文档创建成功
- **Given**: 项目结构已分析完成
- **When**: 创建学习计划文档
- **Then**: 文档包含完整的学习阶段划分和时间估计
- **Verification**: `human-judgment`
- **Notes**: 文档应逻辑清晰,学习路径合理

### AC-2: 各阶段详细讲解文档创建成功
- **Given**: 学习计划总览已完成
- **When**: 为每个学习阶段编写详细讲解
- **Then**: 每个阶段都有独立文档,包含核心代码注释
- **Verification**: `human-judgment`

### AC-3: 关键代码位置标注完成
- **Given**: 各阶段文档已创建
- **When**: 在文档中添加代码链接
- **Then**: 文档中包含可点击的文件和函数链接
- **Verification**: `programmatic` (检查链接有效性)

### AC-4: 学习流程图创建完成
- **Given**: 整体流程分析完成
- **When**: 绘制学习流程和数据流程图表
- **Then**: 图表清晰展示项目的数据流和控制流
- **Verification**: `human-judgment`

## Open Questions
- [ ] 小白是否需要更基础的 PyTorch 入门讲解?
- [ ] 是否需要包含实际运行步骤的详细截图?
- [ ] 是否需要创建简化的示例代码用于教学?
125 changes: 125 additions & 0 deletions .trae/specs/radarmotr-beginner-guide/tasks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# RadarMOTR 小白学习指南 - The Implementation Plan (Decomposed and Prioritized Task List)

## [ ] Task 1: 创建学习计划总览文档
- **Priority**: P0
- **Depends On**: None
- **Description**:
- 创建 `tutorials/00_学习计划总览.md
- 列出完整的学习路径
- 为每个阶段标注学习时间和重点内容
- **Acceptance Criteria Addressed**: [AC-1]
- **Test Requirements**:
- `human-judgement` TR-1.1: 文档包含 10 个学习阶段,每个阶段有明确的时间估计
- `human-judgement` TR-1.2: 学习路径逻辑清晰,从易到难排列合理
- **Notes**: 参考之前为用户提供的建议路径

## [ ] Task 2: 阶段 1: 项目背景介绍文档
- **Priority**: P0
- **Depends On**: [Task 1]
- **Description**:
- 创建 `tutorials/01_项目背景与介绍.md`
- 介绍项目是什么、要解决什么问题
- 项目的主要特点和应用场景
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-2.1: 清晰讲解项目用途
- `programmatic` TR-2.2: 文档中包含指向相关文件链接

## [ ] Task 3: 阶段 2: 依赖与环境配置
- **Priority**: P0
- **Depends On**: [Task 2]
- **Description**:
- 创建 `tutorials/02_环境与依赖.md`
- 讲解项目的环境要求和依赖项
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-3.1: 详细讲解每个依赖的作用
- `programmatic` TR-3.2: 包含依赖文件的链接

## [ ] Task 4: 阶段 3: 配置文件详解
- **Priority**: P0
- **Depends On**: [Task 3]
- **Description**:
- 创建 `tutorials/03_配置文件详解.md`
- 讲解核心配置文件和参数含义
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-4.1: 对关键参数的详细解释
- `programmatic` TR-4.2: 所有配置文件有链接

## [ ] Task 5: 阶段 4: 数据处理流程
- **Priority**: P0
- **Depends On**: [Task 4]
- **Description**:
- 创建 `tutorials/04_数据处理流程.md`
- 讲解数据加载、预处理和增强
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-5.1: 数据流程清晰
- `programmatic` TR-5.2: 数据相关代码文件有链接

## [ ] Task 6: 阶段 5: 核心数据结构
- **Priority**: P0
- **Depends On**: [Task 5]
- **Description**:
- 创建 `tutorials/05_核心数据结构.md`
- 讲解 Instances 和 Boxes
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-6.1: 数据结构的字段和方法清晰
- `programmatic` TR-6.2: 相关类和函数有链接

## [ ] Task 7: 阶段 6: 入口流程
- **Priority**: P0
- **Depends On**: [Task 6]
- **Description**:
- 创建 `tutorials/06_项目入口流程.md`
- 讲解训练和评估的主流程
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-7.1: 流程图或文字说明清晰
- `programmatic` TR-7.2: main.py 和 eval.py 有链接

## [ ] Task 8: 阶段 7: 核心模型
- **Priority**: P0
- **Depends On**: [Task 7]
- **Description**:
- 创建 `tutorials/07_核心模型.md`
- 讲解 RadarMOTR 和 Transformer
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-8.1: 模型结构和前向传播清晰
- `programmatic` TR-8.2: 模型文件有链接

## [ ] Task 9: 阶段 8: 跟踪逻辑
- **Priority**: P0
- **Depends On**: [Task 8]
- **Description**:
- 创建 `tutorials/08_跟踪逻辑.md`
- 讲解跟踪器和 Query 交互
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-9.1: 跟踪过程清晰
- `programmatic` TR-9.2: 跟踪器文件有链接

## [ ] Task 10: 阶段 9: 匹配与损失
- **Priority**: P0
- **Depends On**: [Task 9]
- **Description**:
- 创建 `tutorials/09_匹配与损失.md`
- 讲解 Hungarian 匹配和损失函数
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-10.1: 损失计算流程
- `programmatic` TR-10.2: 匹配器和损失函数有链接

## [ ] Task 11: 阶段 10: 工具函数
- **Priority**: P0
- **Depends On**: [Task 10]
- **Description**:
- 创建 `tutorials/10_工具函数与总结.md`
- 讲解工具函数和项目总结
- **Acceptance Criteria Addressed**: [AC-2, AC-3]
- **Test Requirements**:
- `human-judgement` TR-11.1: 工具函数清晰
- `programmatic` TR-11.2: 工具文件有链接
Loading