docs(config): 配置模块解析

1. 命令行参数设置 2. YAML文件解析 3. 数据集路径解析
object-detection-algorithm · May 14, 2020 · 17d0e7f · 17d0e7f
1 parent b873fe1
commit 17d0e7f
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 80 deletions.
diff --git a/docs/config.md b/docs/config.md
diff --git a/docs/config/arg_parse.md b/docs/config/arg_parse.md
@@ -0,0 +1,9 @@
+
+# 命令行参数解析
+
+参考：[python Argparse模块的使用](https://blog.csdn.net/u012005313/article/details/50111455)
+
+## 相关文件
+
+* `py/train.py`
+* `py/demo.py`
diff --git a/docs/config/dataset_path.md b/docs/config/dataset_path.md
@@ -0,0 +1,13 @@
+
+# 数据集路径解析
+
+定义了数据集路径解析类`DatasetCatalog`
+
+默认保存路径为当前路径下的`datasets`文件夹，可设置环境变量进行调整
+
+* 对于`voc`数据集，设置环境变量`VOC_ROOT`
+* 对于`coco`数据集，设置环境变量`COCO_ROOT`
+
+## 相关文件
+
+* `py/ssd/config/path_catalog.py`
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -0,0 +1,8 @@
+
+# 配置模块
+
+配置模块分为`3`个部分，分别是：
+
+1. [命令行参数设置](./arg_parse.md)
+2. [`YAML`配置](./yaml.md)
+3. [数据集路径解析](./dataset_path.md)
diff --git a/docs/config/yaml.md b/docs/config/yaml.md
@@ -0,0 +1,8 @@
+
+# YAML配置
+
+工程所有变量的配置均通过`YAML`格式进行配置，其读取和设置参考[[yacs][pytohn]YAML文件读取](https://zj-image-processing.readthedocs.io/zh_CN/latest/python/[yacs][pytohn]YAML%E6%96%87%E4%BB%B6%E8%AF%BB%E5%8F%96/)
+
+## 相关文件
+
+* `py/ssd/config/default.py`
diff --git a/docs/index.md b/docs/index.md
@@ -4,9 +4,12 @@
 
 ## 训练框架
 
-整个训练框架可分为以下几个部分：
+整个目标检测训练框架可分为以下几个部分：
 
-1. 配置
+1. 配置模块
+      1. 命令行参数设置
+      2. YAML文件读写
+      3. 数据集路径解析
 2. 日志
       1. 文本日志
       2. 可视化日志

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,25 +30,31 @@ extra_javascript:
 # 导航
 nav:
     - Home: index.md
-    - Config: config.md
-    - Data:
-        - 引言: data/index.md
-        - Transforms:
-            - 引言: data/transforms/index.md
-            - 格式转换: data/transforms/格式转换.md
-            - 光度扭曲: data/transforms/光度扭曲.md
-            - 图像扩展: data/transforms/图像扩展.md
-            - 随机裁剪: data/transforms/随机裁剪.md
-            - 随机镜像: data/transforms/随机镜像.md
-            - 图像缩放: 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
-        - 梯度更新: optim/梯度更新.md
-        - 学习率调度: optim/学习率调度.md
+    - 训练框架:
+        - 配置模块:
+            - 引言: config/index.md
+            - 命令行参数: config/arg_parse.md
+            - YAML配置: config/yaml.md
+            - 数据集路径解析: config/dataset_path.cmd
+    - SSD算法:
+        - Data:
+            - 引言: data/index.md
+            - Transforms:
+                - 引言: data/transforms/index.md
+                - 格式转换: data/transforms/格式转换.md
+                - 光度扭曲: data/transforms/光度扭曲.md
+                - 图像扩展: data/transforms/图像扩展.md
+                - 随机裁剪: data/transforms/随机裁剪.md
+                - 随机镜像: data/transforms/随机镜像.md
+                - 图像缩放: 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
+            - 梯度更新: optim/梯度更新.md
+            - 学习率调度: optim/学习率调度.md
diff --git a/py/ssd/config/path_catlog.py → py/ssd/config/path_catalog.py b/py/ssd/config/path_catlog.py → py/ssd/config/path_catalog.py