VisionGuide/mkdocs.yml at master · ZJDoc/VisionGuide · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# 站点名称
site_name: 'VisionGuide'
# 仓库链接
repo_url: https://github.com/ZJDoc/VisionGuide
# 作者
site_author: 'zhujian'
# 版权信息
copyright: '2021, zhujian'
# 源文件目录
docs_dir: 'docs'
# 生成静态文件目录
site_dir: 'site'
# 额外信息
extra:
    # 版本号
    version: 0.1.0
# 主题
theme:
    # name: 'readthedocs'
    # name: 'mkdocs'
    name: 'material'
# markdown扩展
markdown_extensions:
  # 参考[MathJax](https://squidfunk.github.io/mkdocs-material/reference/mathjax/)，支持数学公式渲染
  - pymdownx.arithmatex:
      generic: true
    # 参考[Icons + Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/)，执行Markdown Emoji
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

# mathjax
extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# 导航
nav:
    - Home: index.md
    - 编程语言:
      - PYTHON:
        - 语法:
          - 类操作: python/grammar/类操作.md
          - 装饰器: python/grammar/装饰器.md
          - '[抽象基类]abc': python/grammar/abc.md
          - 模块和包: python/grammar/模块和包.md
          - '[py3.6][f-strings]字符串连接': python/grammar/f-strings.md
          - '[around]四舍五入': python/grammar/around.md
          - '[slice]扩展切片': python/grammar/slice.md
          - '[list]排序': python/grammar/list.md
          - '[enumerate]遍历': python/grammar/enumerate.md
          - '[itertools][product]嵌套循环': python/grammar/itertools-product.md
          - '[easydict]访问属性的方式来访问字典': python/grammar/easydict.md
          - '[collections][deque]双向队列': python/grammar/collections-deque.md
          - '[collections][defaultdict]更安全的dict': python/grammar/collections-defaultdict.md
          - '[pprint]更易读的打印': python/grammar/pprint.md
          - '[logging]日志模块': python/grammar/logging.md
          - '[tqdm]进度条': python/grammar/tqdm.md
          - '[ElementTree]读取XML文件': python/grammar/xml.md
          - '[xmltodict]读取XML文件': python/grammar/xmltodict.md
          - '[json]文件读写': python/grammar/json.md
          - '[yaml]文件读写': python/grammar/yacs.md
          - 'Monkey Patch': python/grammar/monkey-patch.md
        - 工具:
          - 打包和分发Python程序: ./python/tool/打包和分发Python程序.md
          - '[setup.py]保存额外数据': python/tool/setup.md
          - '[requirements.txt]依赖文件生成和使用': python/tool/requirements.md
          - '[pytest]功能测试': python/tool/pytest.md
          - '[coverage]测试代码覆盖率': python/tool/converage.md
          - '[fire]自动生成命令行界面': python/tool/fire.md
          - '[pip]更新国内镜像源': python/tool/pip.md
          - '[pnno]转换json/dict数据为voc-xml': python/tool/pnno.md
        - 问题解答: python/troubleshooting.md
      - C++11:
        - '学习C++之路': './cplusplus/学习C++之路.md'
        - 'C++标准': './cplusplus/C++标准.md'
        - 'Get Started':
          - 'Keyword':
            - 'main': './cplusplus/get-started/keywords/main.md'
            - 'namespace': './cplusplus/get-started/keywords/namespace.md'
            - 'cv限定符': './cplusplus/get-started/keywords/cv限定符.md'
            - 'size_t': './cplusplus/get-started/keywords/size_t.md'
            - 'nullptr': './cplusplus/get-started/keywords/nullptr.md'
            - 'enum': './cplusplus/get-started/keywords/enum.md'
          - 'Basic Concepts':
            - '头文件': './cplusplus/get-started/basic-concepts/头文件.md'
            - '声明和定义': './cplusplus/get-started/basic-concepts/声明和定义.md'
            - '作用域': './cplusplus/get-started/basic-concepts/作用域.md'
            - '类型别名设置': './cplusplus/get-started/basic-concepts/类型别名设置.md'
            - '程序终止': './cplusplus/get-started/basic-concepts/程序终止.md'
            - '常量': './cplusplus/get-started/basic-concepts/常量.md'
            - '数组': './cplusplus/get-started/basic-concepts/数组.md'
            - '函数': './cplusplus/get-started/basic-concepts/函数.md'
            - '初始化': './cplusplus/get-started/basic-concepts/初始化.md'
            - '临时对象': './cplusplus/get-started/basic-concepts/临时对象.md'
            - '链接': './cplusplus/get-started/basic-concepts/链接.md'
          - 'Pointer&Array':
            - '指针类型': './cplusplus/get-started/pointer-array/指针类型.md'
            - 'const指针和volatile指针': './cplusplus/get-started/pointer-array/const指针和volatile指针.md'
            - '指针和数组': './cplusplus/get-started/pointer-array/指针和数组.md'
            - '原始数组': './cplusplus/get-started/pointer-array/原始数组.md'
            - '原始指针': './cplusplus/get-started/pointer-array/原始指针.md'
            - '指针名和数组名的区别': './cplusplus/get-started/pointer-array/指针名和数组名的区别.md'
            - '二维数组和二级指针': './cplusplus/get-started/pointer-array/二维数组和二级指针.md'
            - '指针数组和数组指针': './cplusplus/get-started/pointer-array/指针数组和数组指针.md'
            - '指针常量和常量指针': './cplusplus/get-started/pointer-array/指针常量和常量指针.md'
          - 'Type&Cast&Deduce':
            - '类型':
              - '类型概述': './cplusplus/get-started/type-cast-deduce/类型概述.md'
              - '基本类型': './cplusplus/get-started/type-cast-deduce/基本类型.md'
              - 'void类型': './cplusplus/get-started/type-cast-deduce/void类型.md'
              - '字符串类型': './cplusplus/get-started/type-cast-deduce/字符串类型.md'
            - '转换':
              - '标准转换': './cplusplus/get-started/type-cast-deduce/标准转换.md'
              - '现代类型转换': './cplusplus/get-started/type-cast-deduce/现代类型转换.md'
              - '用户定义的类型转换': './cplusplus/get-started/type-cast-deduce/用户定义的类型转换.md'
            - '推断':
              - 'auto': './cplusplus/get-started/type-cast-deduce/auto.md'
              - 'decltype': './cplusplus/get-started/type-cast-deduce/decltype.md'
          - 'Operator Overload':
            - '操作符重载概述': './cplusplus/get-started/operator-overload/操作符重载概述.md'
            - '一元运算符重载': './cplusplus/get-started/operator-overload/一元运算符重载.md'
            - '二元运算符重载': './cplusplus/get-started/operator-overload/二元运算符重载.md'
            - '赋值运算符重载': './cplusplus/get-started/operator-overload/赋值运算符重载.md'
            - '函数调用运算符重载': './cplusplus/get-started/operator-overload/函数调用运算符重载.md'
            - '下标运算符重载': './cplusplus/get-started/operator-overload/下标运算符重载.md'
        - Advanced:
          - Smart Pointer:
            - '智能指针类型': './cplusplus/advanced/smart-pointer/智能指针类型.md'
            - 'unique_ptr': './cplusplus/advanced/smart-pointer/unique_ptr.md'
            - 'shared_ptr': './cplusplus/advanced/smart-pointer/shared_ptr.md'
            - 'weak_ptr': './cplusplus/advanced/smart-pointer/weak_ptr.md'
            - '使用原始指针还是智能指针': './cplusplus/advanced/smart-pointer/使用原始指针还是智能指针.md'
          - Reference:
            - 'lvalue和rvalue': 'cplusplus/advanced/reference/lvalue和rvalue.md'
            - '引用概述': 'cplusplus/advanced/reference/引用概述.md'
            - '引用类型函数操作': 'cplusplus/advanced/reference/引用类型函数操作.md'
            - '指针引用': 'cplusplus/advanced/reference/指针引用.md'
          - Class:
            - 类结构:
              - '类、结构体和共同体': './cplusplus/advanced/class/类、结构体和共同体.md'
              - '结构体': './cplusplus/advanced/class/结构体.md'
              - '类定义': './cplusplus/advanced/class/类定义.md'
              - '基本类结构': './cplusplus/advanced/class/基本类结构.md'
              - '嵌套类定义': './cplusplus/advanced/class/嵌套类定义.md'
              - '继承': './cplusplus/advanced/class/继承.md'
            - 构造器和析构器:
              - '构造器概述': './cplusplus/advanced/class/构造器概述.md'
              - '复制和移动操作': './cplusplus/advanced/class/复制和移动操作.md'
              - '析构器': './cplusplus/advanced/class/析构器.md'
            - 成员和函数:
              - '成员函数概述类型': './cplusplus/advanced/class/成员函数概述.md'
              - '成员访问控制': './cplusplus/advanced/class/成员访问控制.md'
              - 'static成员': './cplusplus/advanced/class/static成员.md'
              - '显式默认和删除函数': './cplusplus/advanced/class/显式默认和删除函数.md'
          - Template:
            - '模板概述': './cplusplus/advanced/template/模板概述.md'
            - '函数模板': './cplusplus/advanced/template/函数模板.md'
            - '模板和名称解析': './cplusplus/advanced/template/模板和名称解析.md'
          - STL:
            - 'STL概述': './cplusplus/advanced/stl/STL概述.md'
            - 'vector': './cplusplus/advanced/stl/vector.md'
            - 'map': './cplusplus/advanced/stl/map.md'
            - 'queue': './cplusplus/advanced/stl/queue.md'
            - 'stack': './cplusplus/advanced/stl/stack.md'
            - 'array': './cplusplus/advanced/stl/array.md'
            - 'for_each': './cplusplus/advanced/stl/for_each.md'
            - 'find': './cplusplus/advanced/stl/find.md'
            - 'sort': './cplusplus/advanced/stl/sort.md'
            - '[shuffle]随机重排列': './cplusplus/advanced/stl/[shuffle]随机重排列.md'
        - 操作:
          - '计时': cplusplus/operate/计时.md
        - FAQ:
          - 'multiple definition of': './cplusplus/faq/multiple-definition-of.md'
          - 'ISO C++ forbids converting a string constant to char*': './cplusplus/faq/ISO C++ forbids converting a string constant to char*.md'
    - 计算框架:
      - PYTORCH:
        - 引言: pytorch/index.md
        - 语法:
          - Tensor: pytorch/grammar/tensor.md
          - one-hot编码: pytorch/grammar/onehot.md
          - '[transpose][permute]维度转换': pytorch/grammar/transpose-permute.md
          - '[clamp]限制取值范围': pytorch/grammar/clamp.md
          - '[index_fill]在给定维度填充指定val': pytorch/grammar/index_fill.md
          - '[nonzero]非零元素下标': pytorch/grammar/nonzero.md
          - '[Conv][Pool]实现原理': pytorch/grammar/conv-pool.md
          - 自定义损失函数: pytorch/grammar/自定义损失函数.md
          - '[softmax]分类概率计算': pytorch/grammar/softmax.md
          - '[AdaptiveMaxPool][AdaptiveAvgPool]自适应池化层': pytorch/grammar/AdaptiveMaxPool-AdaptiveAvgPool.md
          - LeNet-5定义: pytorch/grammar/LeNet5.md
          - AlexNet定义: pytorch/grammar/AlexNet.md
          - 调整张量打印位数: pytorch/grammar/precision.md
          - '[Hook]获取运行时中间层计算结果': pytorch/grammar/hook-获取运行时中间层计算结果.md
        - Cuda:
          - 安装哪个版本的CUDA: pytorch/cuda/安装哪个版本的CUDA.md
          - '[CUDA_VISIBLE_DEVICES]指定哪张卡运行': pytorch/cuda/指定哪张卡运行.md
          - '[empty_cache]清空显存': pytorch/cuda/empty_cache.md
          - '[benchmark]训练加速': pytorch/cuda/benchmark.md
          - 监控显存使用: pytorch/cuda/监控显存使用.md
        - Train:
          - '[译]保存和加载模型': pytorch/train/译-保存和加载模型.md
          - 固定部分参数进行训练: pytorch/train/固定部分参数进行训练.md
          - 查询模型参数总数: pytorch/train/查询模型参数总数.md
          - 为什么推荐使用static_dict方式保存模型: pytorch/train/为什么推荐使用static_dict方式保存模型.md
          - 加载部分预训练模型: pytorch/train/加载部分预训练模型.md
          - '[[DistributedDataParallel]分布式训练]': pytorch/train/distributeddataparallel.md
        - Tool:
          - 可视化: pytorch/tool/visualize.md
        - 问题解答: pytorch/troubleshooting.md
      - NUMPY:
        - '提取数组中属于某一条件的数据': numpy/提取数组中属于某一条件的数据.md
        - '数据保存和加载': numpy/数据保存和加载.md
        - '增加或者减少一维': numpy/增加或者减少一维.md
        - '元素累加': numpy/元素累加.md
        - '[clip]限制取值范围': numpy/限制取值范围.md
        - 问题解答: numpy/troubleshooting.md
      - MNN:
        - 引言: mnn/index.md
        - 编译: mnn/compile.md
        - 推理: mnn/infer.md
        - 模型转换: mnn/convert.md
        - 模型量化: mnn/quantization.md
        - 预处理: mnn/imageprocess.md
    - 视觉实现:
      - TORCHVISION:
        - 数据预处理: torchvision/数据预处理.md
        - '[数据归一化]均值和方差': torchvision/均值和方差.md
        - '[sampler]采样器': torchvision/采样器.md
        - 自定义采样器: torchvision/自定义采样器.md
        - '加载数据集、批量以及转换操作': torchvision/加载数据集-批量以及转换操作.md
        - 自定义数据集和预处理操作: torchvision/自定义数据集和预处理操作.md
        - ImageFolder使用: torchvision/ImageFolder.md
        - '[ConcatDataset]连接多个数据集': torchvision/concatdataset.md
        - '[Ten Crops]多样本裁剪': torchvision/ten-crops.md
      - OPENCV:
        - 概述: opencv/index.md
        - 配置:
          - 'OpenCV 3.x':
            - 'OpenCV-3.4.2源码安装': opencv/configure/3.4.2/源码安装.md
            - 'OpenCV_Contrib-3.4.2源码安装': './opencv/configure/3.4.2/Contrib-源码安装.md'
            - 'OpenCV-3.4.2测试': opencv/configure/3.4.2/测试.md
          - 'OpenCV 4.x':
            - 'OpenCV-4.0.1安装': opencv/configure/4.0.1/安装.md
            - 'OpenCV-4.0.1测试': opencv/configure/4.0.1/测试.md
            - '[OpenCV_Contrib-4.0.1]编译OpenCV4Android': opencv/configure/4.0.1/编译OpenCV4Android.md
            - 'OpenCV-4.1.0安装': opencv/configure/4.1.0/安装.md
            - 'OpenCV-4.1.0配置及测试': opencv/configure/4.1.0/配置及测试.md
            - 'OpenCV-4.2.0安装': opencv/configure/4.2.0/安装.md
            - 'OpenCV-4.2.0配置及测试': opencv/configure/4.2.0/配置及测试.md
            - 'OpenCV-4.4.0安装': opencv/configure/4.4.0/安装.md
            - 'OpenCV-4.7.0安装': opencv/configure/4.7.0/INSTALL.md
          - PYTHON:
            - '[opencv-python]编译与安装': opencv/configure/python/opencv-python.md
            - '[PyCharm]解码opencv python库': opencv/configure/python/pycharm.md
            - '[OpenCV]Anaconda配置': opencv/configure/python/anaconda配置.md
          - '[SSH][OpenCV]远程图像显示': './opencv/configure/SSH-OpenCV-远程图像显示.md'
        - 处理:
          - Base:
            - 运行时间统计: opencv/process/base/运行时间统计.md
            - '[VideoWriter]保存H264/MPEG4格式MP4视频': opencv/process/base/h264-mpeg4.md
            - '[normalize]标准化数据': opencv/process/base/normalize.md
            - '[convertTo]数据转换': opencv/process/base/convertTo.md
            - '[vconcat][hconcat]按行合并以及按列合并': opencv/process/base/vconcat-hconcat.md
            - '[Point_]坐标点的保存和使用': opencv/process/base/Point_.md
            - '[Scalar_]4维向量': opencv/process/base/Scalar_.md
            - '[copyMakeBorder]添加边界': opencv/process/base/copyMakeBorder.md
            - '[cartToPolar]二维向量的大小和角度': opencv/process/base/cartToPolar.md
            - '[threshold]基本阈值操作': opencv/process/base/threshold.md
            - '[旋转][平移][缩放]仿射变换': opencv/process/base/仿射变换.md
            - 单目标追踪: opencv/process/base/单目标追踪.md
            - 去除小黑点: opencv/process/base/去除小黑点.md
            - 非局部均值去噪: opencv/process/base/非局部均值去噪.md
            - 对比度增强: opencv/process/base/对比度增强.md
            - 保存图像数据为字节文件: opencv/process/base/保存图像数据为字节文件.md
          - Advanced:
            - 轮廓检测: opencv/process/advanced/contour.md
          - Filter:
              - '[filter2D]线性滤波器': opencv/process/filter/filter2d.md
              - '[Sobel]图像求导': opencv/process/filter/sobel.md
              - '[Scharr]图像求导': opencv/process/filter/scharr.md
              - '[Laplacian]图像求导': opencv/process/filter/laplacian.md
              - '[Canny]边缘检测': opencv/process/filter/canny.md
          - Feature:
            - '特征/特征检测/特征描述': opencv/process/feature/Understanding-Features.md
            - '[SIFT]特征和描述符计算': opencv/process/feature/sift.md
            - '[Brute-Force][FLANN]特征匹配': opencv/process/feature/特征匹配.md
        - 绘制:
          - '[line]绘制线段': opencv/draw/line.md
          - '[rectangle]绘制边框': opencv/draw/rectangle.md
          - '[掩码]绘制多边形': opencv/draw/fillPoly.md
          - '[text]绘制文本': opencv/draw/text.md
          - '[text]绘制中文字符': opencv/draw/绘制中文字符.md
      - MATPLOTLIB:
        - 引言: matplotlib/引言.md
        - 属性配置: matplotlib/属性配置.md
        - 中文乱码: matplotlib/中文乱码.md
        - 绘图关键概念Figure和Axes: matplotlib/绘图关键概念Figure和Axes.md
        - 手动设置轴刻度间隔: matplotlib/手动设置轴刻度间隔.md
        - '[译]Pyplot教程': matplotlib/译-Pyplot教程.md
        - 折线图: matplotlib/折线图.md
        - 饼图: matplotlib/饼图.md
        - 散点图: matplotlib/散点图.md
        - '图像读取、显示和保存': matplotlib/图像读取-显示和保存.md
        - 3d绘图: matplotlib/3d绘图.md
        - 等高线图: matplotlib/等高线图.md
        - 矩阵显示: matplotlib/矩阵显示.md
        - y轴坐标错乱: matplotlib/y轴坐标错乱.md
        - 指定轴取值范围以及显示轴刻度: matplotlib/指定轴取值范围以及显示轴刻度.md
        - 设置双Y轴: matplotlib/设置双Y轴.md
      - LIBJPEG-TURBO:
        - 引言: libjpeg/index.md
        - 编译: libjpeg/ubuntu-compile.md
      - STB:
        - 引言: stb/index.md
    - 工具:
        - CMAKE:
          - 引言: cmake/index.md
          - 最小实现: cmake/minimum.md
          - 结构优化: cmake/optimization.md
          - 条件编译: cmake/condition.md
          - 基础语法: cmake/basic.md
          - 子模块: cmake/submodule.md
          - cmake安装: cmake/install.md
          - 交叉编译: cmake/crosscompile.md
        - GTEST:
          - 引言: gtest/index.md
          - 编译: gtest/compile.md
          - 使用: gtest/primer.md
          - 小结: gtest/summary.md
        - CLANG-FORMAT:
          - 引言: clang-format/index.md
          - 配置文件: clang-format/generate.md
          - Clion配置: clang-format/clion.md