文档结构

本项目文档采用HTML静态页面实现,包含以下文件:

📁 code-docs/
📄 index.html - 架构总览页面
📄 core.html - 核心模块页面
📄 models.html - 模型定义页面(待创建)
📄 attention.html - 注意力机制页面(待创建)
📄 ops.html - 自定义算子页面(待创建)
📄 worker.html - 工作节点页面(待创建)
📄 distributed.html - 分布式页面(待创建)
📄 quantization.html - 量化页面(待创建)
📄 patch.html - 补丁模块页面(待创建)
📄 styles.css - 通用样式文件
📄 navigation.js - 导航脚本

使用步骤

  1. 打开文档

    在浏览器中打开 index.html 文件,即可查看项目架构总览。

  2. 浏览模块

    点击总览页面中的模块卡片,可以跳转到对应的模块详情页面。

  3. 使用导航

    每个页面顶部都有导航栏,可以快速切换到其他模块页面。

  4. 查看代码

    在模块详情页面中,可以查看相关代码示例和文件结构。

页面示例

以下是一些页面按钮示例:

架构总览 核心模块 模型定义 注意力机制 自定义算子 工作节点 分布式 量化 补丁模块

注意事项

1. 目前只有 index.html 和 core.html 页面已创建,其他模块页面需要后续补充。
2. 所有页面都使用了统一的样式和导航系统,保持一致性。
3. 可以根据需要添加更多内容,如代码示例、API文档等。

扩展文档

如需添加新的模块页面,请按照以下步骤操作:

首页