docs(docs): 工程概述

deep-learning-algorithm · Apr 13, 2020 · a0801e4 · a0801e4
1 parent bba1d8b
commit a0801e4
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/工程概述.md b/docs/工程概述.md
@@ -0,0 +1,20 @@
+
+# 工程概述
+
+根目录结构如下
+
+```
+.
+├── docs
+├── LICENSE
+├── mkdocs.yml
+├── py
+├── README.md
+└── requirements.txt
+```
+
+其中
+
+* `CNN`模型实现位于`py/models`
+* 训练数据位于`py/data`，其解析代码位于`py/utils/data`
+* 模型训练代码位于`py/classifier*`
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,6 +30,7 @@ extra_javascript:
 # 导航
 nav:
     - Home: index.md
+    - 工程概述: './工程概述.md'
     - 训练日志:
         - 'GoogLeNet': './log-googlenet.md'
         - 'AlexNet vs. GoogLeNet': './log-alexnet-vs-googlenet.md'