Skip to content

Commit

Permalink
[Docs] Replace markdown table with html table (#800)
Browse files Browse the repository at this point in the history
  • Loading branch information
HAOCHENYE committed Dec 7, 2022
1 parent c22e900 commit 491d71c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 12 deletions.
35 changes: 29 additions & 6 deletions docs/en/advanced_tutorials/logging.md
Expand Up @@ -103,12 +103,35 @@ runner.train()

Currently, MMEngine supports the following statistical methods:

| statistic method | arguments | function |
| :--------------- | :---------- | :------------------------------------------------------------- |
| mean | window_size | statistic the average log of the last `window_size` iterations |
| min | window_size | statistic the minimum log of the last `window_size` iterations |
| max | window_size | statistic the maximum log of the last `window_size` iterations |
| current | / | statistic the latest log |
<table class="docutils">
<thead>
<tr>
<th>statistic method</th>
<th>arguments</th>
<th>function</th>
</tr>
<tr>
<td>mean</td>
<td>window_size</td>
<td>statistic the average log of the last `window_size`</td>
</tr>
<tr>
<td>min</td>
<td>window_size</td>
<td>statistic the minimum log of the last `window_size`</td>
</tr>
<tr>
<td>max</td>
<td>window_size</td>
<td>statistic the maximum log of the last `window_size`</td>
</tr>
<tr>
<td>current</td>
<td>/</td>
<td>statistic the latest</td>
</tr>
</thead>
</table>

`window_size` mentioned above could be:

Expand Down
35 changes: 29 additions & 6 deletions docs/zh_cn/advanced_tutorials/logging.md
Expand Up @@ -97,12 +97,35 @@ log_processor 默认输出 `by_epoch=True` 格式的日志。日志格式需要

其中 `data_src` 为原日志名,`mean` 为统计方法,`global` 为统计方法的参数。这样的话,日志中统计的 `loss1` 就是全局均值。我们可以在日志处理器中配置以下统计方法:

| 统计方法 | 参数 | 功能 |
| :------- | :---------- | :--------------------- |
| mean | window_size | 统计窗口内日志的均值 |
| min | window_size | 统计窗口内日志的最小值 |
| max | window_size | 统计窗口内日志的最大值 |
| current | / | 返回最近一次更新的日志 |
<table class="docutils">
<thead>
<tr>
<th>统计方法</th>
<th>参数</th>
<th>功能</th>
</tr>
<tr>
<td>mean</td>
<td>window_size</td>
<td>统计窗口内日志的均值</td>
</tr>
<tr>
<td>min</td>
<td>window_size</td>
<td>统计窗口内日志的最小值</td>
</tr>
<tr>
<td>max</td>
<td>window_size</td>
<td>统计窗口内日志的最大值</td>
</tr>
<tr>
<td>current</td>
<td>/</td>
<td>返回最近一次更新的日志</td>
</tr>
</thead>
</table>

其中 `window_size` 的值可以是:

Expand Down

0 comments on commit 491d71c

Please sign in to comment.