diff --git a/README.md b/README.md index ee11f67e03c85da0b8400ccf1b647cc368486464..966015daad614ffbaf9ca47b05a0991b6fc34768 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # hccl-controller +- [免责申明](#免责申明) - [组件介绍](#组件介绍) +- [支持的产品形态](#支持的产品形态) - [编译HCCL-Controller](#编译HCCL-Controller) - [组件安装](#组件安装) - [说明](#说明) - [更新日志](#更新日志) +- [版本配套说明](#版本配套说明) + +# 免责申明 +- 本代码仓库中包含多个开发分支,这些分支可能包含未完成、实验性或未测试的功能。在正式发布之前,这些分支不应被用于任何生产环境或依赖关键业务的项目中。请务必仅使用我们的正式发行版本,以确保代码的稳定性和安全性。 + 使用开发分支所导致的任何问题、损失或数据损坏,本项目及其贡献者概不负责。 +- 正式版本请参考:[hccl-controller正式release版本](https://gitee.com/ascend/ascend-hccl-controller/releases) # 组件介绍 @@ -47,6 +55,12 @@ HCCL-Controller是专门用于生成训练作业所有Pod的hccl.json文件的 - hccl-controller持续监控 volcano job,pod和ConfigMap的变化(需携带[•约定1:训练任务,Pod,ConfigMap需...](#li121021418717)中的标签),同一个训练任务的volcano job和ConfigMap通过volume(ascend-910-config)关联。如果有新创建的Pod,hccl-controller把Pod中的annotation(atlas.kubectl.kubernetes.io/ascend-910-configuration)的值取出,为volcano job创建数据缓存信息表,当volcano job的所有实例信息获取完整后,更新对应的rings-config的ConfigMap。 - ConfigMap中rings-config的文件名默认为hccl.json,默认挂在路径为:“/user/serverid/devindex/config”。 +# 支持的产品形态 + +- 支持以下产品使用: + - Atlas 训练系列产品 + - Atlas A2 训练系列产品 + # 编译HCCL-Controller 1. 通过git拉取源码,并切换sync-dev分支,获得ascend-hccl-controller。 @@ -85,7 +99,13 @@ HCCL-Controller是专门用于生成训练作业所有Pod的hccl.json文件的 # 更新日志 -| 版本 | 发布日期 | 修改说明 | -| ---- | ---- | ---- | -| v3.0.0| 2022-1230 | 首次发布 | +| 版本 | 发布日期 | 修改说明 | +|----------|-----------|-------------------| +| v6.0.RC2 | 2024-716 | 配套MindX 6.0.RC2版本 | +| v5.0.1 | 2024-518 | 配套MindX 5.0.1版本 | +| v6.0.RC1 | 2024-422 | 配套MindX 6.0.RC1版本 | +| v5.0.0 | 2023-1229 | 配套MindX 5.0.0版本 | +| v5.0.RC3 | 2023-1027 | 首次发布 | +# 版本配套说明 +版本配套详情请参考:[版本配套详情](https://www.hiascend.com/developer/download/commercial) \ No newline at end of file