Browse Source

!211 add specification for var name.

Merge pull request !211 from zhangyi/master
pull/216/MERGE
i-robot Gitee 4 years ago
parent
commit
57c5ce2e80
2 changed files with 37 additions and 0 deletions
  1. +19
    -0
      security/comments_specification_en.md
  2. +18
    -0
      security/comments_specification_zh_cn.md

+ 19
- 0
security/comments_specification_en.md View File

@@ -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


+ 18
- 0
security/comments_specification_zh_cn.md View File

@@ -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示例

#### 类


Loading…
Cancel
Save