From 00c378dc9214470beb24644e0c77aed039cb75f4 Mon Sep 17 00:00:00 2001
From: lby <liubuyu1@huawei.com>
Date: Wed, 1 Jun 2022 15:04:05 +0800
Subject: [PATCH] doc for renorm

---
 .../api_python/mindspore.ops.functional.rst   |  1 +
 .../api_python/mindspore/mindspore.Tensor.rst | 21 ++++++++++++++++
 .../ops/mindspore.ops.func_renorm.rst         | 24 +++++++++++++++++++
 .../mindspore.ops.functional.rst              |  1 +
 4 files changed, 47 insertions(+)
 create mode 100644 docs/api/api_python/ops/mindspore.ops.func_renorm.rst

diff --git a/docs/api/api_python/mindspore.ops.functional.rst b/docs/api/api_python/mindspore.ops.functional.rst
index 23e03fe5d8c..d8bccf48931 100644
--- a/docs/api/api_python/mindspore.ops.functional.rst
+++ b/docs/api/api_python/mindspore.ops.functional.rst
@@ -258,6 +258,7 @@ Reduction算子
     mindspore.ops.matmul
     mindspore.ops.cdist
     mindspore.ops.ger
+    mindspore.ops.renorm
 
 Tensor操作算子
 ----------------
diff --git a/docs/api/api_python/mindspore/mindspore.Tensor.rst b/docs/api/api_python/mindspore/mindspore.Tensor.rst
index 467a802c033..a703debb926 100644
--- a/docs/api/api_python/mindspore/mindspore.Tensor.rst
+++ b/docs/api/api_python/mindspore/mindspore.Tensor.rst
@@ -1037,6 +1037,27 @@ mindspore.Tensor
 
         一维Tensor，含有与输入相同的元素。
 
+    .. py:method:: renorm(p, dim, maxnorm)
+        沿维度 `dim` 重新规范Tensor的子张量，并且每个子张量的p范数不超过给定的最大范数 `maxnorm` 。
+        如果子张量的p范数小于 `maxnorm` ，则当前子张量不需要修改；否则该子张量需要修改为对应位置的原值除以该子张量的p范数，然后再乘上 `maxnorm` 。
+
+        **参数：**
+
+        - **p** (int) - 范数。
+        - **dim** (int) - 维度。
+        - **maxnorm** (float) - 给定的最大范数。
+
+        **返回：**
+
+        Tensor，shape和type与输入Tensor一致。
+
+        **异常：**
+
+        - **TypeError** - `p` 不是int类型。
+        - **TypeError** - `dim` 不是int类型。
+        - **TypeError** - `maxnorm` 不是float类型。
+        - **ValueError** - `p` 小于等于0。
+
     .. py:method:: repeat(repeats, axis=None)
 
         对数组中的元素进行重复复制。
diff --git a/docs/api/api_python/ops/mindspore.ops.func_renorm.rst b/docs/api/api_python/ops/mindspore.ops.func_renorm.rst
new file mode 100644
index 00000000000..5df7a7d287d
--- /dev/null
+++ b/docs/api/api_python/ops/mindspore.ops.func_renorm.rst
@@ -0,0 +1,24 @@
+mindspore.ops.renorm
+====================
+
+.. py:function:: mindspore.ops.renorm(input_x, p, dim, maxnorm)
+    沿维度 `dim` 重新规范输入 `input_x` 的子张量，并且每个子张量的p范数不超过给定的最大范数 `maxnorm` 。
+    如果子张量的p范数小于 `maxnorm` ，则当前子张量不需要修改；否则该子张量需要修改为对应位置的原值除以该子张量的p范数，然后再乘上 `maxnorm` 。
+
+    **参数：**
+
+    - **input_x** (Tensor) - 输入张量。
+    - **p** (int) - 范数。
+    - **dim** (int) - 维度。
+    - **maxnorm** (float) - 给定的最大范数。
+
+    **返回：**
+
+    Tensor，shape和type与输入Tensor一致。
+
+    **异常：**
+
+    - **TypeError** - `p` 不是int类型。
+    - **TypeError** - `dim` 不是int类型。
+    - **TypeError** - `maxnorm` 不是float类型。
+    - **ValueError** - `p` 小于等于0。
diff --git a/docs/api/api_python_en/mindspore.ops.functional.rst b/docs/api/api_python_en/mindspore.ops.functional.rst
index 7d026b70b8a..dd2fd9d3793 100644
--- a/docs/api/api_python_en/mindspore.ops.functional.rst
+++ b/docs/api/api_python_en/mindspore.ops.functional.rst
@@ -257,6 +257,7 @@ Linear Algebraic Operators
     mindspore.ops.matmul
     mindspore.ops.cdist
     mindspore.ops.ger
+    mindspore.ops.renorm
 
 Tensor Operation Operators
 --------------------------