add some primitive doc

2022-11-10 20:13:36 +08:00 · 2022-11-10 20:13:36 +08:00 · b0b6b6cb56
parent e755f679ee
commit b0b6b6cb56
13 changed files with 174 additions and 1 deletions
--- a/docs/api/api_python/mindspore.ops.rst
+++ b/docs/api/api_python/mindspore.ops.rst
@ -189,6 +189,7 @@ MindSpore中 `mindspore.ops` 接口与上一版本相比，新增、删除和支
    :template: classtemplate.rst
    
    mindspore.ops.AdjustHue
+    mindspore.ops.AdjustSaturation
    mindspore.ops.BoundingBoxDecode
    mindspore.ops.BoundingBoxEncode
    mindspore.ops.CheckValid
@ -217,6 +218,14 @@ MindSpore中 `mindspore.ops` 接口与上一版本相比，新增、删除和支
    :nosignatures:
    :template: classtemplate.rst

+    mindspore.ops.BesselJ0
+    mindspore.ops.BesselJ1
+    mindspore.ops.BesselK0
+    mindspore.ops.BesselK0e
+    mindspore.ops.BesselK1
+    mindspore.ops.BesselK1e
+    mindspore.ops.BesselY0
+    mindspore.ops.BesselY1
    mindspore.ops.Cross

 逐元素运算
@ -401,6 +410,7 @@ Array操作
    :nosignatures:
    :template: classtemplate.rst

+    mindspore.ops.AffineGrid
    mindspore.ops.BatchToSpace
    mindspore.ops.BatchToSpaceND
    mindspore.ops.BroadcastTo
--- a/docs/api/api_python/ops/mindspore.ops.AdjustSaturation.rst
+++ b/docs/api/api_python/ops/mindspore.ops.AdjustSaturation.rst
@ -0,0 +1,24 @@
+mindspore.ops.AdjustSaturation
+==============================
+
+.. py:class:: mindspore.ops.AdjustSaturation()
+
+    调整 RGB 图像的饱和度。
+
+    .. note::
+        该运算是种将 RGB 图像转换为浮点表示的便捷方法。通过将图像转换为HSV色彩空间并调整饱和度通道的强度来调整图像，然后转换回原始数据模式。
+        当多个调整依次进行时尽量减少冗余转换的数量。
+
+    输入：
+        - **image** (Tensor) - 输入的Tensor。dtype需要是float16或float32。Tensor的维度至少是3维。shape的最后一个维度表示通道数，且必须为3。
+        - **scale** (Tensor) - 饱和通道的添加值。dtype需要是float32。Tensor必须是0维的。
+
+    输出：
+        Tensor，具有与 `image` 相同的shape和dtype。
+
+    异常：
+        - **TypeError** - 如果 `image` 或 `scale` 不是Tensor。
+        - **TypeError** - 如果 `image` 的dtype不是：float32或float16。
+        - **TypeError** - 如果 `scale` 的dtype不是：float32。
+        - **ValueError** - 如果 `image` 的维度低于3维。
+        - **ValueError** - 如果 `image` 的shape的最后一个维度不是3。
--- a/docs/api/api_python/ops/mindspore.ops.AffineGrid.rst
+++ b/docs/api/api_python/ops/mindspore.ops.AffineGrid.rst
@ -0,0 +1,8 @@
+mindspore.ops.AffineGrid
+========================
+
+.. py:class:: mindspore.ops.AffineGrid()
+
+    给定一批仿射矩阵 theta，生成 2D 或 3D 流场（采样网格）。
+
+    更多参考详见 :func:`mindspore.ops.affine_grid`。
--- a/docs/api/api_python/ops/mindspore.ops.BesselJ0.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselJ0.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselJ0
+======================
+
+.. py:class:: mindspore.ops.BesselJ0()
+
+    逐元素计算输入数据的BesselJ0函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselJ1.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselJ1.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselJ1
+======================
+
+.. py:class:: mindspore.ops.BesselJ1()
+
+    逐元素计算输入数据的BesselJ1函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselK0.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselK0.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselK0
+======================
+
+.. py:class:: mindspore.ops.BesselK0()
+
+    逐元素计算输入数据的BesselK0函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselK0e.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselK0e.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselK0e
+=======================
+
+.. py:class:: mindspore.ops.BesselK0e()
+
+    逐元素计算输入数据的BesselK0e函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselK1.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselK1.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselK1
+======================
+
+.. py:class:: mindspore.ops.BesselK1()
+
+    逐元素计算输入数据的BesselK1函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselK1e.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselK1e.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselK1e
+=======================
+
+.. py:class:: mindspore.ops.BesselK1e()
+
+    逐元素计算输入数据的BesselK1e函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselY0.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselY0.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselY0
+======================
+
+.. py:class:: mindspore.ops.BesselY0()
+
+    逐元素计算输入数据的BesselY0函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.BesselY1.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BesselY1.rst
@ -0,0 +1,15 @@
+mindspore.ops.BesselY1
+======================
+
+.. py:class:: mindspore.ops.BesselY1()
+
+    逐元素计算输入数据的BesselY1函数值。
+
+    输入：
+        - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16、float32或float64。
+
+    输出：
+        Tensor，shape和数据类型与 `x` 相同。
+
+    异常：
+        - **TypeError** - `x` 不是float16、float32或float64数据类型的Tensor。
--- a/docs/api/api_python_en/mindspore.ops.rst
+++ b/docs/api/api_python_en/mindspore.ops.rst
@ -189,6 +189,7 @@ Image Processing
    :template: classtemplate.rst
    
    mindspore.ops.AdjustHue
+    mindspore.ops.AdjustSaturation
    mindspore.ops.BoundingBoxDecode
    mindspore.ops.BoundingBoxEncode
    mindspore.ops.CheckValid
@ -217,6 +218,14 @@ Mathematical Operators
    :nosignatures:
    :template: classtemplate.rst

+    mindspore.ops.BesselJ0
+    mindspore.ops.BesselJ1
+    mindspore.ops.BesselK0
+    mindspore.ops.BesselK0e
+    mindspore.ops.BesselK1
+    mindspore.ops.BesselK1e
+    mindspore.ops.BesselY0
+    mindspore.ops.BesselY1
    mindspore.ops.Cross

 Element-wise Operator
@ -401,6 +410,7 @@ Array Operation
    :nosignatures:
    :template: classtemplate.rst

+    mindspore.ops.AffineGrid
    mindspore.ops.BatchToSpace
    mindspore.ops.BatchToSpaceND
    mindspore.ops.BroadcastTo
--- a/mindspore/python/mindspore/ops/operations/image_ops.py
+++ b/mindspore/python/mindspore/ops/operations/image_ops.py
@ -44,7 +44,8 @@ class AdjustSaturation(Primitive):
        TypeError: If any iput is not Tensor.
        TypeError: If the type of `image` is not one of the following dtype: float16, float32.
        TypeError: If the type of `scale` is not float32.
-        ValueError: If the dimension of the 'image' is less than 3, or the last dimension of the 'image' is not 3.
+        ValueError: If the dimension of the 'image' is less than 3.
+        ValueError: If the last dimension of the 'image' is not 3.

    Supported Platforms:
        ``Ascend`` ``GPU`` ``CPU``