docs(log): 更新日志模块

1. 文本日志 2. 可视化日志
object-detection-algorithm · May 14, 2020 · ffaa677 · ffaa677
1 parent 17d0e7f
commit ffaa677
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 22 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -10,7 +10,7 @@
       1. 命令行参数设置
       2. YAML文件读写
       3. 数据集路径解析
-2. 日志
+2. 日志模块
       1. 文本日志
       2. 可视化日志
 3. 数据

diff --git a/docs/log/index.md b/docs/log/index.md
@@ -3,5 +3,5 @@
 
 日志操作可分为`2`个部分：
 
-* 文本日志
-* 可视化日志
+* [文本日志](./text_log.md)
+* [可视化日志](./visualization_log.md)
diff --git a/docs/log/文本日志.md → docs/log/text_log.md b/docs/log/文本日志.md → docs/log/text_log.md
@@ -7,8 +7,8 @@
 
 [python logging - 高级](https://blog.csdn.net/u012005313/article/details/51588317)
 
-* `py/ssd/utils/logger.py`
+在`logger.py`的函数`setup_logger`中定义了一个日志记录器，同时打印日志到**命令行窗口**和**文本文件**。同时在训练过程中可以新建`logging`对象，打印训练/测试过程
 
-在`logger.py`的函数`setup_logger`中定义了一个日志记录器，同时打印日志到窗口和文件
+## 相关文件
 
-同时在训练过程中新建`logging`对象，打印训练/测试过程
+* `py/ssd/utils/logger.py`
diff --git a/docs/log/visualization_log.md b/docs/log/visualization_log.md
@@ -0,0 +1,17 @@
+
+# 可视化日志
+
+参考：
+
+[[PyTorch]Tensorboard可视化实现](https://blog.zhujian.life/posts/eb6f2b71.html)
+
+[[PyTorch]Tensorboard使用实践](https://blog.zhujian.life/posts/f793688d.html)
+
+使用`TensorboardX`进行训练过程可视化，记录了训练过程中**损失值**和**学习率**的变化，并且记录每个阶段的**测试结果（AP）**
+
+新建了一个`MetricLogger`类，用于平滑损失值
+
+## 相关文件
+
+* `py/ssd/engine/trainer.py`
+* `py/ssd/utils/metric_logger.py`
diff --git a/docs/log/可视化日志.md b/docs/log/可视化日志.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,6 +36,10 @@ nav:
             - 命令行参数: config/arg_parse.md
             - YAML配置: config/yaml.md
             - 数据集路径解析: config/dataset_path.cmd
+        - 日志模块:
+            - 引言: log/index.md
+            - 文本日志: log/text_log.md
+            - 可视化日志: log/visualization_log.md
     - SSD算法:
         - Data:
             - 引言: data/index.md
@@ -49,10 +53,7 @@ nav:
                 - 图像缩放: data/transforms/图像缩放.md
                 - 数据标准化: data/transforms/数据标准化.md
                 - Compose: data/transforms/Compose.md
-        - Log:
-            - 引言: log/index.md
-            - 文本日志: log/文本日志.md
-            - 可视化日志: log/可视化日志.md
+
         - CheckPoint: checkpointer.md
         - Optim:
             - 引言: optim/index.md