Skip to content

Commit 516075b

Browse files
committed
docs: add InfiniMetrics Dashboard user guide with images
1 parent 6872a5c commit 516075b

File tree

7 files changed

+14
-11
lines changed

7 files changed

+14
-11
lines changed

docs/dashboard.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ service
3737
to perform fuzzy matching on Run IDs
3838

3939
Example screenshot:
40-
![Run_ID research](https://private-user-images.githubusercontent.com/94775646/561443423-ac18e86d-b6e3-4ae5-a386-15d9cf34bf69.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0MjMtYWMxOGU4NmQtYjZlMy00YWU1LWEzODYtMTVkOWNmMzRiZjY5LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWI3NDFjM2QzZThjMGY3MjM3ZTJkY2IxMDY4ZDc2ZWYxZmYzOGQzZDAyYjQyZDE4NGZmZmEwZDRjOTQzN2IzOGUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.pOFgY_W8dwv-cMMSBP4yee_2l0we_iCL4jptlMLIsnk)
40+
![Run_ID research](./images/runid_research.jpg)
4141
## 2. Running the Dashboard
4242
### 2.1 Environment Requirements
4343

@@ -83,7 +83,8 @@ GPU memory usage
8383
Communication configuration analysis
8484
```
8585
Example screenshot:
86-
![Communication Test](https://private-user-images.githubusercontent.com/94775646/561443439-b3e3f409-6bb9-4c32-bee8-9928781fcd39.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0MzktYjNlM2Y0MDktNmJiOS00YzMyLWJlZTgtOTkyODc4MWZjZDM5LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTM1MGU2YTcxNjcxNWM4ZWIwYWJiZTVkNmU2NTIxNWNkZDI3NGRiNTNmNWI0YWY4NWUxZmI0MzBjZjc4OGVkZjgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.AaFHdRt4SGyldFCZR1hNBhySRoR2cGDHQ0aAVNG4dq8)
86+
![Communication Test](./images/dashboard_communication.jpg)
87+
8788
## 4. Inference Test Analysis
8889

8990
Path:
@@ -108,7 +109,8 @@ GPU memory usage
108109
Inference configuration analysis
109110
```
110111
Example screenshot:
111-
![Inference Test](https://private-user-images.githubusercontent.com/94775646/561443450-9b57045c-d320-4da6-9b23-6e0f9a6c96cb.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0NTAtOWI1NzA0NWMtZDMyMC00ZGE2LTliMjMtNmUwZjlhNmM5NmNiLmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTcxYTVjOWY2MzE4NjNjYjJlNGI3ZjkzMDk4MzJmZWNkY2ZiZWI2ZjRiZjcyZjVkZTAzNGE0YzljYjVhZmJhZDUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0._LAZMfKkStSoWgw-1t22fOdlbkng-xZnV9rHIpd4v-M)
112+
![Inference Test](./images/dashboard_inference.jpg)
113+
112114
## 5. Training Test Analysis
113115

114116
Path:
@@ -128,7 +130,8 @@ GPU memory usage
128130
Training configuration analysis
129131
```
130132
Example screenshot:
131-
![Training Test](https://private-user-images.githubusercontent.com/94775646/561443390-5a789775-9fd4-4146-932d-df2436c20977.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDMzOTAtNWE3ODk3NzUtOWZkNC00MTQ2LTkzMmQtZGYyNDM2YzIwOTc3LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTc4ZjFkZGFjYWE1ZWM0ZDRjOWQ3M2QxYzM4YzRjNzUyZmMzZGIwMTQwNjBjMDU4N2QyMmUyOTRlYzU3MWRkN2UmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.3YfafricSVbHzguSeDhhKiQ0S68AQDY48a1HRpMHTj4)
133+
![Training Test](./images/dashboard_training.jpg)
134+
132135
## 6. Operator Test Analysis
133136

134137
Path:
@@ -144,4 +147,4 @@ flops
144147
bandwidth
145148
```
146149
Example screenshot:
147-
![Operator Test](https://private-user-images.githubusercontent.com/94775646/561443431-58d7f944-8e6b-4f2a-8fdc-671d09653da8.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0MzEtNThkN2Y5NDQtOGU2Yi00ZjJhLThmZGMtNjcxZDA5NjUzZGE4LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTBjNzNhNGI5YjhlMDc3MjNiMzU3ODQ5YTNjMDBjYTcyN2E1NjIxNjAyNGU3ZDM5ODMwMGVlZTMyMWY0OGE3ZTcmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.OpDxdAaEsdHYX_jOWNmmdPB-jKp92gbLh1VFs0H2j6c)
150+
![Operator Test](./images/dashboard_operators.jpg)
231 KB
Loading
117 KB
Loading
164 KB
Loading

docs/images/dashboard_training.jpg

147 KB
Loading

docs/images/runid_research.jpg

124 KB
Loading

docs/zh/dashboard.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ service
3434
对 Run ID 进行模糊匹配搜索
3535

3636
示例截图:
37-
![run_id搜索](https://private-user-images.githubusercontent.com/94775646/561443423-ac18e86d-b6e3-4ae5-a386-15d9cf34bf69.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0MjMtYWMxOGU4NmQtYjZlMy00YWU1LWEzODYtMTVkOWNmMzRiZjY5LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWI3NDFjM2QzZThjMGY3MjM3ZTJkY2IxMDY4ZDc2ZWYxZmYzOGQzZDAyYjQyZDE4NGZmZmEwZDRjOTQzN2IzOGUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.pOFgY_W8dwv-cMMSBP4yee_2l0we_iCL4jptlMLIsnk)
37+
38+
![Run ID搜索](../images/runid_research.jpg)
3839
## 2. 运行 Dashboard
3940
### 2.1 环境依赖
4041
使用 Dashboard 前需要安装以下依赖:
@@ -81,7 +82,7 @@ Dashboard → 通信性能测试
8182

8283
示例截图:
8384

84-
![通信测试](https://private-user-images.githubusercontent.com/94775646/561443439-b3e3f409-6bb9-4c32-bee8-9928781fcd39.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0MzktYjNlM2Y0MDktNmJiOS00YzMyLWJlZTgtOTkyODc4MWZjZDM5LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTM1MGU2YTcxNjcxNWM4ZWIwYWJiZTVkNmU2NTIxNWNkZDI3NGRiNTNmNWI0YWY4NWUxZmI0MzBjZjc4OGVkZjgmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.AaFHdRt4SGyldFCZR1hNBhySRoR2cGDHQ0aAVNG4dq8)
85+
![通信测试](../images/dashboard_communication.jpg)
8586
## 4. 推理测试分析
8687

8788
路径:
@@ -109,7 +110,7 @@ Throughput
109110
```
110111
示例截图:
111112

112-
![推理测试](https://private-user-images.githubusercontent.com/94775646/561443450-9b57045c-d320-4da6-9b23-6e0f9a6c96cb.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0NTAtOWI1NzA0NWMtZDMyMC00ZGE2LTliMjMtNmUwZjlhNmM5NmNiLmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTcxYTVjOWY2MzE4NjNjYjJlNGI3ZjkzMDk4MzJmZWNkY2ZiZWI2ZjRiZjcyZjVkZTAzNGE0YzljYjVhZmJhZDUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0._LAZMfKkStSoWgw-1t22fOdlbkng-xZnV9rHIpd4v-M)
113+
![推理测试](../images/dashboard_inference.jpg)
113114

114115
## 5. 训练测试分析
115116
路径:
@@ -132,7 +133,7 @@ Throughput 曲线
132133
```
133134
示例截图:
134135

135-
![训练测试](https://private-user-images.githubusercontent.com/94775646/561443390-5a789775-9fd4-4146-932d-df2436c20977.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDMzOTAtNWE3ODk3NzUtOWZkNC00MTQ2LTkzMmQtZGYyNDM2YzIwOTc3LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTc4ZjFkZGFjYWE1ZWM0ZDRjOWQ3M2QxYzM4YzRjNzUyZmMzZGIwMTQwNjBjMDU4N2QyMmUyOTRlYzU3MWRkN2UmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.3YfafricSVbHzguSeDhhKiQ0S68AQDY48a1HRpMHTj4)
136+
![训练测试](../images/dashboard_training.jpg)
136137

137138
## 6. 算子测试分析
138139

@@ -153,5 +154,4 @@ bandwidth
153154

154155
示例截图:
155156

156-
![算子测试](https://private-user-images.githubusercontent.com/94775646/561443431-58d7f944-8e6b-4f2a-8fdc-671d09653da8.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzMyMTc3MTAsIm5iZiI6MTc3MzIxNzQxMCwicGF0aCI6Ii85NDc3NTY0Ni81NjE0NDM0MzEtNThkN2Y5NDQtOGU2Yi00ZjJhLThmZGMtNjcxZDA5NjUzZGE4LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzExVDA4MjMzMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTBjNzNhNGI5YjhlMDc3MjNiMzU3ODQ5YTNjMDBjYTcyN2E1NjIxNjAyNGU3ZDM5ODMwMGVlZTMyMWY0OGE3ZTcmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.OpDxdAaEsdHYX_jOWNmmdPB-jKp92gbLh1VFs0H2j6c)
157-
157+
![算子测试](../images/dashboard_operators.jpg)

0 commit comments

Comments
 (0)