diff --git a/security/comments_specification_en.md b/security/comments_specification_en.md index e27391b..aed62d3 100644 --- a/security/comments_specification_en.md +++ b/security/comments_specification_en.md @@ -417,6 +417,25 @@ Supported Platforms: :func:`mindspore.compression.quant.create_quant_config` ``` +- In the interface description, the variable name or interface name should be wrapped with the symbol \', + and the variable value should be wrapped with the symbol \' or \". + + - Variable name or interface name. + + ```text + This part is a more detailed overview of `Mul` operation. For more details about Quantization, + please refer to the implementation of subclass of `Observer`. + + Other losses derived from this should implement their own `construct` and use method `self.get_loss` + to apply reduction to loss values. + ``` + + - variable value. + + ```text + If `reduction` is not one of 'none', 'mean', 'sum'. + ``` + ### Python Example #### Class diff --git a/security/comments_specification_zh_cn.md b/security/comments_specification_zh_cn.md index d21bbcc..c76b964 100644 --- a/security/comments_specification_zh_cn.md +++ b/security/comments_specification_zh_cn.md @@ -417,6 +417,24 @@ Supported Platforms: :func:`mindspore.compression.quant.create_quant_config` ``` +- 接口描述中,变量名或接口名使用符号\`包裹,变量值使用符号\'或\"包裹。 + + - 变量名或接口名。 + + ```text + This part is a more detailed overview of `Mul` operation. For more details about Quantization, + please refer to the implementation of subclass of `Observer`. + + Other losses derived from this should implement their own `construct` and use method `self.get_loss` + to apply reduction to loss values. + ``` + + - 变量值。 + + ```text + If `reduction` is not one of 'none', 'mean', 'sum'. + ``` + ### Python示例 #### 类