diff --git a/README.md b/README.md index 737753c..4f71bde 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ --- -## 🧠 比赛背景简介 +## 💻 比赛背景简介 在 AI 模型开发和部署中，**GPU 性能评测**是一个非常重要的环节。   不同 GPU、不同深度学习框架（如 PyTorch、TensorFlow、PaddlePaddle 等）在运行相同任务时，速度、吞吐量、内存占用等表现差异很大。   本次挑战赛希望通过社区的力量，**构建一个标准化、带权重的评测数据集**，让 GPU 性能比较更加科学、公正。 @@ -21,64 +21,80 @@ --- -## 📥 如何参与提交？ +## 📥 参赛流程 -### 📝初始化仓库及提交流程 +* 进入[GPUCodeForces赛事首页](https://gitee.com/ccf-ai-infra/GPUCodeForces)，登录参与本期比赛的Gitee账号，完成一份成功合并到仓库内的提交即为参赛成功！时间自由，方法自由，只要有灵感就可以动手开code~ -* 进入到赛事首页：[GPUCodeForces赛事首页](https://gitee.com/ccf-ai-infra/GPUCodeForces)，点击[Issues](https://gitee.com/ccf-ai-infra/GPUCodeForces/issues/new/choose)，选择赛题\[CP\]->立即开始： - + ### 🌰举个栗子 - -然后按照模板格式填写相关信息后提交即可。在最后一个选项“推荐其他选手完成”这里，若有团队则可框选，若是自身完成则不用框选： + * 登录or注册自己的Gitee账号后，进入赛事首页查看仓库内的文件内容。仔细阅读[how-to-contribute.md](https://gitee.com/ccf-ai-infra/GPUCodeForces/blob/main/how-to-contribute.md)，完成CLA签署，并熟悉提交流程。 - + * 看到仓库内文件，有一个example文件夹： -提交完成后，返回Issue主页可以看到自己的提交记录，可以复制Issue id进行保存： + + + 这是我们提供的一个样例，接下来我们在这个基础上进行一次完整的算子优化的提交（我们鼓励大家自己找到更好的算子并优化）。 - + * 我们将样例clone到自己电脑上， + 并关注四份文件： torchcode.py、prompt.txt、cudacode_ori.py、example_cudacode.py，最终需要提交的代码文件正是这四个。本次比赛在[模力方舟](https://ai.gitee.com/compute)平台上使用沐曦算力，需要使用算力券购买实例： -* 回到赛事主页，在仓库界面右上角选择fork至自己的仓库下： - + - + 接着便可以在云端实例上进行代码修改。相关算力券的领取方式请见[算力平台使用说明](https://ai.gitee.com/docs/compute/container)、[算力券兑换发放和兑换](https://ai.gitee.com/docs/billing/coupons)。 - + * 然后在该比赛仓库新建一个issue，填写赛题。这里我们是对example-001算子优化，因此issue的主题就可以是“对001-example数据集进行性能优化”： -然后把源项目克隆至本地，文件路径可以根据自己的喜好来： + + + 可以看到这里有一个“#ICVXKH”，这是issue id，你的算子优化、新算子都应该绑定一个独立的issue id（最终有多少份issue被审核通过，就表示提交成功了多少份）。在即将提交的时候，在该赛题仓库的S1文件夹下新建一个以该id命名（无需带#号）的文件夹，该文件夹内容为四份必要文件和其他视参赛者情况需要补充的材料（如readme文件、用到的其他数据集等）： - + -在克隆仓库或本地文件夹内都可以大展你的身手，进行算子优化了🎉！ + * 准备工作就绪，接下来看到example-001内的代码： -* 准备好了代码及各项必需文件后，在本地文件夹内启动git bash，进行初始化和远程仓库连接： - + example_torchcode.py：基准模型（Baseline）。示例提供一个简单的PyTorch模型，只包含一个ReLU激活函数。 + + * get_inputs()：生成模型运行时需要的输入数据。 + * get_init_inputs()：成模型初始化所需的参数（这里就是权重矩阵 weight）。 -```shell -git init -git remote add origin https://gitee.com/your-name/GPUCodeForces.git -git remote -v -#成功后应显示： -#origin https://gitee.com/your-name/GPUCodeForces.git (fetch) -#origin https://gitee.com/your-name/GPUCodeForces.git (push) -``` + example_cudacode.py：优化模型。示例使用PyTorch的load_inline功能直接编译和加载CUDA代码，创建了一个新的模型类，使用自定义CUDA实现替代PyTorch的ReLU。 -* 然后将本地优化好的算子仓库存入到暂存区，并进行上传： - + run_code.py：验证和性能测试脚本。验证自定义CUDA实现与原始PyTorch实现的数值精度一致性，比较两种实现的性能，计算加速比。 -```shell -git add . -git commit -m "填写本次提交记录，如'第一次提交'" -git push -u origin master -#最后一步需要根据自身的实际仓库分支来，一般为master，也可能为main或者你自定义的目录名称，可以使用 git push --upstream orgin 目录名 -``` + prompt.txt：这里给予参赛者一些提示： -* 上传成功后，回到自己的仓库主页，选择”新建Pull Request“： - + * 要求编写自定义CUDA内核来替换PyTorch算子以获得加速 + + * 可以自由选择替换哪些算子，考虑算子融合机会 + + * 提供了示例语法和内联嵌入自定义CUDA算子的方法 + + * 给出了需要优化的模型架构（简单的ReLU模型） + + * 然后我们来优化这个算子： + + example_torchcode.py：从单一的ReLU操作扩展为矩阵乘法 + ReLU的复合操作，增加可学习的权重参数(weight)，指定输入张量的预期形状和输出形状。 + + example_cudacode.py：采用部分替换策略，只将ReLU替换为CUDA实现，保留PyTorch的高度优化矩阵乘法。 + + run_code.py：增加了最大差异和平均差异计算，使用更严格的容差(1e-05)，增加了预热步骤，确保GPU状态稳定；增加迭代次数(1000次)提高测量准确性。 + + prompt.txt：展示了加法操作和ReLU操作两种不同的优化示例,强调了可以自由选择优化策略，包括算子融合等高级技术。 + + * 优化好后，可以在模力方舟的实例上运行: + + ```sh + python run_code.py + ``` + 确保能够正确输出结果后再准备提交。 + + * 接下来将优化好的代码保存到本地，然后参照[how-to-contribute.md](https://gitee.com/ccf-ai-infra/GPUCodeForces/blob/main/how-to-contribute.md)的指引进行代码仓库的提交与合并。 - -然后在上传界面选择自己更新项目的分支，选择合并即可： + * 最终，成功提交的代码会合并到 S1/#your_issue id 下，并且你的相关pr也会关闭。就像下面这样： + + + 🌳一份完整的提交流程如上，期待各位自由发挥，赛出风采与水平！ - ### 📦 提交PR内容 @@ -114,7 +130,7 @@ git push -u origin master ``` -### 💻审核流程 +### ⭐审核流程 * 在一切文件都准备好并且提交后，在对应的PR下会得到回复： diff --git a/how-to-contribute.md b/how-to-contribute.md index c209a59..49fb1bc 100644 --- a/how-to-contribute.md +++ b/how-to-contribute.md @@ -11,24 +11,39 @@ - **目的**：将原始仓库复制到您的Gitee（或github）账户下，以便您可以进行修改。 - **步骤**： - 在Gitee（或github）上找到[GPUCodeForces](https://gitee.com/ccf-ai-infra/GPUCodeForces)。 - - 点击页面右上角的“Fork”按钮，将该仓库复制到您的Gitee账户下。 + - 点击页面右上角的“Fork”按钮，将该仓库复制到您的Gitee账户下： + ## 2. Clone项目仓库 - **目的**：将您Fork的项目仓库克隆到本地，以便在本地进行修改。 - **步骤**： - 在您的本地机器上，使用`git clone`命令将项目仓库Fork的仓库克隆到本地。 + ```sh git clone https://gitee.com/giteeuseid/GPUCodeForces.git ``` 备注：`giteeuseid替换您的url`。 -## 3. 创建新分支进行开发 -- **目的**：在新的分支上进行修改，避免直接修改主分支。 +## 3. 创建赛题与分支 +- **目的**：在Gitee上建立一个属于自己赛题的issue便于后期跟进。在自己克隆好的仓库的分支上进行修改，避免直接修改主分支。 - **步骤**： - - 进入克隆的仓库目录。 + - 进入到赛事首页：[GPUCodeForces赛事首页](https://gitee.com/ccf-ai-infra/GPUCodeForces)，点击[Issues](https://gitee.com/ccf-ai-infra/GPUCodeForces/issues/new/choose)，选择赛题\[CP\]->立即开始： + + 然后按照模板格式填写相关信息后提交即可。在最后一个选项“推荐其他选手完成”这里，若有团队则可框选，若是自身完成则不用框选： + + 提交完成后，返回Issue主页可以看到自己的提交记录，可以复制Issue id进行保存： + + + - 在本地电脑进入克隆的仓库目录，并进行初始化。 ```sh cd GPUKernelContest + git init + git remote add origin https://gitee.com/your-name/GPUCodeForces.git + git remote -v + #成功后应显示： + #origin https://gitee.com/your-name/GPUCodeForces.git (fetch) + #origin https://gitee.com/your-name/GPUCodeForces.git (push) ``` - 创建一个新的分支来（例如：`dev`分支）进行您的项目创作或者修订。 ```sh @@ -43,9 +58,10 @@ ```sh git add . git commit -m "描述您的修改，如需要关联PR，通过fixes, closes, resolved等关键字关闭" + #例如：git commit -m "fixes #your-issue_id"即表示关联到你自己创建的赛题id下 ``` 备注： -* Fixes #45 → 关闭Issue #45 +* Fixes #45 → 关联Issue #45 * Resolves jquery/jquery#45 → 跨仓库关闭Issue * Closes #45, #46 → 批量关闭多个Issue @@ -56,34 +72,42 @@ - 将您的修改推送到您Fork的仓库。 ```sh git push origin dev + #这里填写你创建的目录名，不一定为dev ``` ## 6. 创建Pull Request - **目的**：向原始仓库的维护者提交您的修改，请求合并。 - **步骤**： - 回到您的Gitee账户（或github），找到您Fork的仓库。 - - 点击“New Pull Request”按钮。 - - 选择您推送的分支和原始仓库的主分支进行比较。 - - 填写PR的标题和描述，说明您的修改内容和目的。 - - 点击“Create Pull Request”按钮，提交PR。 + - 点击“New Pull Request”按钮： + + - 选择您推送的分支和原始仓库的主分支进行比较： + + - 填写PR的标题和描述，说明您的修改内容和目的： + + - 点击下方“创建 Pull Request”按钮，提交PR即可。 ## 7. 处理反馈 - **目的**：根据项目维护者的反馈进行必要的修改。 - **步骤**： - - 项目维护团队或者维护者会审查您的PR，并可能提出修改意见或问题。 + - 项目维护团队或者维护者会审查您的PR，并可能提出修改意见或问题，在与您相关的issue和pull request下方评论区即可查看： + - 根据反馈进行必要的修改，并重复步骤4到步骤6，直到PR被接受。 ## 8. PR被合并 - **目的**：一旦您的PR被接受并合并到主分支，您的贡献就正式成为项目的一部分。 - **步骤**： - - 项目维护者会合并您的PR。 + - 项目维护者会合并您的PR，您可以在这里查看各项pr的状态： + - 您的修改现在成为原始仓库的一部分。 ## 9. 同步上游仓库 - **目的**：保持您的Fork仓库与上游仓库同步。 - **步骤**： - - 为了保持您的Fork仓库与上游仓库同步，您需要定期从上游仓库拉取更新。 + - 为了保持您的Fork仓库与上游仓库同步，您需要定期从上游仓库拉取更新： + - 登录自己的Gitee账户（或github），找到您Fork的仓库。 - - 点击`Sync fork`按钮同步最新的上游Fork的仓库。 + - 点击`Sync fork`按钮同步最新的上游Fork的仓库： + 通过以上步骤，您就可以在Gitee（或github）上有效地参与项目的协作。希望这些信息对您有所帮助！如果有任何问题，随时欢迎提问。 \ No newline at end of file diff --git a/images/ht_fork_choose.png b/images/ht_fork_choose.png new file mode 100644 index 0000000..720b275 Binary files /dev/null and b/images/ht_fork_choose.png differ diff --git a/images/ht_fork_sync.png b/images/ht_fork_sync.png new file mode 100644 index 0000000..fa64663 Binary files /dev/null and b/images/ht_fork_sync.png differ diff --git a/images/ht_pr_status.png b/images/ht_pr_status.png new file mode 100644 index 0000000..966b859 Binary files /dev/null and b/images/ht_pr_status.png differ diff --git a/images/ht_pr_write.png b/images/ht_pr_write.png new file mode 100644 index 0000000..9c0bff7 Binary files /dev/null and b/images/ht_pr_write.png differ diff --git a/images/readme_drun_create.png b/images/readme_drun_create.png new file mode 100644 index 0000000..fbe0877 Binary files /dev/null and b/images/readme_drun_create.png differ diff --git a/images/readme_git_compute.png b/images/readme_git_compute.png new file mode 100644 index 0000000..bfa211b Binary files /dev/null and b/images/readme_git_compute.png differ diff --git a/images/readme_sample_check.png b/images/readme_sample_check.png new file mode 100644 index 0000000..7102ef4 Binary files /dev/null and b/images/readme_sample_check.png differ diff --git a/images/readme_sample_folder.png b/images/readme_sample_folder.png new file mode 100644 index 0000000..1081852 Binary files /dev/null and b/images/readme_sample_folder.png differ diff --git a/images/readme_sample_issue.png b/images/readme_sample_issue.png new file mode 100644 index 0000000..d7e1aaa Binary files /dev/null and b/images/readme_sample_issue.png differ diff --git a/images/readme_sample_merge.png b/images/readme_sample_merge.png new file mode 100644 index 0000000..19dc632 Binary files /dev/null and b/images/readme_sample_merge.png differ