Browse Source

update comment epscification

pull/224/head
yingchen 4 years ago
parent
commit
084f7ce0ab
2 changed files with 26 additions and 0 deletions
  1. +13
    -0
      security/comments_specification_en.md
  2. +13
    -0
      security/comments_specification_zh_cn.md

+ 13
- 0
security/comments_specification_en.md View File

@@ -436,6 +436,19 @@ Supported Platforms:
If `reduction` is not one of 'none', 'mean', 'sum'.
```

- The deprecated operator needs to specify the recommended api, and "Deprecated" needs to be added in the Supported Platforms.

```python
class BasicLSTMCell(PrimitiveWithInfer):
"""
It's similar to operator :class:`DynamicRNN`. BasicLSTMCell will be deprecated in the future.
Please use DynamicRNN instead.

Supported Platforms:
Deprecated
"""
```

### Python Example

#### Class


+ 13
- 0
security/comments_specification_zh_cn.md View File

@@ -435,6 +435,19 @@ Supported Platforms:
If `reduction` is not one of 'none', 'mean', 'sum'.
```

- 废弃算子需要写明建议使用的接口,以及需要在支持平台中写上Deprecated。

```python
class BasicLSTMCell(PrimitiveWithInfer):
"""
It's similar to operator :class:`DynamicRNN`. BasicLSTMCell will be deprecated in the future.
Please use DynamicRNN instead.

Supported Platforms:
Deprecated
"""
```

### Python示例

#### 类


Loading…
Cancel
Save