diff --git a/paddleslim/dist/single_distiller_api_doc.md b/paddleslim/dist/single_distiller_api_doc.md index 4f4472b73602f52cfed6754ed76a7e7fca61a87e..98f2cf89ed7197961a6d5d530bd77f4635ee7fa5 100644 --- a/paddleslim/dist/single_distiller_api_doc.md +++ b/paddleslim/dist/single_distiller_api_doc.md @@ -8,7 +8,7 @@ - teacher_program(Program)-定义了teacher模型的paddle program - student_program(Program)-定义了student模型的paddle program -- data_name_map(dict)-teacher输入接口名与student输入接口名的映射，key为teacher的输入名，value为student的输入名。merge函数将会把这两个模型的输入按对应关系合并在一起，从而促使teacher模型与student模型输入数据相同 +- data_name_map(dict)-teacher输入接口名与student输入接口名的映射，key为teacher的输入名，value为student的输入名。merge函数将会把这两个模型的输入按对应关系合并在一起，保证teacher与student输入数据相同 - place(fluid.CPUPlace()|fluid.CUDAPlace(N))-该参数表示程序运行在何种设备上，这里的N为GPU对应的ID - scope(Scope)-该参数表示teacher variables和student variables所使用的作用域，如果不指定将使用默认的全局作用域。默认值：fluid.global_scope() - name_prefix(str)-为了避免teacher variables和student variables存在同名变量而引起命名冲突，merge函数将统一为teacher variables添加一个名称前缀name_prefix，merge后的program中所有teacher variables都将带有这一名称前缀。默认值：'teacher_' @@ -41,7 +41,7 @@ main_program = dist.merge(teacher_program, student_program, data_name_map, place ## fsp_loss(teacher_var1_name, teacher_var2_name, student_var1_name, student_var2_name, program=fluid.default_main_program()) -fsp_loss为program内的teacher var和student var添加fsp loss，出自论文[<>](http://openaccess.thecvf.com/content_cvpr_2017/papers/Yim_A_Gift_From_CVPR_2017_paper.pdf) +fsp_loss为program内的teacher var和student var添加fsp loss，出自论文[A Gift from Knowledge Distillation: Fast Optimization, Network Minimization and Transfer Learning](http://openaccess.thecvf.com/content_cvpr_2017/papers/Yim_A_Gift_From_CVPR_2017_paper.pdf) **参数：** @@ -49,7 +49,7 @@ fsp_loss为program内的teacher var和student var添加fsp loss，出自论文[< - teacher_var2_name(str): teacher_var2的名称. 对应的variable是一个形为`[batch_size, y_channel, height, width]`的4-D特征图Tensor，数据类型为float32或float64。只有y_channel可以与teacher_var1的x_channel不同，其他维度必须与teacher_var1相同 - student_var1_name(str): student_var1的名称. 对应的variable需与teacher_var1尺寸保持一致，是一个形为`[batch_size, x_channel, height, width]`的4-D特征图Tensor，数据类型为float32或float64 - student_var2_name(str): student_var2的名称. 对应的variable需与teacher_var2尺寸保持一致，是一个形为`[batch_size, y_channel, height, width]`的4-D特征图Tensor，数据类型为float32或float64。只有y_channel可以与student_var1的x_channel不同，其他维度必须与student_var1相同 -- program(Program): 用于蒸馏训练的fluid program。默认值：`fluid.default_main_program()` +- program(Program): 用于蒸馏训练的fluid program。默认值：fluid.default_main_program() **返回：**由teacher_var1, teacher_var2, student_var1, student_var2组合得到的fsp_loss @@ -126,8 +126,8 @@ soft_label_loss为program内的teacher var和student var添加soft label loss， - teacher_var_name(str): teacher_var的名称. - student_var_name(str): student_var的名称. - program(Program): 用于蒸馏训练的fluid program。默认值：fluid.default_main_program() -- teacher_temperature(float): 对teacher_var进行soft操作的温度值，温度值越大得到的特征图就越平滑 -- student_temperature(float): 对student_var进行soft操作的温度值，温度值越大得到的特征图就越平滑 +- teacher_temperature(float): 对teacher_var进行soft操作的温度值，温度值越大得到的特征图越平滑 +- student_temperature(float): 对student_var进行soft操作的温度值，温度值越大得到的特征图越平滑 **返回：**由teacher_var, student_var组合得到的soft_label_loss @@ -200,7 +200,7 @@ with fluid.program_guard(main_program): ## 注意事项 -在添加蒸馏loss时会引入新的variable，所以需要注意新引入的variable不要与student variables命名冲突。这里建议两种用法： +在添加蒸馏loss时会引入新的variable，需要注意新引入的variable不要与student variables命名冲突。这里建议两种用法： -1. 建议与student_program使用同一个命名空间，以避免一些未指定名称的variables(例如tmp_0, tmp_1...)多次定义为同一名称而出现命名冲突 -2. 建议在添加蒸馏loss时指定一个命名空间前缀，具体用法请参考Paddle官方文档[fluid.name_scope](https://www.paddlepaddle.org.cn/documentation/docs/zh/api_cn/fluid_cn/name_scope_cn.html#name-scope) \ No newline at end of file +1. 建议与student_program使用同一个命名空间，以避免一些未指定名称的variables(例如tmp_0, tmp_1...)多次定义为同一名称出现命名冲突 +2. 建议在添加蒸馏loss时指定一个命名空间前缀，具体用法请参考Paddle官方文档[fluid.name_scope](https://www.paddlepaddle.org.cn/documentation/docs/zh/api_cn/fluid_cn/name_scope_cn.html#name-scope)