docs(optim): 优化器使用

docs/index.md

@@ -6,5 +6,10 @@
 
 1. 配置
 2. 日志
+      1. 文本日志
+      2. 可视化日志
 3. 数据
-4. 检查点
+4. 检查点
+5. 优化器
+      1. 梯度更新
+      2. 学习率调度

docs/optim/index.md

@@ -0,0 +1,25 @@
+
+# 优化器
+
+优化其分为`2`个部分：
+
+1. 梯度更新
+2. 学习率调度
+
+
+其涉及到配置参数有
+
+```
+_C.SOLVER = CN()
+# 梯度更新
+_C.SOLVER.BATCH_SIZE = 32
+_C.SOLVER.LR = 1e-3
+_C.SOLVER.MOMENTUM = 0.9
+# 学习率调度
+_C.SOLVER.MAX_ITER = 120000
+_C.SOLVER.LR_STEPS = [80000, 100000]
+_C.SOLVER.GAMMA = 0.1
+_C.SOLVER.WEIGHT_DECAY = 5e-4
+_C.SOLVER.WARMUP_FACTOR = 1.0 / 3
+_C.SOLVER.WARMUP_ITERS = 500
+```

docs/optim/学习率调度.md

@@ -0,0 +1,17 @@
+
+# 学习率调度
+
+* 定义：`py/ssd/optim/__init__.py`
+* 声明：`py/train.py`
+* 使用：`py/ssd/enine/trainer.py`
+
+定义了一个辅助函数`make_lr_scheduler`来生成优化器
+
+```
+def make_lr_scheduler(cfg, optimizer, milestones=None):
+    return WarmupMultiStepLR(optimizer=optimizer,
+                             milestones=cfg.SOLVER.LR_STEPS if milestones is None else milestones,
+                             gamma=cfg.SOLVER.GAMMA,
+                             warmup_factor=cfg.SOLVER.WARMUP_FACTOR,
+                             warmup_iters=cfg.SOLVER.WARMUP_ITERS)
+```

docs/optim/梯度更新.md

@@ -0,0 +1,15 @@
+
+# 梯度更新
+
+* 定义：`py/ssd/optim/__init__.py`
+* 声明：`py/train.py`
+* 使用：`py/ssd/enine/trainer.py`
+
+定义了一个辅助函数`make_optimizer`来生成优化器
+
+```
+def make_optimizer(cfg, model, lr=None):
+    lr = cfg.SOLVER.BASE_LR if lr is None else lr
+    return torch.optim.SGD(model.parameters(), lr=lr, momentum=cfg.SOLVER.MOMENTUM,
+                           weight_decay=cfg.SOLVER.WEIGHT_DECAY)
+```

mkdocs.yml

@@ -47,4 +47,8 @@ nav:
         - 引言: log/index.md
         - 文本日志: log/文本日志.md
         - 可视化日志: log/可视化日志.md
-    - CheckPoint: checkpointer.md
+    - CheckPoint: checkpointer.md
+    - Optim:
+        - 引言: optim/index.md
+        - 梯度更新: optim/梯度更新.md
+        - 学习率调度: optim/学习率调度.md