Skip to content

在重构过程中,我发现 wiki 文档缺少以下关键信息,这些缺失会导致重构时需要"猜测": #1

Description

@goRealLife
  1. 缺少精确的函数签名和参数列表
    问题:wiki 只描述了"某个方法做什么",但没有精确的参数名、类型、默认值。
    建议:对核心类的方法,增加精确的函数签名,如:
def _sample_timestamps(timestamps: List[float], target_hz: float, tolerance_ms: float) -> List[float]
  1. 缺少 YAML 配置的完整内容
    问题:wiki 描述了 YAML 配置有哪些字段,但没有提供完整的 e2e_pipeline.yaml 和各 subdag.yaml 的实际内容。节点的 params 具体取值不确定。
    建议:将完整的 YAML 配置文件作为附录或单独页面保存。

  2. 缺少 Pydantic Schema 定义
    问题:wiki 提到节点有 LoadingInput/LoadingOutput 等 Pydantic 模型,但没有给出字段定义。
    建议:对每个节点的 Input/Output Pydantic 模型,列出字段名、类型、默认值。

  3. 缺少类型映射表的完整数据
    问题:wiki 只说 OBSTACLE_TYPE_MAP 包含"车辆 1-19、VRU 21-29"等,但具体映射值不确定。
    建议:对纯数据文件(type_mappings.py 等),直接保存完整内容。

  4. 缺少数据结构/协议的精确定义
    问题:节点间传递的数据字典具体有哪些 key?_files 和 _global_files 的嵌套格式是什么?
    建议:增加数据协议(Data Protocol)文档,用 JSON Schema 或示例数据定义节点间传递的数据格式。

  5. 缺少字段映射配置文件(mapping config)
    问题:MsgMapBaseNode._load_mapping_config() 从外部 YAML 加载字段映射,但 wiki 没有保存这些映射配置文件的内容。
    建议:对配置文件类的内容,直接保存完整内容到 wiki。

  6. 缺少 _resolve_data_key 的详细说明
    问题:wiki 提到了这个"临时方案"尝试带/不带 .json 后缀,但这对 debug/release 双模式兼容至关重要。
    建议:对标注为"临时方案"但影响全局行为的逻辑,增加独立的概念文档说明。

  7. 缺少 vehicle_config 目录的完整内容
    问题:车辆参数(type/l/w/h/wheelbase)、方向盘转角映射表等具体数据缺失。
    建议:将 vehicle_config/ 目录下的 YAML 文件内容保存到 wiki。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions