AGENTS.md【免费下载链接】hixlHIXLHuawei Xfer Library是一个灵活、高效的昇腾单边通信库面向集群场景提供简单、可靠、高效的点对点数据传输能力。项目地址: https://gitcode.com/cann/hixl本文件为 Agent 在本仓库中工作提供指引重点说明仓库导航、常用命令和提交前约束。项目概述HIXLHuawei Xfer Library是面向昇腾芯片的单边通信库用于分布式 AI 场景LLM 推理 KV Cache 传输、PD 分离等。支持通过 HCCS 和 RDMA 协议进行点对点 D2D/D2H/H2D 数据传输并通过 pybind11 提供 Python 绑定。两个核心组件HIXL Enginesrc/hixl/底层传输引擎支持多种内存类型和传输协议。LLM-DataDistsrc/llm_datadist/基于 HIXL 构建的上层 KV Cache 传输接口对接 vLLM/SGLang。关键目录目录用途src/hixl/HIXL Engine 主要实现src/llm_datadist/LLM-DataDist 主要实现src/python/Python 绑定实现include/公开头文件和对外接口边界tests/cpp/C 测试tests/python/Python 测试examples/端到端样例benchmarks/性能用例与基准测试docs/构建、接口和其他说明文档构建与测试命令前置条件已安装 Ascend CANN toolkit且已执行source /usr/local/Ascend/cann/set_env.sh。如果环境未满足Agent 需要先说明阻塞原因不要虚报构建或测试结果。# 构建 bash build.sh # Release 构建输出到 build_out/ bash build.sh --build-typeDebug --asan # Debug 构建并开启 AddressSanitizer bash build.sh --examples # 同时编译示例和 benchmark # 测试 bash tests/run_test.sh # 执行全部 C 和 Python 测试 bash tests/run_test.sh -t cpp # 仅执行 C 测试 bash tests/run_test.sh -t py # 仅执行 Python 测试 bash tests/run_test.sh --cov # 按覆盖率模式构建并运行测试 # 代码检查 pip3 install -r requirements.txt # 安装 Python 依赖 pre-commit install # 安装 Git hooks pre-commit run --files changed-files # 只检查受影响文件始终使用bash build.sh和bash tests/run_test.sh不要手写零散 CMake 命令。代码改动至少运行受影响范围测试跨模块变更优先运行对应类型的完整测试。文档类改动至少检查引用路径、命令和文件名是否与仓库现状一致。如果某项验证因环境、依赖或硬件条件无法执行必须在结论中明确说明未验证项。代码风格与测试要求C遵循.clang-format基于 Google 风格2 空格缩进、120 列限制、附着式大括号、SortIncludes: false。类型用PascalCase函数用camelCase。Python使用ruff-check和ruff-format模块和测试文件用snake_case。测试文件命名C 以_unittest.cc或_ut.cc结尾Python 以test_*.py命名。行为变更必须补齐或更新测试。C 用例按模块放置例如tests/cpp/hixl/engine/、tests/cpp/llm_datadist/。Python 用例放在tests/python/test_*.py。提交前检查与提交规范建议先阅读docs/precommit_guide.md再执行pre-commit install和pre-commit run --files changed-files。OAT开源审计工具会在 pre-commit 中检查二进制文件和许可证头新增源码文件需要带正确的许可证头。禁止提交build_out/、build_test/、手动下载的第三方压缩包或其他二进制产物。如果 pre-commit 或 OAT 因环境问题未执行成功Agent 需要在最终说明中写明原因和影响范围。commit message 使用类型前缀[feat]、[bugfix]、[refactor]、[docs]搭配祈使句摘要。示例[bugfix]: fix channel cleanup race关键约束构建依赖 Ascend CANN 9.0.0运行依赖 8.5。未 source CANN 环境变量将无法构建。默认遵循仓库现有目录结构和工具链不随意引入新的构建入口或测试入口。【免费下载链接】hixlHIXLHuawei Xfer Library是一个灵活、高效的昇腾单边通信库面向集群场景提供简单、可靠、高效的点对点数据传输能力。项目地址: https://gitcode.com/cann/hixl创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考