Skip to content

Commit 630ce7a

Browse files
committed
Updates benchmark scripts and adds contribution section
Renames benchmark script filenames to remove "benchmark_" prefix for cleaner naming. Updates performance comparison description to reference SDPA instead of Flash Attention for accuracy. Removes outdated MQAR benchmark section that is no longer relevant. Adds comprehensive contribution guidelines including bug reporting, feature requests, code contributions, and community standards to encourage open source participation.
1 parent 1996169 commit 630ce7a

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

README_zh.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -185,28 +185,22 @@ Flash-DMA 提供全面的基准测试工具,用于评估不同配置下的性
185185

186186
### 前向传播等效性
187187
```bash
188-
python benchmarks/benchmark_forward_equivalence.py
188+
python benchmarks/forward_equivalence.py
189189
```
190190
验证 Python 参考实现与 CUDA 实现之间的数值一致性。
191191

192192
### 性能基准测试
193193
```bash
194-
python benchmarks/benchmark_forward_performance.py
194+
python benchmarks/forward_performance.py
195195
```
196-
在各种序列长度和批大小下比较 Flash-DMA 与标准 Flash Attention
196+
在各种序列长度和批大小下比较 Flash-DMA 与标准 SDPA
197197

198198
### 梯度计算
199199
```bash
200-
python benchmarks/benchmark_grad.py
200+
python benchmarks/grad_equivalence.py
201201
```
202202
测试反向传播实现和梯度等效性。
203203

204-
### 多查询联想回忆
205-
```bash
206-
python benchmarks/benchmark_mqar.py
207-
```
208-
评估长程推理任务的性能。
209-
210204

211205
## 故障排除
212206

@@ -254,6 +248,31 @@ print_memory_stats()
254248
torch.cuda.empty_cache()
255249
```
256250

251+
252+
## 贡献
253+
254+
我们欢迎社区的贡献!Flash-DMA 是一个开源项目,我们重视所有类型的贡献。
255+
256+
### 如何贡献
257+
258+
- **报告错误**: 发现了错误?请[提交 issue](https://github.com/SmallDoges/flash-dmattn/issues/new/choose)
259+
- **功能请求**: 有改进想法?[告诉我们](https://github.com/SmallDoges/flash-dmattn/issues/new/choose)
260+
- **提交代码**: 准备贡献代码?查看我们的[贡献指南](CONTRIBUTING.md)
261+
- **改进文档**: 帮助我们完善文档
262+
263+
### 贡献者快速入门
264+
265+
1. Fork 仓库
266+
2. 创建功能分支: `git checkout -b feature-name`
267+
3. 进行修改并测试
268+
4. 提交 Pull Request
269+
270+
详细说明请参见我们的[贡献指南](CONTRIBUTING.md)
271+
272+
### 行为准则
273+
274+
本项目遵循[贡献者公约行为准则](CODE_OF_CONDUCT.md)。参与时,您需要遵守此准则。
275+
257276
## 许可证
258277

259278
本项目采用 BSD 3-Clause 许可证。详情请参见 [LICENSE](LICENSE)

0 commit comments

Comments
 (0)