Skip to content

Commit

Permalink
optimize standard case readme (#51)
Browse files Browse the repository at this point in the history
add kunlun to Co-construction list
update readme-template
---------

Co-authored-by: UP <UP@.wwlwenli@163.com>
  • Loading branch information
upvenly and UP authored Apr 10, 2023
1 parent 1810975 commit d6399bd
Show file tree
Hide file tree
Showing 3 changed files with 165 additions and 102 deletions.
56 changes: 0 additions & 56 deletions docs/dev/readme-templates/case-readme-template.md

This file was deleted.

37 changes: 37 additions & 0 deletions docs/dev/readme-templates/standard(nv)-case-readme-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# case README文件模版

> 文档信息说明:
> - 文档位置:每个Case的REAMDE文档位于training/benchmarks/&lt;model&gt;/&lt;Framework&gt; 目录下
> - 文档使用的语言:默认为中文README.md,可提供英文版本README.en.md
> - 文档内容:运行环境(软件)、数据集和模型文件路径、进一步处理/转换方式(如有)、运行信息参考

## 1. 软件环境信息

- 训练框架版本:例如pytorch-1.12

- 依赖软件版本:例如torchvision等(重要依赖包)


## 2. 模型信息与数据集、模型Checkpoint下载
- 数据集下载链接:
- 数据集预处理

*// 这里提供数据集预处理方法说明,具体到可执行命令*


- 模型Checkpoint下载链接:
- 模型文件格式转换*(如非通用,而是和框架相关,则放到具体Case的README里说明)*

*// 这里提供模型文件格式转换的方法说明,具体到可执行命令*



## 3. NV运行情况
- *//暂时不考虑资源占用情况等指标,后续monitor优化后再添加*

| 训练资源 | 配置文件 | 运行时长(大约) | 精度 | Steps数 | 性能(samples/秒) |
| -------- | -------- | ---------------- | ---- | ------- | ------------------ |
| 单机单卡 | | | | | |
| 单机8卡 | | | | | |
| 两机16卡 | | | | | |
Loading

0 comments on commit d6399bd

Please sign in to comment.