仓库架构¶
仓库定位¶
qrlib 是一个面向三维深度学习基础能力的可复用代码库,不用于承载完整实验工程。
它的目标是保持:
- 边界清晰
- 公共接口稳定
- 容易被其他项目直接依赖
- 能被下一次 Codex 协作开发准确续写
代码分层¶
当前代码按稳定领域能力组织:
qrlib.data:通用数据处理能力qrlib.geometry:点云、网格、几何变换等稳定几何能力qrlib.metrics:可复用的指标计算能力
在子包内部,默认进一步区分:
- 公开接口模块
_前缀的内部实现模块
文档分层¶
文档同时分成两层:
- 公开文档:
docs/index.md、docs/getting-started.md、docs/tutorials/、docs/api/、docs/concepts/ - 维护者文档:
docs/developer/specs/、docs/developer/design/
维护者文档会构建进站点,但默认不出现在公开导航栏中。
为什么这样分层¶
这样做的目的不是增加文件数量,而是把四类信息分开:
- 用户需要知道什么
- 维护者需要承诺什么
- 维护者准备怎么实现
- 代码最终如何被验证
当这些信息分层清楚以后,后续无论是人工维护还是 Codex 协作,都会更容易保持一致。