diff --git a/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst b/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst index d7a8b893256..a3b780fb1d9 100644 --- a/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst +++ b/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst @@ -36,8 +36,8 @@ mindspore.ops.Conv3DTranspose - **pad** (Union(int, tuple[int])) - 在输入各维度两侧填充的数量。如果 `pad` 是一个整数，则前部、后部、顶部，底部，左边和右边的填充都等于 `pad` 。如果 `pad` 是6个整数的Tuple，则前部、后部、顶部、底部、左边和右边的填充分别等于填充 `pad[0]` 、 `pad[1]` 、 `pad[2]` 、 `pad[3]` 、 `pad[4]` 和 `pad[5]` 。默认值：0。 - **stride** (Union(int, tuple[int])) - 三维卷积核的移动步长。数据类型为整型或三个整型的Tuple。一个整数表示在深度、高度和宽度方向的移动步长均为该值。三个整数的Tuple分别表示在深度、高度和宽度方向的移动步长。默认值：1。 - - **dilation** (Union(int, tuple[int])) - 卷积核膨胀尺寸，指定应用卷积核的间隔。默认值: 1。 - - **group** (int) - 将过滤器拆分为组。默认值: 1。目前仅支持取值1。 + - **dilation** (Union(int, tuple[int])) - 卷积核膨胀尺寸，指定应用卷积核的间隔。默认值：1。 + - **group** (int) - 将过滤器拆分为组。默认值：1。目前仅支持取值1。 - **output_padding** (Union(int, tuple[int])) - 为输出的各个维度添加额外长度。默认值：0。 - **data_format** (str) - 支持的数据模式。目前仅支持"NCDHW"。 diff --git a/docs/api/api_python/ops/mindspore.ops.CumProd.rst b/docs/api/api_python/ops/mindspore.ops.CumProd.rst index 0b995bf815e..71e8e357119 100644 --- a/docs/api/api_python/ops/mindspore.ops.CumProd.rst +++ b/docs/api/api_python/ops/mindspore.ops.CumProd.rst @@ -11,8 +11,8 @@ mindspore.ops.CumProd y_i = x_1 * x_2 * x_3 * ... * x_i 参数： - - **exclusive** (bool) - 如果为True，则排除末尾元素计算元素累计积（见示例）。默认值: False。 - - **reverse** (bool) - 如果为True，则沿 `axis` 反转结果。默认值: False。 + - **exclusive** (bool) - 如果为True，则排除末尾元素计算元素累计积（见示例）。默认值：False。 + - **reverse** (bool) - 如果为True，则沿 `axis` 反转结果。默认值：False。 输入： - **x** (Tensor[Number]) - 输入Tensor，shape: :math:`(N,*)` ，其中 :math:`*` 表示任何数量的附加维度。其秩应小于8。 diff --git a/docs/api/api_python/ops/mindspore.ops.DType.rst b/docs/api/api_python/ops/mindspore.ops.DType.rst index 699a13e4f3e..ad83b823d1e 100644 --- a/docs/api/api_python/ops/mindspore.ops.DType.rst +++ b/docs/api/api_python/ops/mindspore.ops.DType.rst @@ -5,15 +5,12 @@ 计算输入Tensor的数据类型，且返回的数据类型为 `mindspore.dtype` 。 - **输入：** + 输入： + - **input_x** (Tensor) - 输入Tensor，其shape为 :math:`(x1,x2,...,xR)` 。 - - **input_x** (Tensor) - 输入Tensor，其shape为 :math:`(x1,x2,...,xR)` 。 + 输出： + `mindspore.dtype` ，输入Tensor的数据类型。 - **输出：** + 异常： + - **TypeError** - 如果 `input_x` 不是Tensor。 - `mindspore.dtype` ，输入Tensor的数据类型。 - - **异常：** - - - **TypeError** - 如果 `input_x` 不是Tensor。 - diff --git a/docs/api/api_python/ops/mindspore.ops.DataFormatDimMap.rst b/docs/api/api_python/ops/mindspore.ops.DataFormatDimMap.rst index 8446ddbebad..56f42c7cb38 100644 --- a/docs/api/api_python/ops/mindspore.ops.DataFormatDimMap.rst +++ b/docs/api/api_python/ops/mindspore.ops.DataFormatDimMap.rst @@ -5,20 +5,16 @@ mindspore.ops.DataFormatDimMap 返回源数据格式中的目标数据格式的维度索引。 - **参数：** + 参数： + - **src_format** (str) - 源数据格式中的可选值。格式可以是"NHWC"和"NCHW"。默认值："NHWC"。 + - **dst_format** (str) - 目标数据格式中的可选值。格式可以是"NHWC"和"NCHW"。默认值："NCHW"。 - - **src_format** (str) - 源数据格式中的可选值。格式可以是“NHWC”和“NCHW”。默认值：“NHWC”。 - - **dst_format** (str) - 目标数据格式中的可选值。格式可以是“NHWC”和“NCHW”。默认值：“NCHW”。 + 输入： + - **input_x** (Tensor) - 输入Tensor，每个元素都用作源数据格式的维度索引。建议值在[-4, 4)范围内，仅支持int32。 - **输入：** + 输出： + 输出Tensor，返回给定目标数据格式的维度索引，与 `input_x` 具有相同的数据类型和shape。 - - **input_x** (Tensor) - 输入Tensor，每个元素都用作源数据格式的维度索引。建议值在[-4, 4)范围内，仅支持int32。 - - **输出：** - - 输出Tensor，返回给定目标数据格式的维度索引，与 `input_x` 具有相同的数据类型和shape。 - - **异常：** - - - **TypeError** - `src_format` 或 `dst_format` 不是str。 - - **TypeError** - `input_x` 不是数据类型为int32的Tensor。 \ No newline at end of file + 异常： + - **TypeError** - `src_format` 或 `dst_format` 不是str。 + - **TypeError** - `input_x` 不是数据类型为int32的Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Depend.rst b/docs/api/api_python/ops/mindspore.ops.Depend.rst index f3b12fd5f56..302c05ac08e 100644 --- a/docs/api/api_python/ops/mindspore.ops.Depend.rst +++ b/docs/api/api_python/ops/mindspore.ops.Depend.rst @@ -13,12 +13,10 @@ mindspore.ops.Depend b = B(y) ---> y = Depend(y, a) ---> b = B(y) - **输入：** + 输入： + - **value** (Tensor) - 应被Depend操作符返回的Tensor。 + - **expr** (Expression) - 应被执行的无输出的表达式。 - - **value** (Tensor) - 应被Depend操作符返回的Tensor。 - - **expr** (Expression) - 应被执行的无输出的表达式。 - - **输出：** - - Tensor，作为 `value` 传入的变量。 + 输出： + Tensor，作为 `value` 传入的变量。 diff --git a/docs/api/api_python/ops/mindspore.ops.Div.rst b/docs/api/api_python/ops/mindspore.ops.Div.rst index 756ed69ecc0..53a5414788e 100644 --- a/docs/api/api_python/ops/mindspore.ops.Div.rst +++ b/docs/api/api_python/ops/mindspore.ops.Div.rst @@ -15,16 +15,13 @@ mindspore.ops.Div - 当输入是两个Tensor时，它们的数据类型不能同时是bool，并保证其shape可以广播。 - 当输入是一个Tensor和一个Scalar时，Scalar只能是一个常数。 - **输入：** + 输入： + - **x** (Union[Tensor, number.Number, bool]) - 第一个输入，是一个number.Number、bool值或数据类型为 `number `_ 或 `bool_ `_ 的Tensor。 + - **y** (Union[Tensor, number.Number, bool]) - 第二个输入，当第一个输入是Tensor时，第二个输入应该是一个number.Number或bool值，或数据类型为number或bool_的Tensor。当第一个输入是Scalar时，第二个输入必须是数据类型为number或bool_的Tensor。 - - **x** (Union[Tensor, number.Number, bool]) - 第一个输入，是一个number.Number、bool值或数据类型为 `number `_ 或 `bool_ `_ 的Tensor。 - - **y** (Union[Tensor, number.Number, bool]) - 第二个输入，当第一个输入是Tensor时，第二个输入应该是一个number.Number或bool值，或数据类型为number或bool_的Tensor。当第一个输入是Scalar时，第二个输入必须是数据类型为number或bool_的Tensor。 + 输出： + Tensor，shape与输入 `x`，`y` 广播后的shape相同，数据类型为两个输入中精度较高的类型。 - **输出：** - - Tensor，shape与输入 `x`，`y` 广播后的shape相同，数据类型为两个输入中精度较高的类型。 - - **异常：** - - - **TypeError** - `x` 和 `y` 都不是Tensor。 - - **TypeError** - `x` 和 `y` 数据类型都是bool_的Tensor。 + 异常： + - **TypeError** - `x` 和 `y` 都不是Tensor。 + - **TypeError** - `x` 和 `y` 数据类型都是bool_的Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.Dropout.rst b/docs/api/api_python/ops/mindspore.ops.Dropout.rst index 13d448cdaba..85bd56fa5fa 100644 --- a/docs/api/api_python/ops/mindspore.ops.Dropout.rst +++ b/docs/api/api_python/ops/mindspore.ops.Dropout.rst @@ -5,24 +5,20 @@ Dropout是一种正则化手段，通过在训练中以 :math:`1 - keep\_prob` 的概率随机将神经元输出设置为0，起到减少神经元相关性的作用，避免过拟合。 - **参数：** + 参数： + - **keep_prob** (float) - 输入神经元保留概率，数值范围在0到1之间。例如，keep_prob=0.9，删除10%的神经元。默认值：0.5。 + - **Seed0** (int) - 算子层的随机种子，用于生成随机数。默认值：0。 + - **Seed1** (int) - 全局的随机种子，和算子层的随机种子共同决定最终生成的随机数。默认值：0。 - - **keep_prob** (float) - 输入神经元保留概率，数值范围在0到1之间。例如，keep_prob=0.9，删除10%的神经元。默认值：0.5。 - - **Seed0** (int) - 算子层的随机种子，用于生成随机数。默认值：0。 - - **Seed1** (int) - 全局的随机种子，和算子层的随机种子共同决定最终生成的随机数。默认值：0。 + 输入： + - **x** (Tensor) - Dropout的输入，任意维度的Tensor，其数据类型为float16或float32。 - **输入：** + 输出： + - **output** (Tensor) - shape和数据类型与 `x` 相同。 + - **mask** (Tensor) - shape与 `x` 相同。 - - **x** (Tensor) - Dropout的输入，任意维度的Tensor，其数据类型为float16或float32。 - - **输出：** - - - **output** (Tensor) - shape和数据类型与 `x` 相同。 - - **mask** (Tensor) - shape与 `x` 相同。 - - **异常：** - - - **TypeError** - `keep_prob` 不是float。 - - **TypeError** - `Seed0` 或 `Seed1` 不是int。 - - **TypeError** - `x` 的数据类型既不是float16也不是float32。 - - **TypeError** - `x` 不是Tensor。 \ No newline at end of file + 异常： + - **TypeError** - `keep_prob` 不是float。 + - **TypeError** - `Seed0` 或 `Seed1` 不是int。 + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + - **TypeError** - `x` 不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.DynamicGRUV2.rst b/docs/api/api_python/ops/mindspore.ops.DynamicGRUV2.rst index 01b795922eb..4e3050093b5 100644 --- a/docs/api/api_python/ops/mindspore.ops.DynamicGRUV2.rst +++ b/docs/api/api_python/ops/mindspore.ops.DynamicGRUV2.rst @@ -18,62 +18,58 @@ mindspore.ops.DynamicGRUV2 :math:`W` ， :math:`b` 为可学习权重和偏置。 :math:`\sigma` 是sigmoid激活函数， :math:`*` 为Hadamard乘积。 - **参数：** - - - **direction** (str) - 指定GRU方向，str类型。默认值："UNIDIRECTIONAL"。目前仅支持"UNIDIRECTIONAL"。 - - **cell_depth** (int) - GRU单元深度。默认值：1。 - - **keep_prob** (float) - Dropout保留概率。默认值：1.0。 - - **cell_clip** (float) - 输出裁剪率。默认值：-1.0。 - - **num_proj** (int) - 投影维度。默认值：0。 - - **time_major** (bool) - 如为True，则指定输入的第一维度为序列长度 `num_step` ，如为False则第一维度为 `batch_size` 。默认值：True。 - - **activation** (str) - 字符串，指定activation类型。默认值："tanh"。目前仅支持取值"tanh"。 - - **gate_order** (str) - 字符串，指定weight和bias中门的排列顺序，可选值为"rzh"或"zrh"。默认值："rzh"。"rzh"代表顺序为：重置门、更新门、隐藏门。"zrh"代表顺序为：更新门，重置门，隐藏门。 - - **reset_after** (bool) - 是否在矩阵乘法后使用重置门。默认值：True。 - - **is_training** (bool) - 是否为训练模式。默认值：True。 + 参数： + - **direction** (str) - 指定GRU方向，str类型。默认值："UNIDIRECTIONAL"。目前仅支持"UNIDIRECTIONAL"。 + - **cell_depth** (int) - GRU单元深度。默认值：1。 + - **keep_prob** (float) - Dropout保留概率。默认值：1.0。 + - **cell_clip** (float) - 输出裁剪率。默认值：-1.0。 + - **num_proj** (int) - 投影维度。默认值：0。 + - **time_major** (bool) - 如为True，则指定输入的第一维度为序列长度 `num_step` ，如为False则第一维度为 `batch_size` 。默认值：True。 + - **activation** (str) - 字符串，指定activation类型。默认值："tanh"。目前仅支持取值"tanh"。 + - **gate_order** (str) - 字符串，指定weight和bias中门的排列顺序，可选值为"rzh"或"zrh"。默认值："rzh"。"rzh"代表顺序为：重置门、更新门、隐藏门。"zrh"代表顺序为：更新门，重置门，隐藏门。 + - **reset_after** (bool) - 是否在矩阵乘法后使用重置门。默认值：True。 + - **is_training** (bool) - 是否为训练模式。默认值：True。 - **输入：** - - - **x** (Tensor) - 输入词序列。shape: :math:`(\text{num_step}, \text{batch_size}, \text{input_size})` 。数据类型支持float16。 - - **weight_input** (Tensor) - 权重 :math:`W_{\{ir,iz,in\}}` 。 - shape： :math:`(\text{input_size}, 3 \times \text{hidden_size})` 。 - 数据类型支持float16。 - - **weight_hidden** (Tensor) - 权重 :math:`W_{\{hr,hz,hn\}}` 。 - shape： :math:`(\text{hidden_size}, 3 \times \text{hidden_size})` 。 - 数据类型支持float16。 - - **bias_input** (Tensor) - 偏差 :math:`b_{\{ir,iz,in\}}` 。shape： :math:`(3 \times \text{hidden_size})` ，或 `None` 。与输入 `init_h` 的数据类型相同。 - - **bias_hidden** (Tensor) - 偏差 :math:`b_{\{hr,hz,hn\}}` 。shape： :math:`(3 \times \text{hidden_size})` ，或 `None` 。与输入 `init_h` 的数据类型相同。 - - **seq_length** (Tensor) - 每个batch中序列的长度。shape： :math:`(\text{batch_size})` 。 - 目前仅支持 `None` 。 - - **init_h** (Tensor) - 初始隐藏状态。shape： :math:`(\text{batch_size}, \text{hidden_size})` 。 - 数据类型支持float16和float32。 + 输入： + - **x** (Tensor) - 输入词序列。shape: :math:`(\text{num_step}, \text{batch_size}, \text{input_size})` 。数据类型支持float16。 + - **weight_input** (Tensor) - 权重 :math:`W_{\{ir,iz,in\}}` 。 + shape： :math:`(\text{input_size}, 3 \times \text{hidden_size})` 。 + 数据类型支持float16。 + - **weight_hidden** (Tensor) - 权重 :math:`W_{\{hr,hz,hn\}}` 。 + shape： :math:`(\text{hidden_size}, 3 \times \text{hidden_size})` 。 + 数据类型支持float16。 + - **bias_input** (Tensor) - 偏差 :math:`b_{\{ir,iz,in\}}` 。shape： :math:`(3 \times \text{hidden_size})` ，或 `None` 。与输入 `init_h` 的数据类型相同。 + - **bias_hidden** (Tensor) - 偏差 :math:`b_{\{hr,hz,hn\}}` 。shape： :math:`(3 \times \text{hidden_size})` ，或 `None` 。与输入 `init_h` 的数据类型相同。 + - **seq_length** (Tensor) - 每个batch中序列的长度。shape： :math:`(\text{batch_size})` 。 + 目前仅支持 `None` 。 + - **init_h** (Tensor) - 初始隐藏状态。shape： :math:`(\text{batch_size}, \text{hidden_size})` 。 + 数据类型支持float16和float32。 - **输出：** + 输出： + - **y** (Tensor) - Tensor，shape： - - **y** (Tensor) - Tensor，shape： + - :math:`(num\_step, batch\_size, min(hidden\_size, num\_proj))` ，如果 `num_proj` 大于0, + - :math:`(num\_step, batch\_size, hidden\_size)` ，如果 `num_proj` 等于0。 + + 与 `bias_type` 数据类型相同。 - - :math:`(num\_step, batch\_size, min(hidden\_size, num\_proj))` ，如果 `num_proj` 大于0, - - :math:`(num\_step, batch\_size, hidden\_size)` ，如果 `num_proj` 等于0。 - - 与 `bias_type` 数据类型相同。 + - **output_h** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 + - **update** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 + - **reset** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 + - **new** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 + - **hidden_new** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 - - **output_h** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 - - **update** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 - - **reset** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 - - **new** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 - - **hidden_new** (Tensor) - Tensor，shape： :math:`(\text{num_step}, \text{batch_size}, \text{hidden_size})` 。与 `bias_type` 数据类型相同。 + 关于 `bias_type` : - 关于 `bias_type` : + - 如果 `bias_input` 和 `bias_hidden` 均为 `None` ，则 `bias_type` 为 `init_h` 的数据类型。 + - 如果 `bias_input` 不为 `None` ，则 `bias_type` 为 `bias_input` 的数据类型。 + - 如果 `bias_input` 为 `None` 而 `bias_hidden` 不为 `None` ，则 `bias_type` 为 `bias_hidden` 的数据类型。 - - 如果 `bias_input` 和 `bias_hidden` 均为 `None` ，则 `bias_type` 为 `init_h` 的数据类型。 - - 如果 `bias_input` 不为 `None` ，则 `bias_type` 为 `bias_input` 的数据类型。 - - 如果 `bias_input` 为 `None` 而 `bias_hidden` 不为 `None` ，则 `bias_type` 为 `bias_hidden` 的数据类型。 - - **异常：** - - - **TypeError** - `direction` 、 `activation` 或 `gate_order` 不是str。 - - **TypeError** - `cell_depth` 或 `num_proj` 不是int类型。 - - **TypeError** - `keep_prob` 或 `cell_clip` 不是float类型。 - - **TypeError** - `time_major` 、 `reset_after` 或 `is_training` 不是bool类型。 - - **TypeError** - `x` 、 `weight_input` 、 `weight_hidden` 、 `bias_input` 、 `bias_hidden` 、 `seq_length` 或 `ini_h` 不是Tensor。 - - **TypeError** - `x` 、 `weight_input` 或 `weight_hidden` 的数据类型非float16。 - - **TypeError** - `init_h` 数据类型非float16或float32。 + 异常： + - **TypeError** - `direction` 、 `activation` 或 `gate_order` 不是str。 + - **TypeError** - `cell_depth` 或 `num_proj` 不是int类型。 + - **TypeError** - `keep_prob` 或 `cell_clip` 不是float类型。 + - **TypeError** - `time_major` 、 `reset_after` 或 `is_training` 不是bool类型。 + - **TypeError** - `x` 、 `weight_input` 、 `weight_hidden` 、 `bias_input` 、 `bias_hidden` 、 `seq_length` 或 `ini_h` 不是Tensor。 + - **TypeError** - `x` 、 `weight_input` 或 `weight_hidden` 的数据类型非float16。 + - **TypeError** - `init_h` 数据类型非float16或float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.DynamicRNN.rst b/docs/api/api_python/ops/mindspore.ops.DynamicRNN.rst index c903e468eaf..ea1487c6e46 100644 --- a/docs/api/api_python/ops/mindspore.ops.DynamicRNN.rst +++ b/docs/api/api_python/ops/mindspore.ops.DynamicRNN.rst @@ -24,46 +24,42 @@ mindspore.ops.DynamicRNN 例如， :math:`W_{ix}和b_{ix}` 是把 :math:`x` 转换为 :math:`i` 的权重和偏置。 - **参数：** + 参数： + - **cell_type** (str) - 指定Cell类型。当前仅支持LSTM。默认值：LSTM。 + - **direction** (str) - 指定单向或双向。默认值：UNIDIRECTIONAL。当前仅支持UNIDIRECTIONAL。 + - **cell_depth** (int) - 指定cell的层数。默认值：1。 + - **use_peephole** (bool) - 是否使用"peephole connections"。默认值：False。 + - **keep_prob** (float) - 指定保留率，即每个元素被保留的概率。1.0表示所有元素全部保留。默认值：1.0。 + - **cell_clip** (float) - 将Cell裁剪到指定的值，负值表示禁用。默认值：-1.0。 + - **num_proj** (int) - 投影矩阵的输出维数。默认值：0。 + - **time_major** (bool) - 指定输入 `x` 的数据排列格式。如果为True，格式为 :math:`(num\_step, batch\_size, input\_size)`，如果为False，格式为：:math:`(batch\_size, num\_step, input\_size)` 。默认值：True。当前仅支持True。 + - **activation** (str) - 指定激活函数。默认值：tanh。当前仅支持tanh。 + - **forget_bias** (float) - 指定遗忘门的偏置。默认值：0.0。 + - **is_training** (bool) - 指定是否开启训练。默认值：True。 - - **cell_type** (str) - 指定Cell类型。当前仅支持LSTM。默认值：LSTM。 - - **direction** (str) - 指定单向或双向。默认值：UNIDIRECTIONAL。当前仅支持UNIDIRECTIONAL。 - - **cell_depth** (int) - 指定cell的层数。默认值：1。 - - **use_peephole** (bool) - 是否使用"peephole connections"。默认值：False。 - - **keep_prob** (float) - 指定保留率，即每个元素被保留的概率。1.0表示所有元素全部保留。默认值：1.0。 - - **cell_clip** (float) - 将Cell裁剪到指定的值，负值表示禁用。默认值：-1.0。 - - **num_proj** (int) - 投影矩阵的输出维数。默认值：0。 - - **time_major** (bool) - 指定输入 `x` 的数据排列格式。如果为True，格式为 :math:`(num\_step, batch\_size, input\_size)`，如果为False，格式为：:math:`(batch\_size, num\_step, input\_size)` 。默认值：True。当前仅支持True。 - - **activation** (str) - 指定激活函数。默认值：tanh。当前仅支持tanh。 - - **forget_bias** (float) - 指定遗忘门的偏置。默认值：0.0。 - - **is_training** (bool) - 指定是否开启训练。默认值：True。 + 输入： + - **x** (Tensor) - 输入的词汇。shape为 :math:`(num\_step, batch\_size, input\_size)` 的Tensor。数据类型必须为float16。 + - **w** (Tensor) - 输入的权重。shape为 :math:`(input\_size + hidden\_size, 4 * hidden\_size)` 的Tensor。数据类型必须为float16。 + - **b** (Tensor) - 输入的偏置。shape为 :math:`(4 * hidden\_size)` 的Tensor。数据类型必须为float16或float32。 + - **seq_length** (Tensor) - 每个批次中句子的真实长度。shape为 :math:`(batch\_size, )` 的Tensor。当前仅支持None。 + - **init_h** (Tensor) - 在初始时刻的隐藏状态。shape为 :math:`(1, batch\_size, hidden\_size)` 的Tensor。数据类型必须为float16。 + - **init_c** (Tensor) - 在初始时刻的Cell状态。shape为 :math:`(1, batch\_size, hidden\_size)` 的Tensor。数据类型必须为float16。 - **输入：** + 输出： + - **y** (Tensor) - 所有时刻输出层的输出向量，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 + - **output_h** (Tensor) - 所有时刻输出层的输出向量，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型为float16。 + - **output_c** (Tensor) - 所有时刻的Cell状态的输出向量，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 + - **i** (Tensor) - 更新输入门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 + - **j** (Tensor) - 更新新门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 + - **f** (Tensor) - 更新遗忘门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型输入 `b` 相同。 + - **o** (Tensor) - 更新输出门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 + - **tanhct** (Tensor) - 更新tanh的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **x** (Tensor) - 输入的词汇。shape为 :math:`(num\_step, batch\_size, input\_size)` 的Tensor。数据类型必须为float16。 - - **w** (Tensor) - 输入的权重。shape为 :math:`(input\_size + hidden\_size, 4 * hidden\_size)` 的Tensor。数据类型必须为float16。 - - **b** (Tensor) - 输入的偏置。shape为 :math:`(4 * hidden\_size)` 的Tensor。数据类型必须为float16或float32。 - - **seq_length** (Tensor) - 每个批次中句子的真实长度。shape为 :math:`(batch\_size, )` 的Tensor。当前仅支持None。 - - **init_h** (Tensor) - 在初始时刻的隐藏状态。shape为 :math:`(1, batch\_size, hidden\_size)` 的Tensor。数据类型必须为float16。 - - **init_c** (Tensor) - 在初始时刻的Cell状态。shape为 :math:`(1, batch\_size, hidden\_size)` 的Tensor。数据类型必须为float16。 - - **输出：** - - - **y** (Tensor) - 所有时刻输出层的输出向量，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **output_h** (Tensor) - 所有时刻输出层的输出向量，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型为float16。 - - **output_c** (Tensor) - 所有时刻的Cell状态的输出向量，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **i** (Tensor) - 更新输入门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **j** (Tensor) - 更新新门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **f** (Tensor) - 更新遗忘门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型输入 `b` 相同。 - - **o** (Tensor) - 更新输出门的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **tanhct** (Tensor) - 更新tanh的权重，shape为 :math:`(num\_step, batch\_size, hidden\_size)` 的Tensor。数据类型与输入 `b` 相同。 - - **异常：** - - - **TypeError** - `cell_type` 、 `direction` 或 `activation` 不是str。 - - **TypeError** - `cell_Deep` 或 `num_proj` 不是int。 - - **TypeError** - `keep_prob` 、 `cell_clip` 或 `forget_bias` 不是float。 - - **TypeError** - `use_peehpol` 、 `time_major` 或 `is_training` 不是bool。 - - **TypeError** - `x` 、 `w` 、 `b` 、 `seq_length` 、 `init_h` 或 `init_c` 不是Tensor。 - - **TypeError** - `x` 、 `w` 、 `init_h` 或 `nit_c` 的数据类型不是float16。 - - **TypeError** - `b` 的数据类型既不是float16也不是float32。 + 异常： + - **TypeError** - `cell_type` 、 `direction` 或 `activation` 不是str。 + - **TypeError** - `cell_Deep` 或 `num_proj` 不是int。 + - **TypeError** - `keep_prob` 、 `cell_clip` 或 `forget_bias` 不是float。 + - **TypeError** - `use_peehpol` 、 `time_major` 或 `is_training` 不是bool。 + - **TypeError** - `x` 、 `w` 、 `b` 、 `seq_length` 、 `init_h` 或 `init_c` 不是Tensor。 + - **TypeError** - `x` 、 `w` 、 `init_h` 或 `nit_c` 的数据类型不是float16。 + - **TypeError** - `b` 的数据类型既不是float16也不是float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.Elu.rst b/docs/api/api_python/ops/mindspore.ops.Elu.rst index 7c42d1020f7..f7fdf1695ff 100644 --- a/docs/api/api_python/ops/mindspore.ops.Elu.rst +++ b/docs/api/api_python/ops/mindspore.ops.Elu.rst @@ -17,20 +17,16 @@ mindspore.ops.Elu ELU相关图参见 `ELU `_ 。 - **参数：** + 参数： + - **alpha** (float) - Elu的alpha值，数据类型为浮点数。目前只支持alpha等于1.0，默认值：1.0。 - - **alpha** (float) - Elu的alpha值，数据类型为浮点数。目前只支持alpha等于1.0，默认值：1.0。 + 输入： + - **input_x** (Tensor) - 用于计算Elu的任意维度的Tensor，数据类型为float16或float32。 - **输入：** + 输出： + Tensor，shape和数据类型与 `x` 相同。 - **input_x** (Tensor) - 用于计算Elu的任意维度的Tensor，数据类型为float16或float32。 - - **输出：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `alpha` 不是float。 - - **TypeError** - `x` 的数据类型既不是float16也不是float32。 - - **ValueError** - `alpha` 不等于1.0。 + 异常： + - **TypeError** - `alpha` 不是float。 + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + - **ValueError** - `alpha` 不等于1.0。 diff --git a/docs/api/api_python/ops/mindspore.ops.EmbeddingLookup.rst b/docs/api/api_python/ops/mindspore.ops.EmbeddingLookup.rst index 632f4eba86f..45a9fc9db1e 100644 --- a/docs/api/api_python/ops/mindspore.ops.EmbeddingLookup.rst +++ b/docs/api/api_python/ops/mindspore.ops.EmbeddingLookup.rst @@ -7,17 +7,14 @@ mindspore.ops.EmbeddingLookup 此算子在 `axis = 0` 上的运行与GatherV2的功能相似，只是多一个 `offset` 输入。 - **输入：** + 输入： + - **input_params** (Tensor) - shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。是一个Tensor切片。当前，只支持二维。 + - **input_indices** (Tensor) - shape为 :math:`(y_1, y_2, ..., y_S)` 的Tensor。指定输入Tensor元素的索引。当取值超出 `input_params` 在该维度的最大长度时，超出部分将返回0值。不支持负值，否则结果将未定义。其数据类型为int32或int64。 + - **offset** (int) - 指定 `input_params` 切片的偏移值。实际索引等于 `input_indices` 减去 `offset` 。 - - **input_params** (Tensor) - shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。是一个Tensor切片。当前，只支持二维。 - - **input_indices** (Tensor) - shape为 :math:`(y_1, y_2, ..., y_S)` 的Tensor。指定输入Tensor元素的索引。当取值超出 `input_params` 在该维度的最大长度时，超出部分将返回0值。不支持负值，否则结果将未定义。其数据类型为int32或int64。 - - **offset** (int) - 指定 `input_params` 切片的偏移值。实际索引等于 `input_indices` 减去 `offset` 。 - - **输出：** + 输出： + Tensor，shape为 :math:`(z_1, z_2, ..., z_N)` 的Tensor。数据类型与 `input_params` 相同。 - Tensor，shape为 :math:`(z_1, z_2, ..., z_N)` 的Tensor。数据类型与 `input_params` 相同。 - - **异常：** - - - **TypeError** - `input_indices` 的数据类型不是int。 - - **ValueError** - `input_params` 的shape长度大于2。 \ No newline at end of file + 异常： + - **TypeError** - `input_indices` 的数据类型不是int。 + - **ValueError** - `input_params` 的shape长度大于2。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Eps.rst b/docs/api/api_python/ops/mindspore.ops.Eps.rst index 710850a1d1b..4f9fa62987e 100644 --- a/docs/api/api_python/ops/mindspore.ops.Eps.rst +++ b/docs/api/api_python/ops/mindspore.ops.Eps.rst @@ -5,15 +5,12 @@ mindspore.ops.Eps 创建一个与输入数据类型和shape都相同的Tensor，元素值为对应数据类型能表达的最小值。 - **输入：** + 输入： + - **x** (Tensor) - 用于获取其数据类型能表达的最小值的任意维度的Tensor。数据类型必须为float16，float32或者float64。 - - **x** (Tensor) - 用于获取其数据类型能表达的最小值的任意维度的Tensor。数据类型必须为float16，float32或者float64。 + 输出： + Tensor，具有与 `x` 相同的数据类型和shape，填充了 `x` 数据类型的最小值。 - **输出：** - - Tensor，具有与 `x` 相同的数据类型和shape，填充了 `x` 数据类型的最小值。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16或者float32。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16或者float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_adaptive_avg_pool2d.rst b/docs/api/api_python/ops/mindspore.ops.func_adaptive_avg_pool2d.rst index 03e77ab7d8b..e267d487fb6 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_adaptive_avg_pool2d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_adaptive_avg_pool2d.rst @@ -21,29 +21,26 @@ mindspore.ops.adaptive_avg_pool2d * (w_{end}- w_{start})} \end{align} - **参数：** + 参数： + - **input_x** (Tensor) - adaptive_avg_pool2d的输入，为三维或四维的Tensor，数据类型为float16、float32或者float64。 + - **output_size** (Union[int, tuple]) - 输出特征图的尺寸为H * W。可以是int类型的H和W组成的tuple，或代表相同H和W的一个int值，或None，如果是None，则意味着输出大小与输入相同。 - - **input_x** (Tensor) - adaptive_avg_pool2d的输入，为三维或四维的Tensor，数据类型为float16、float32或者float64。 - - **output_size** (Union[int, tuple]) - 输出特征图的尺寸为H * W。可以是int类型的H和W组成的tuple，或代表相同H和W的一个int值，或None，如果是None，则意味着输出大小与输入相同。 + 返回： + Tensor，数据类型与 `input_x` 相同。 - **返回：** + 输出的shape为 `input_x_shape[:len(input_x_shape) - len(out_shape)] + out_shape` 。 - Tensor，数据类型与 `input_x` 相同。 + .. math:: + out\_shape = \begin{cases} + input\_x\_shape[-2] + output\_size[1], & \text{if output_size is (None, w);}\\ + output\_size[0] + input\_x\_shape[-1], & \text{if output_size is (h, None);}\\ + input\_x\_shape[-2:], & \text{if output_size is (None, None);}\\ + (h, h), & \text{if output_size is h;}\\ + (h, w), & \text{if output_size is (h, w)} + \end{cases} - 输出的shape为 `input_x_shape[:len(input_x_shape) - len(out_shape)] + out_shape` 。 - - .. math:: - out\_shape = \begin{cases} - input\_x\_shape[-2] + output\_size[1], & \text{if output_size is (None, w);}\\ - output\_size[0] + input\_x\_shape[-1], & \text{if output_size is (h, None);}\\ - input\_x\_shape[-2:], & \text{if output_size is (None, None);}\\ - (h, h), & \text{if output_size is h;}\\ - (h, w), & \text{if output_size is (h, w)} - \end{cases} - - **异常：** - - - **ValueError** - 如果 `output_size` 是tuple，并且 `output_size` 的长度不是2。 - - **ValueError** - 如果 `input_x` 的维度小于或等于 `output_size` 的维度。 - - **TypeError** - 如果 `input_x` 不是Tensor。 - - **TypeError** - 如果 `input_x` 的数据类型不是float16、float32或者float64。 + 异常： + - **ValueError** - 如果 `output_size` 是tuple，并且 `output_size` 的长度不是2。 + - **ValueError** - 如果 `input_x` 的维度小于或等于 `output_size` 的维度。 + - **TypeError** - 如果 `input_x` 不是Tensor。 + - **TypeError** - 如果 `input_x` 的数据类型不是float16、float32或者float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool2d.rst b/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool2d.rst index 24fc81fa07e..92fcb162da7 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool2d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool2d.rst @@ -22,23 +22,20 @@ mindspore.ops.adaptive_max_pool2d .. note:: Ascend平台input_x参数仅支持float16类型。 - **参数：** + 参数： + - **input_x** (Tensor) - adaptive_max_pool2d的输入，为三维或四维的Tensor，数据类型为float16、float32或者float64。 + - **output_size** (Union[int, tuple]) - 输出特征图的尺寸为H * W。可以是int类型的H和W组成的tuple，或代表相同H和W的一个int值，或None，如果是None，则意味着输出大小与输入相同。 + - **return_indices** (bool) - 如果为True，输出最大值的索引，默认值为False。 - - **input_x** (Tensor) - adaptive_max_pool2d的输入，为三维或四维的Tensor，数据类型为float16、float32或者float64。 - - **output_size** (Union[int, tuple]) - 输出特征图的尺寸为H * W。可以是int类型的H和W组成的tuple，或代表相同H和W的一个int值，或None，如果是None，则意味着输出大小与输入相同。 - - **return_indices** (bool) - 如果为True，输出最大值的索引，默认值为False。 + 返回： + Tensor，数据类型与 `input_x` 相同。 - **返回：** + 输出的shape为 `input_x_shape[:len(input_x_shape) - len(out_shape)] + out_shape` 。 - Tensor，数据类型与 `input_x` 相同。 - - 输出的shape为 `input_x_shape[:len(input_x_shape) - len(out_shape)] + out_shape` 。 - - **异常：** - - - **TypeError** - `input_x` 不是Tensor。 - - **TypeError** - `input_x` 中的数据不是float16, float32, float64. - - **TypeError** - `output_size` 不是int或者tuple。 - - **TypeError** - `return_indices` 不是bool。 - - **ValueError** - `output_size` 是tuple，但大小不是2。 - - **ValueError** - `input_x` 的维度不是CHW或者NCHW。 + 异常： + - **TypeError** - `input_x` 不是Tensor。 + - **TypeError** - `input_x` 中的数据不是float16, float32, float64. + - **TypeError** - `output_size` 不是int或者tuple。 + - **TypeError** - `return_indices` 不是bool。 + - **ValueError** - `output_size` 是tuple，但大小不是2。 + - **ValueError** - `input_x` 的维度不是CHW或者NCHW。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool3d.rst b/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool3d.rst index d2f8e4c0855..f7bd40e1a0b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool3d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_adaptive_max_pool3d.rst @@ -7,20 +7,17 @@ mindspore.ops.adaptive_max_pool3d 对于任何输入尺寸，输出的大小为 :math:`(D, H, W)` ，其中输出特征的数量与输入特征的数量相同。 - **参数：** + 参数： + - **x** (Tensor) - shape为 :math:`(C, D, H, W)` 或 :math:`(N，C, D, H, W)` 的Tensor，支持的数据类型包括int8、int16、int32、int64、uint8、uint16、uint32、uint64、float16、float32、float64。 + - **output_size** (Union[int, tuple]) - 表示输出特征图的尺寸，输入可以是个tuple :math:`(D, H, W)`，也可以是一个int值D来表示输出尺寸为 :math:`(D, D, D)` 。:math:`D` ， :math:`H` 和 :math:`W` 可以是int型整数或者None，其中None表示输出大小与对应的输入的大小相同。 + - **return_indices** (bool) - 如果 `return_indices` 为True，将会输出最大值对应的索引，否则不输出索引。默认值为False。 - - **x** (Tensor) - shape为 :math:`(C, D, H, W)` 或 :math:`(N，C, D, H, W)` 的Tensor，支持的数据类型包括int8、int16、int32、int64、uint8、uint16、uint32、uint64、float16、float32、float64。 - - **output_size** (Union[int, tuple]) - 表示输出特征图的尺寸，输入可以是个tuple :math:`(D, H, W)`，也可以是一个int值D来表示输出尺寸为 :math:`(D, D, D)` 。:math:`D` ， :math:`H` 和 :math:`W` 可以是int型整数或者None，其中None表示输出大小与对应的输入的大小相同。 - - **return_indices** (bool) - 如果 `return_indices` 为True，将会输出最大值对应的索引，否则不输出索引。默认为False。 + 返回： + - **y** (Tensor) - Tensor，与输入 `x` 的数据类型和维度相同。 + - **argmax** (Tensor) - Tensor，最大值对应的索引，数据类型为int32，并与 `y` 的shape相同。仅当 `return_indices` 为True的时候才返回该值。 - **返回：** - - - **y** (Tensor) - Tensor，与输入 `x` 的数据类型和维度相同。 - - **argmax** (Tensor) - Tensor，最大值对应的索引，数据类型为int32，并与 `y` 的shape相同。仅当 `return_indices` 为True的时候才返回该值。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **ValueError** - `x` 的维度不是4D或者5D。 - - **TypeError** - `x` 的数据类型不是int8、int16、int32、int64、uint8、uint16、uint32、uint64、float16、float32、float64其中之一。 - - **ValueError** - `output_size` 不是一个int整数或者shape为(3,)的tuple。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **ValueError** - `x` 的维度不是4D或者5D。 + - **TypeError** - `x` 的数据类型不是int8、int16、int32、int64、uint8、uint16、uint32、uint64、float16、float32、float64其中之一。 + - **ValueError** - `output_size` 不是一个int整数或者shape为(3,)的tuple。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_add.rst b/docs/api/api_python/ops/mindspore.ops.func_add.rst index 55d1f04c990..1bf07eafc33 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_add.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_add.rst @@ -15,15 +15,12 @@ mindspore.ops.add - 当输入是两个Tensor时，它们的数据类型不能同时是bool，并保证其shape可以广播。 - 当输入是一个Tensor和一个Scalar时，Scalar只能是一个常数。 - **参数：** + 参数： + - **x** (Union[Tensor, number.Number, bool]) - 第一个输入，是一个number.Number、bool值或数据类型为 `number `_ 或 `bool_ `_ 的Tensor。 + - **y** (Union[Tensor, number.Number, bool]) - 第二个输入，当第一个输入是Tensor时，第二个输入应该是一个number.Number或bool值，或数据类型为number或bool_的Tensor。当第一个输入是Scalar时，第二个输入必须是数据类型为number或bool_的Tensor。 - - **x** (Union[Tensor, number.Number, bool]) - 第一个输入，是一个number.Number、bool值或数据类型为 `number `_ 或 `bool_ `_ 的Tensor。 - - **y** (Union[Tensor, number.Number, bool]) - 第二个输入，当第一个输入是Tensor时，第二个输入应该是一个number.Number或bool值，或数据类型为number或bool_的Tensor。当第一个输入是Scalar时，第二个输入必须是数据类型为number或bool_的Tensor。 + 返回： + Tensor，shape与输入 `x`，`y` 广播后的shape相同，数据类型为两个输入中精度较高的类型。 - **返回：** - - Tensor，shape与输入 `x`，`y` 广播后的shape相同，数据类型为两个输入中精度较高的类型。 - - **异常：** - - - **TypeError** - `x` 和 `y` 不是Tensor、number.Number或bool。 + 异常： + - **TypeError** - `x` 和 `y` 不是Tensor、number.Number或bool。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_addn.rst b/docs/api/api_python/ops/mindspore.ops.func_addn.rst index 5cdbe0512cc..fd666197de1 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_addn.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_addn.rst @@ -7,15 +7,12 @@ mindspore.ops.addn 所有输入Tensor必须具有相同的shape。 - **参数：** + 参数： + - **x** (Union(tuple[Tensor], list[Tensor])) - Tensor组成的tuble或list，类型为 `bool_ `_ 或 `number `_ 。 - - **x** (Union(tuple[Tensor], list[Tensor])) - Tensor组成的tuble或list，类型为 `bool_ `_ 或 `number `_ 。 + 返回： + Tensor，与 `x` 的每个Tensor具有相同的shape和数据类型。 - **返回：** - - Tensor，与 `x` 的每个Tensor具有相同的shape和数据类型。 - - **异常：** - - - **TypeError** - `x` 既不是tuple，也不是list。 - - **ValueError** - `x` 中存在shape不同的Tensor。 + 异常： + - **TypeError** - `x` 既不是tuple，也不是list。 + - **ValueError** - `x` 中存在shape不同的Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_affine_grid.rst b/docs/api/api_python/ops/mindspore.ops.func_affine_grid.rst index fb23e4b74eb..abf52489ee3 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_affine_grid.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_affine_grid.rst @@ -5,20 +5,17 @@ mindspore.ops.affine_grid 给定一批仿射矩阵 theta，生成 2D 或 3D 流场（采样网格）。 - **参数：** + 参数： + - **theta** (Tensor) - 仿射矩阵输入，其形状为 (N, 2, 3) 用于 2D 或 (N, 3, 4) 用于 3D。 + - **output_size** (tuple[int]) - 目标输出图像大小。 其值为 (N, C, H, W) 用于 2D 或 (N, C, D, H, W) 用于 3D。示例：`(32, 3, 24, 24)`。 + - **align_corners** (bool) - 在几何上，我们将输入的像素视为正方形而不是点。如果设置为True，则极值 -1 和 1 被认为是指输入角像素的中心点。如果设置为False，则它们被认为是指输入角像素的角点，从而使采样与分辨率无关。默认值：False。 - - **theta** (Tensor) - 仿射矩阵输入，其形状为 (N, 2, 3) 用于 2D 或 (N, 3, 4) 用于 3D。 - - **output_size** (tuple[int]) - 目标输出图像大小。 其值为 (N, C, H, W) 用于 2D 或 (N, C, D, H, W) 用于 3D。示例：`(32, 3, 24, 24)`。 - - **align_corners** (bool) - 在几何上，我们将输入的像素视为正方形而不是点。如果设置为True，则极值 -1 和 1 被认为是指输入角像素的中心点。如果设置为False，则它们被认为是指输入角像素的角点，从而使采样与分辨率无关。默认值：False。 + 返回： + Tensor，其数据类型与 `theta` 相同，其形状为 (N, H, W, 2) 用于 2D 或 (N, D, H, W, 3) 用于 3D。 - **返回：** - - Tensor，其数据类型与 `theta` 相同，其形状为 (N, H, W, 2) 用于 2D 或 (N, D, H, W, 3) 用于 3D。 - - **异常：** - - - **TypeError** - `theta` 不是Tensor或 `output_size` 不是tuple。 - - **ValueError** - `theta` 的形状不是 (N, 2, 3) 或 (N, 3, 4)。 - - **ValueError** - `output_size` 的长度不是 4 或 5。 - - **ValueError** - `theta` 的形状是 (N, 2, 3)，`output_size` 的长度却不是4； `theta` 的形状是 (N, 3, 4)，`output_size` 的长度却不是5。 - - **ValueError** - `output_size` 的第一个值不等于 `theta` 的第一维的长度。 + 异常： + - **TypeError** - `theta` 不是Tensor或 `output_size` 不是tuple。 + - **ValueError** - `theta` 的形状不是 (N, 2, 3) 或 (N, 3, 4)。 + - **ValueError** - `output_size` 的长度不是 4 或 5。 + - **ValueError** - `theta` 的形状是 (N, 2, 3)，`output_size` 的长度却不是4； `theta` 的形状是 (N, 3, 4)，`output_size` 的长度却不是5。 + - **ValueError** - `output_size` 的第一个值不等于 `theta` 的第一维的长度。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_arange.rst b/docs/api/api_python/ops/mindspore.ops.func_arange.rst index 0c054dddd22..84ef9a03662 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_arange.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_arange.rst @@ -5,18 +5,15 @@ mindspore.ops.arange 根据给定的范围返回指定均匀间隔的数据。 - **参数：** + 参数： + - **start** (Union[int, float]) - 指定范围的起始值，范围包含该值。类型为int或float。 + - **stop** (Union[int, float]) - 指定范围的结束值，范围不包含该值。类型为int或float。 + - **step** (Union[int, float]) - 指定取值的间隔。类型为int或float。 + - **rtype** (Union[mindspore.dtype, str]) - 指定返回数据的类型，如果不指定，则会根据 `start` 、 `stop` 、 `step` 的值推断类型。 - - **start** (Union[int, float]) - 指定范围的起始值，范围包含该值。类型为int或float。 - - **stop** (Union[int, float]) - 指定范围的结束值，范围不包含该值。类型为int或float。 - - **step** (Union[int, float]) - 指定取值的间隔。类型为int或float。 - - **rtype** (Union[mindspore.dtype, str]) - 指定返回数据的类型，如果不指定，则会根据 `start` 、 `stop` 、 `step` 的值推断类型。 + 返回： + Tensor，值是均匀间隔的数据，类型为给定或推断的结果。 - **返回：** - - Tensor，值是均匀间隔的数据，类型为给定或推断的结果。 - - **异常：** - - - **TypeError** - `start` 、 `stop` 、 `step` 的类型不是int或float。 - - **ValueError** - `start` 的值大于等于 `stop` 。 \ No newline at end of file + 异常： + - **TypeError** - `start` 、 `stop` 、 `step` 的类型不是int或float。 + - **ValueError** - `start` 的值大于等于 `stop` 。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_argmin.rst b/docs/api/api_python/ops/mindspore.ops.func_argmin.rst index f878af62a6d..426bc3188fb 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_argmin.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_argmin.rst @@ -7,15 +7,12 @@ mindspore.ops.argmin 如果输入Tensor的shape为 :math:`(x_1, ..., x_N)` ，则输出Tensor的shape为 :math:`(x_1, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。 - **参数：** + 参数： + - **x** (Tensor) - shape非空，任意维度的Tensor。 + - **axis** (int) - 指定计算轴。默认值：-1。 - - **x** (Tensor) - shape非空，任意维度的Tensor。 - - **axis** (int) - 指定计算轴。默认值：-1。 + 返回： + Tensor，输出为指定轴上输入Tensor最小值的索引。 - **返回：** - - Tensor，输出为指定轴上输入Tensor最小值的索引。 - - **异常：** - - - **TypeError** - `axis` 不是int。 + 异常： + - **TypeError** - `axis` 不是int。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_assign_sub.rst b/docs/api/api_python/ops/mindspore.ops.func_assign_sub.rst index 3f533152dcf..a78afffad92 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_assign_sub.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_assign_sub.rst @@ -10,16 +10,13 @@ mindspore.ops.assign_sub .. Note:: 由于 `variable` 类型为 `Parameter` ，其数据类型不能改变。因此只允许 `value` 的数据类型转变为 `variable` 的数据类型。而且由于不同设备支持的转换类型会有所不同，推荐在使用此操作时使用相同的数据类型。 - **参数：** + 参数： + - **variable** (Parameter) - 待更新的网络参数，shape: :math:`(N,*)` ，其中 :math:`*` 表示任何数量的附加维度。其轶应小于8。 + - **value** (Union[numbers.Number, Tensor]) - 从 `variable` 减去的值。如果类型为Tensor则应与 `variable` 的shape相同。使用此操作时推荐使用相同的数据类型。 - - **variable** (Parameter) - 待更新的网络参数，shape: :math:`(N,*)` ，其中 :math:`*` 表示任何数量的附加维度。其轶应小于8。 - - **value** (Union[numbers.Number, Tensor]) - 从 `variable` 减去的值。如果类型为Tensor则应与 `variable` 的shape相同。使用此操作时推荐使用相同的数据类型。 + 返回： + Tensor，shape和数据类型与 `variable` 相同。 - **返回：** - - Tensor，shape和数据类型与 `variable` 相同。 - - **异常：** - - - **TypeError** - `value` 不是标量或Tensor。 - - **RuntimeError** - `variable` 与 `value` 之间的类型转换不被支持。 + 异常： + - **TypeError** - `value` 不是标量或Tensor。 + - **RuntimeError** - `variable` 与 `value` 之间的类型转换不被支持。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_atan2.rst b/docs/api/api_python/ops/mindspore.ops.func_atan2.rst index 8f3b10a373f..e45e03ea39b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_atan2.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_atan2.rst @@ -8,16 +8,13 @@ mindspore.ops.atan2 返回 :math:`\theta\ \in\ [-\pi, \pi]` ，使得 :math:`x = r*\sin(\theta), y = r*\cos(\theta)` ， 其中 :math:`r = \sqrt{x^2 + y^2}` 。 输入 `x` 和 `y` 会通过隐式数据类型转换使数据类型保持一致。如果数据类型不同，低精度的数据类型会被转换到高精度的数据类型。 - **参数：** + 参数： + - **x** (Tensor) - 输入Tensor，shape: :math:`(N,*)` ，其中 :math:`*` 表示任何数量的附加维度。 + - **y** (Tensor) - 输入Tensor，shape应能在广播后与 `x` 相同，或 `x` 的shape在广播后与 `y` 相同。 - - **x** (Tensor) - 输入Tensor，shape: :math:`(N,*)` ，其中 :math:`*` 表示任何数量的附加维度。 - - **y** (Tensor) - 输入Tensor，shape应能在广播后与 `x` 相同，或 `x` 的shape在广播后与 `y` 相同。 + 返回： + Tensor，与广播后的输入shape相同，和 `x` 数据类型相同。 - **返回：** - - Tensor，与广播后的输入shape相同，和 `x` 数据类型相同。 - - **异常：** - - - **TypeError** - `x` 或 `y` 不是Tensor。 - - **RuntimeError** - `x` 与 `y` 之间的数据类型转换不被支持 + 异常： + - **TypeError** - `x` 或 `y` 不是Tensor。 + - **RuntimeError** - `x` 与 `y` 之间的数据类型转换不被支持 diff --git a/docs/api/api_python/ops/mindspore.ops.func_avg_pool2d.rst b/docs/api/api_python/ops/mindspore.ops.func_avg_pool2d.rst index afad18429f4..05a8deeaded 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_avg_pool2d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_avg_pool2d.rst @@ -16,26 +16,23 @@ mindspore.ops.avg_pool2d - 在Ascend上，`kernel_size` 的高度和宽度取值为[1, 255]范围内的正整数。 其高度和宽度相乘小于256。 - 由于指令限制，`strides` 的取值为[1, 63]范围内的正整数。 - **参数：** + 参数： + - **x** (Tensor) - 输入shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。 + - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，可以是单个整数表示池化核高度和宽度，或者整数tuple分别表示池化核高度和宽度。默认值：1。 + - **strides** (Union[int, tuple[int]]) - 池化操作的移动步长，可以是单个整数表示高度和宽度方向的移动步长，或者整数tuple分别表示高度和宽度方向的移动步长。默认值：1。 + - **pad_mode** (str) - 指定池化填充模式，取值为'same'或'valid'，不区分大小写。默认值：'valid'。 - - **x** (Tensor) - 输入shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。 - - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，可以是单个整数表示池化核高度和宽度，或者整数tuple分别表示池化核高度和宽度。默认值：1。 - - **strides** (Union[int, tuple[int]]) - 池化操作的移动步长，可以是单个整数表示高度和宽度方向的移动步长，或者整数tuple分别表示高度和宽度方向的移动步长。默认值：1。 - - **pad_mode** (str) - 指定池化填充模式，取值为'same'或'valid'，不区分大小写。默认值：'valid'。 + - **same** - 输出的高度和宽度分别与输入整除 `strides` 后的值相同。 + - **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。 - - **same** - 输出的高度和宽度分别与输入整除 `strides` 后的值相同。 - - **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。 + - **data_format** (str) - 指定输入和输出的数据格式。取值为'NHWC'或'NCHW'。默认值：'NCHW'。 - - **data_format** (str) - 指定输入和输出的数据格式。取值为'NHWC'或'NCHW'。默认值：'NCHW'。 + 返回： + Tensor，shape为 :math:`(N,C_{out},H_{out},W_{out})` 。 - **返回：** - - Tensor，shape为 :math:`(N,C_{out},H_{out},W_{out})` 。 - - **异常：** - - - **TypeError** - `kernel_size` 或 `strides` 既不是int也不是tuple。 - - **ValueError** - `kernel_size` 或 `strides` 小于1。 - - **ValueError** - `pad_mode` 既不是'valid'，也不是'same'，不区分大小写。 - - **ValueError** - `data_format` 既不是'NCHW'也不是'NHWC'。 - - **ValueError** - `x` 的shape长度不等于4。 \ No newline at end of file + 异常： + - **TypeError** - `kernel_size` 或 `strides` 既不是int也不是tuple。 + - **ValueError** - `kernel_size` 或 `strides` 小于1。 + - **ValueError** - `pad_mode` 既不是'valid'，也不是'same'，不区分大小写。 + - **ValueError** - `data_format` 既不是'NCHW'也不是'NHWC'。 + - **ValueError** - `x` 的shape长度不等于4。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst b/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst index 3a1baec480a..c042715517c 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_batch_dot.rst @@ -8,25 +8,21 @@ mindspore.ops.batch_dot .. math:: output = x1[batch, :]* x2[batch, :] - **参数：** + 参数： + - **x1** (Tensor) - 第一个输入Tensor，数据类型为float32且 `x1` 的秩必须大于或等于2。 + - **x2** (Tensor) - 第二个输入Tensor，数据类型为float32。 `x2` 的数据类型应与 `x1` 相同，`x2` 的秩必须大于或等于2。 + - **axes** (Union[int, tuple(int), list(int)]) - 指定为单值或长度为2的tuple和list，分别指定 `a` 和 `b` 的维度。如果传递了单个值 `N`，则自动从输入 `a` 的shape中获取最后N个维度，从输入 `b` 的shape中获取最后N个维度，分别作为每个维度的轴。默认值：None。 - - **x1** (Tensor) - 第一个输入Tensor，数据类型为float32且 `x1` 的秩必须大于或等于2。 - - **x2** (Tensor) - 第二个输入Tensor，数据类型为float32。 `x2` 的数据类型应与 `x1` 相同，`x2` 的秩必须大于或等于2。 - - **axes** (Union[int, tuple(int), list(int)]) - 指定为单值或长度为2的tuple和list，分别指定 `a` 和 `b` 的维度。如果传递了单个值 `N`，则自动从输入 `a` 的shape中获取最后N个维度，从输入 `b` 的shape中获取最后N个维度，分别作为每个维度的轴。默认值：None。 + 返回： + Tensor， `x1` 和 `x2` 的批量点积。例如：输入 `x1` 的shape为(batch, d1, axes, d2)，`x2` shape为(batch, d3, axes, d4)，则输出shape为(batch, d1, d2, d3, d4)，其中d1和d2表示任意数字。 - **返回：** - - Tensor， `x1` 和 `x2` 的批量点积。例如：输入 `x1` 的shape为(batch, d1, axes, d2)，`x2` shape为(batch, d3, axes, d4)，则输出shape为(batch, d1, d2, d3, d4)，其中d1和d2表示任意数字。 - - **异常：** - - - **TypeError** - `x1` 和 `x2` 的类型不相同。 - - **TypeError** - `x1` 或 `x2` 的数据类型不是float32。 - - **ValueError** - `x1` 或 `x2` 的秩小于2。 - - **ValueError** - 在轴中使用了代表批量的维度。 - - **ValueError** - `axes` 的长度小于2。 - - **ValueError** - `axes` 不是其一：None，int，或(int, int)。 - - **ValueError** - 如果 `axes` 为负值，低于输入数组的维度。 - - **ValueError** - 如果 `axes` 的值高于输入数组的维度。 - - **ValueError** - `x1` 和 `x2` 的批处理大小不相同。 - \ No newline at end of file + 异常： + - **TypeError** - `x1` 和 `x2` 的类型不相同。 + - **TypeError** - `x1` 或 `x2` 的数据类型不是float32。 + - **ValueError** - `x1` 或 `x2` 的秩小于2。 + - **ValueError** - 在轴中使用了代表批量的维度。 + - **ValueError** - `axes` 的长度小于2。 + - **ValueError** - `axes` 不是其一：None，int，或(int, int)。 + - **ValueError** - 如果 `axes` 为负值，低于输入数组的维度。 + - **ValueError** - 如果 `axes` 的值高于输入数组的维度。 + - **ValueError** - `x1` 和 `x2` 的批处理大小不相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_batch_to_space_nd.rst b/docs/api/api_python/ops/mindspore.ops.func_batch_to_space_nd.rst index 137be3c8e7d..ebc6c84baa8 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_batch_to_space_nd.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_batch_to_space_nd.rst @@ -18,22 +18,19 @@ mindspore.ops.batch_to_space_nd :math:`w' = w*block\_shape[1]-crops[1][0]-crops[1][1]` - **参数：** + 参数： + - **input_x** (Tensor) - 输入张量，必须大于或者等于四维（Ascend平台必须为4维）。批次维度需能被 `block_shape` 整除。支持数据类型float16和float32。 + - **block_shape** (list[int], tuple[int], int) - 分割批次维度的块的数量，取值需大于1。 + - **crops** (tuple, list) - 空间维度的裁剪大小，包含两个长度为2的list，分别对应空间维度H和W。取值需大于或等于0，同时要求 `input_shape[i+2] * block_shape[i] > crops[i][0] + crops[i][1]` 。 - - **input_x** (Tensor) - 输入张量，必须大于或者等于四维（Ascend平台必须为4维）。批次维度需能被 `block_shape` 整除。支持数据类型float16和float32。 - - **block_shape** (list[int], tuple[int], int) - 分割批次维度的块的数量，取值需大于1。 - - **crops** (tuple, list) - 空间维度的裁剪大小，包含两个长度为2的list，分别对应空间维度H和W。取值需大于或等于0，同时要求 `input_shape[i+2] * block_shape[i] > crops[i][0] + crops[i][1]` 。 + 返回： + Tensor，经过划分排列之后的结果。 - **返回：** - - Tensor，经过划分排列之后的结果。 - - **异常：** - - - **TypeError** - 如果 `block_shape` 不是 list, tuple 或者 int。 - - **TypeError** - 如果 `crops` 不是 list 或者 tuple。 - - **ValueError** - 如果当 `block_shape` 为 list 或 tuple， `block_shape` 不是一维。 - - **ValueError** - 如果 `block_shape` 或 `crops` 长度不是2。 - - **ValueError** - 如果 `block_shape` 的元素不是大于一的整数。 - - **ValueError** - 如果 `crops` 的形状不是 (M, 2), 其中 M 为 `block_shape` 的长度。 - - **ValueError** - 如果 `crops` 的元素不是非负的整数。 + 异常： + - **TypeError** - 如果 `block_shape` 不是 list, tuple 或者 int。 + - **TypeError** - 如果 `crops` 不是 list 或者 tuple。 + - **ValueError** - 如果当 `block_shape` 为 list 或 tuple， `block_shape` 不是一维。 + - **ValueError** - 如果 `block_shape` 或 `crops` 长度不是2。 + - **ValueError** - 如果 `block_shape` 的元素不是大于一的整数。 + - **ValueError** - 如果 `crops` 的形状不是 (M, 2), 其中 M 为 `block_shape` 的长度。 + - **ValueError** - 如果 `crops` 的元素不是非负的整数。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bernoulli.rst b/docs/api/api_python/ops/mindspore.ops.func_bernoulli.rst index 16e05a97722..9394709f013 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bernoulli.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bernoulli.rst @@ -9,20 +9,17 @@ mindspore.ops.bernoulli out_{i} \sim Bernoulli(p_{i}) - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor，其数据类型为int8, uint8, int16, int32，int64，bool, float32或float64。 + - **p** (Union[Tensor, float], optional) - shape需要可以被广播到当前Tensor。其数据类型为float32或float64。`p` 中每个值代表输出Tensor中对应广播位置为1的概率，数值范围在0到1之间。默认值：0.5。 + - **seed** (int, optional) - 随机种子，用于生成随机数，数值范围是-1或正整数。默认值：-1，代表取当前时间戳。 - - **x** (Tensor) - 任意维度的Tensor，其数据类型为int8, uint8, int16, int32，int64，bool, float32或float64。 - - **p** (Union[Tensor, float], optional) - shape需要可以被广播到当前Tensor。其数据类型为float32或float64。`p` 中每个值代表输出Tensor中对应广播位置为1的概率，数值范围在0到1之间。默认值：0.5。 - - **seed** (int, optional) - 随机种子，用于生成随机数，数值范围是-1或正整数。默认值：-1，代表取当前时间戳。 + 返回： + - **output** (Tensor) - shape和数据类型与 `x` 相同。 - **返回：** - - - **output** (Tensor) - shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 的数据类型不在int8、uint8、int16、int32、int64、bool、float32和float64中。 - - **TypeError** - `p` 的数据类型既不是float32也不是float64。 - - **TypeError** - `seed` 不是int。 - - **ValueError** - `seed` 是负数且不为-1。 - - **ValueError** - `p` 数值范围不在0到1之间。 + 异常： + - **TypeError** - `x` 的数据类型不在int8、uint8、int16、int32、int64、bool、float32和float64中。 + - **TypeError** - `p` 的数据类型既不是float32也不是float64。 + - **TypeError** - `seed` 不是int。 + - **ValueError** - `seed` 是负数且不为-1。 + - **ValueError** - `p` 数值范围不在0到1之间。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_i0.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_i0.rst index 20197f065a6..ae0f111147f 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_i0.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_i0.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_i0 逐元素计算并返回输入Tensor的Bessel i0函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_i0e.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_i0e.rst index 5fb1f5ea51c..de3522c8ec0 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_i0e.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_i0e.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_i0e 逐元素计算并返回输入Tensor的Bessel i0e函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_i1.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_i1.rst index 1cbb6163f21..41a348a1780 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_i1.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_i1.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_i1 逐元素计算并返回输入Tensor的Bessel i1函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_i1e.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_i1e.rst index 0f3ea38dccc..33fa5c852a9 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_i1e.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_i1e.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_i1e 逐元素计算并返回输入Tensor的Bessel i1e函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_j0.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_j0.rst index 3c07758043c..4f7153097d5 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_j0.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_j0.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_j0 逐元素计算并返回输入Tensor的Bessel j0函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_j1.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_j1.rst index cbc883e43e6..f89973c7329 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_j1.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_j1.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_j1 逐元素计算并返回输入Tensor的Bessel j1函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_k0.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_k0.rst index 7de6d6dd96a..0b9d849ca1d 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_k0.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_k0.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_k0 逐元素计算并返回输入Tensor的Bessel k0函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_k0e.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_k0e.rst index 903994d5acf..de5e6003066 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_k0e.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_k0e.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_k0e 逐元素计算并返回输入Tensor的Bessel k0e函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_k1.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_k1.rst index 08e57346880..7cacfc7a17f 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_k1.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_k1.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_k1 逐元素计算并返回输入Tensor的Bessel k1函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_k1e.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_k1e.rst index 29cf81d8ba3..2d2d37ba21e 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_k1e.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_k1e.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_k1e 逐元素计算并返回输入Tensor的Bessel k1e函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_y0.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_y0.rst index f704f618627..6ff641167e1 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_y0.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_y0.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_y0 逐元素计算并返回输入Tensor的Bessel y0函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bessel_y1.rst b/docs/api/api_python/ops/mindspore.ops.func_bessel_y1.rst index 0007b1df7f2..e606d2e76dd 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bessel_y1.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bessel_y1.rst @@ -5,15 +5,12 @@ mindspore.ops.bessel_y1 逐元素计算并返回输入Tensor的Bessel y1函数值。 - **参数：** + 参数： + - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 - - **x** (Tensor) - 任意维度的Tensor。数据类型应为float16，float32或float64。 + 返回： + Tensor，shape和数据类型与 `x` 相同。 - **返回：** - - Tensor，shape和数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16，float32或float64。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16，float32或float64。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_binary_cross_entropy_with_logits.rst b/docs/api/api_python/ops/mindspore.ops.func_binary_cross_entropy_with_logits.rst index 53862fc05b5..527ccc0d16a 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_binary_cross_entropy_with_logits.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_binary_cross_entropy_with_logits.rst @@ -23,22 +23,19 @@ mindspore.ops.binary_cross_entropy_with_logits :math:`\ell` 表示计算损失的方法。有三种方法：第一种方法是直接提供损失值，第二种方法是计算所有损失的平均值，第三种方法是计算所有损失的总和。 - **参数：** + 参数： + - **logits** (Tensor) - 输入预测值，任意维度的Tensor。其数据类型为float16或float32。 + - **label** (Tensor) - 输入目标值，shape与 `logits` 相同。数据类型为float16或float32。 + - **weight** (Tensor) - 指定每个批次二值交叉熵的权重。支持广播，使其shape与 `logits` 的shape保持一致。数据类型必须为float16或float32。 + - **pos_weight** (Tensor) - 指定正类的权重。是一个长度等于分类数的向量。支持广播，使其shape与 `logits` 的shape保持一致。数据类型必须为float16或float32。 + - **reduction** (str) - 指定用于输出结果的计算方式。取值为 'mean' 、 'sum' 或 'none' ，不区分大小写。如果 'none' ，则不执行 `reduction` 。默认值：'mean' 。 - - **logits** (Tensor) - 输入预测值，任意维度的Tensor。其数据类型为float16或float32。 - - **label** (Tensor) - 输入目标值，shape与 `logits` 相同。数据类型为float16或float32。 - - **weight** (Tensor) - 指定每个批次二值交叉熵的权重。支持广播，使其shape与 `logits` 的shape保持一致。数据类型必须为float16或float32。 - - **pos_weight** (Tensor) - 指定正类的权重。是一个长度等于分类数的向量。支持广播，使其shape与 `logits` 的shape保持一致。数据类型必须为float16或float32。 - - **reduction** (str) - 指定用于输出结果的计算方式。取值为 'mean' 、 'sum' 或 'none' ，不区分大小写。如果 'none' ，则不执行 `reduction` 。默认值：'mean' 。 + 返回： + Tensor或Scalar，如果 `reduction` 为 'none' ，则为shape和数据类型与输入 `logits` 相同的Tensor。否则，输出为Scalar。 - **返回：** - - Tensor或Scalar，如果 `reduction` 为 'none' ，则为shape和数据类型与输入 `logits` 相同的Tensor。否则，输出为Scalar。 - - **异常：** - - - **TypeError** - 输入 `logits` ， `label` ， `weight` ， `pos_weight` 不为Tensor。 - - **TypeError** - 输入 `logits` ， `label` ， `weight` ， `pos_weight` 的数据类型既不是float16也不是float32。 - - **TypeError** - 输入 `reduction` 输入数据类型不为string。 - - **ValueError** - `weight` 或 `pos_weight` 不能广播到shape为 `logits` 的Tensor。 - - **ValueError** - `reduction` 不为 'none' 、 'mean' 或 'sum' 。 \ No newline at end of file + 异常： + - **TypeError** - 输入 `logits` ， `label` ， `weight` ， `pos_weight` 不为Tensor。 + - **TypeError** - 输入 `logits` ， `label` ， `weight` ， `pos_weight` 的数据类型既不是float16也不是float32。 + - **TypeError** - 输入 `reduction` 输入数据类型不为string。 + - **ValueError** - `weight` 或 `pos_weight` 不能广播到shape为 `logits` 的Tensor。 + - **ValueError** - `reduction` 不为 'none' 、 'mean' 或 'sum' 。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_bitwise_and.rst b/docs/api/api_python/ops/mindspore.ops.func_bitwise_and.rst index a1a2a83723f..0037f36f317 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bitwise_and.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bitwise_and.rst @@ -12,16 +12,13 @@ mindspore.ops.bitwise_and 输入 `x` 和 `y` 遵循 `隐式类型转换规则 `_ ，使数据类型保持一致。 如果 `x` 和 `y` 数据类型不同，低精度数据类型将自动转换成高精度数据类型。 - **参数：** + 参数： + - **x** (Tensor) - 第一个输入，是一个数据类型为uint16、int16或int32的Tensor。 + - **y** (Tensor) - 第二个输入，是一个与 `x` 相同类型的Tensor。 - - **x** (Tensor) - 第一个输入，是一个数据类型为uint16、int16或int32的Tensor。 - - **y** (Tensor) - 第二个输入，是一个与 `x` 相同类型的Tensor。 + 返回： + Tensor，是一个与 `x` 相同类型的Tensor。 - **返回：** - - Tensor，是一个与 `x` 相同类型的Tensor。 - - **异常：** - - - **TypeError** - `x` 或 `y` 不是Tensor。 - - **RuntimeError** - 输入的 `x` 与 `y` 需要进行参数类型转换时不符合转换规则。 + 异常： + - **TypeError** - `x` 或 `y` 不是Tensor。 + - **RuntimeError** - 输入的 `x` 与 `y` 需要进行参数类型转换时不符合转换规则。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bitwise_or.rst b/docs/api/api_python/ops/mindspore.ops.func_bitwise_or.rst index 18bc4ff5729..e40d8558b86 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bitwise_or.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bitwise_or.rst @@ -12,16 +12,13 @@ mindspore.ops.bitwise_or 输入 `x` 和 `y` 遵循 `隐式类型转换规则 `_ ，使数据类型保持一致。 如果 `x` 和 `y` 数据类型不同，低精度数据类型将自动转换成高精度数据类型。 - **参数：** + 参数： + - **x** (Tensor) - 第一个输入，是一个数据类型为uint16、int16或int32的Tensor。 + - **y** (Tensor) - 第二个输入，是一个与 `x` 相同类型的Tensor。 - - **x** (Tensor) - 第一个输入，是一个数据类型为uint16、int16或int32的Tensor。 - - **y** (Tensor) - 第二个输入，是一个与 `x` 相同类型的Tensor。 + 返回： + Tensor，是一个与 `x` 相同类型的Tensor。 - **返回：** - - Tensor，是一个与 `x` 相同类型的Tensor。 - - **异常：** - - - **TypeError** - `x` 或 `y` 不是Tensor。 - - **RuntimeError** - 输入的 `x` 与 `y` 需要进行参数类型转换时不符合转换规则。 + 异常： + - **TypeError** - `x` 或 `y` 不是Tensor。 + - **RuntimeError** - 输入的 `x` 与 `y` 需要进行参数类型转换时不符合转换规则。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_bitwise_xor.rst b/docs/api/api_python/ops/mindspore.ops.func_bitwise_xor.rst index 81fd8b9010b..abc1b3053a7 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_bitwise_xor.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_bitwise_xor.rst @@ -12,16 +12,13 @@ mindspore.ops.bitwise_xor 输入 `x` 和 `y` 遵循 `隐式类型转换规则 `_ ，使数据类型保持一致。 如果 `x` 和 `y` 数据类型不同，低精度数据类型将自动转换成高精度数据类型。 - **参数：** + 参数： + - **x** (Tensor) - 第一个输入，是一个数据类型为uint16、int16或int32的Tensor。 + - **y** (Tensor) - 第二个输入，是一个与 `x` 相同类型的Tensor。 - - **x** (Tensor) - 第一个输入，是一个数据类型为uint16、int16或int32的Tensor。 - - **y** (Tensor) - 第二个输入，是一个与 `x` 相同类型的Tensor。 + 返回： + Tensor，是一个与 `x` 相同类型的Tensor。 - **返回：** - - Tensor，是一个与 `x` 相同类型的Tensor。 - - **异常：** - - - **TypeError** - `x` 或 `y` 不是Tensor。 - - **RuntimeError** - 输入的 `x` 与 `y` 需要进行参数类型转换时不符合转换规则。 + 异常： + - **TypeError** - `x` 或 `y` 不是Tensor。 + - **RuntimeError** - 输入的 `x` 与 `y` 需要进行参数类型转换时不符合转换规则。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_broadcast_to.rst b/docs/api/api_python/ops/mindspore.ops.func_broadcast_to.rst index e745de074e7..7a1f8826645 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_broadcast_to.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_broadcast_to.rst @@ -7,16 +7,13 @@ mindspore.ops.broadcast_to 当输入shape广播到目标shape时，它从最后一个维度开始。如果目标shape中有-1维度，则-1维度不能位于一个不存在的维度中。 - **参数：** + 参数： + - **x** (Tensor) - 第一个输入，任意维度的Tensor，数据类型为float16、float32、int32、int8、uint8、bool。 + - **shape** (Tuple) - 第二个输入，指定广播到目标 `shape`。 - - **x** (Tensor) - 第一个输入，任意维度的Tensor，数据类型为float16、float32、int32、int8、uint8、bool。 - - **shape** (Tuple) - 第二个输入，指定广播到目标 `shape`。 + 返回： + Tensor，shape与目标 `shape` 相同，数据类型与 `x` 相同。 - **返回：** - - Tensor，shape与目标 `shape` 相同，数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `shape` 不是tuple。 - - **ValueError** - 输入shape 无法广播到目标 `shape` ，或者目标 `shape` 中的-1维度位于一个无效位置。 + 异常： + - **TypeError** - `shape` 不是tuple。 + - **ValueError** - 输入shape 无法广播到目标 `shape` ，或者目标 `shape` 中的-1维度位于一个无效位置。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_cdist.rst b/docs/api/api_python/ops/mindspore.ops.func_cdist.rst index 9dfe2bf0462..f68b950eb8a 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_cdist.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_cdist.rst @@ -5,21 +5,18 @@ mindspore.ops.cdist 批量计算两个Tensor每一批次所有向量两两之间的p-范数距离。 - **参数：** + 参数： + - **x** (tensor) - 输入tensor x，输入shape [B, P, M]，B维度可以为0，即shape为 [P, M]。 + - **y** (tensor) - 输入tensor y，输入shape [B, R, M]。 + - **p** (float) - P -范数距离的P值，P∈[0，∞]。默认值:2.0。 - - **x** (tensor) - 输入tensor x，输入shape [B, P, M], B维度可以为0，即shape为 [P, M]。 - - **y** (tensor) - 输入tensor y，输入shape [B, R, M]。 - - **p** (float) - P -范数距离的P值，P∈[0，∞]。默认值:2.0。 + 返回： + Tensor，p-范数距离，shape为[B, P, R]。 - **返回：** - - Tensor，p-范数距离, shape为[B, P, R]。 - - **异常：** - - - **TypeError** - `input_x` 或 `input_x` 不是Tensor。 - - **TypeError** - `input_x` 或 `input_y` 的数据类型不是float16，也不是float32。 - - **TypeError** - `p` 不是float32。 - - **ValueError** - `p` 是负数。 - - **ValueError** - `input_x` 与 `input_y` 维度不同。 - - **ValueError** - `input_x` 与 `input_y` 的维度不是2，也不是3。 + 异常： + - **TypeError** - `input_x` 或 `input_x` 不是Tensor。 + - **TypeError** - `input_x` 或 `input_y` 的数据类型不是float16，也不是float32。 + - **TypeError** - `p` 不是float32。 + - **ValueError** - `p` 是负数。 + - **ValueError** - `input_x` 与 `input_y` 维度不同。 + - **ValueError** - `input_x` 与 `input_y` 的维度不是2，也不是3。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_ceil.rst b/docs/api/api_python/ops/mindspore.ops.func_ceil.rst index e1e2bcd2874..155f6aa350d 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_ceil.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_ceil.rst @@ -8,15 +8,12 @@ mindspore.ops.ceil .. math:: out_i = \lceil x_i \rceil = \lfloor x_i \rfloor + 1 - **参数：** + 参数： + - **x** (Tensor) - Ceil的输入。其数据类型为float16或float32。shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。秩应小于8。 - - **x** (Tensor) - Ceil的输入。其数据类型为float16或float32。shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。秩应小于8。 + 返回： + Tensor，shape与 `x` 相同。 - **返回：** - - Tensor，shape与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 的不是Tensor。 - - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + 异常： + - **TypeError** - `x` 的不是Tensor。 + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_celu.rst b/docs/api/api_python/ops/mindspore.ops.func_celu.rst index 1b713030a28..6aa499b62af 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_celu.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_celu.rst @@ -8,18 +8,15 @@ mindspore.ops.celu .. math:: \text{CeLU}(x) = \max(0,x) + \min(0, \alpha * (\exp(x/\alpha) - 1)) - **参数：** + 参数： + - **x** (Tensor) - celu的输入，数据类型为float16或float32。 + - **alpha** (float) - celu公式定义的阈值 :math:`\alpha` 。默认值：1.0。 - - **x** (Tensor) - celu的输入，数据类型为float16或float32。 - - **alpha** (float) - celu公式定义的阈值 :math:`\alpha` 。默认值：1.0。 + 返回： + Tensor，shape和数据类型与输入相同。 - **返回：** - - Tensor，shape和数据类型与输入相同。 - - **异常：** - - - **TypeError** - `alpha` 不是float。 - - **ValueError** - `alpha` 的值为零。 - - **TypeError** - `x` 不是tensor。 - - **TypeError** - `x` 的dtype既不是float16也不是float32。 \ No newline at end of file + 异常： + - **TypeError** - `alpha` 不是float。 + - **ValueError** - `alpha` 的值为零。 + - **TypeError** - `x` 不是tensor。 + - **TypeError** - `x` 的dtype既不是float16也不是float32。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_clip_by_global_norm.rst b/docs/api/api_python/ops/mindspore.ops.func_clip_by_global_norm.rst index 3b9b2adedd9..396b4098241 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_clip_by_global_norm.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_clip_by_global_norm.rst @@ -11,12 +11,10 @@ .. note:: 在半自动并行模式或自动并行模式下，如果输入是梯度，那么将会自动汇聚所有设备上的梯度的平方和。 - **参数：** + 参数： + - **x** (Union(tuple[Tensor], list[Tensor])) - 由Tensor组成的tuple，其每个元素为任意维度的Tensor。 + - **clip_norm** (Union(float, int)) - 表示裁剪比率，应大于0。默认值：1.0。 + - **use_norm** (None) - 表示全局范数。目前只支持None，默认值：None。 - - **x** (Union(tuple[Tensor], list[Tensor])) - 由Tensor组成的tuple，其每个元素为任意维度的Tensor。 - - **clip_norm** (Union(float, int)) - 表示裁剪比率，应大于0。默认值：1.0。 - - **use_norm** (None) - 表示全局范数。目前只支持None，默认值：None。 - - **返回：** - - tuple[Tensor]，表示裁剪后的Tensor。其数据类型与 `x` 相同，输出tuple中的每个Tensor与输入shape相同。 \ No newline at end of file + 返回： + tuple[Tensor]，表示裁剪后的Tensor。其数据类型与 `x` 相同，输出tuple中的每个Tensor与输入shape相同。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_clip_by_value.rst b/docs/api/api_python/ops/mindspore.ops.func_clip_by_value.rst index a66cc14e363..e184818e692 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_clip_by_value.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_clip_by_value.rst @@ -18,12 +18,10 @@ .. note:: `clip_value_min` 必须小于或等于 `clip_value_max` 。 - **参数：** + 参数： + - **x** (Tensor) - clip_by_value的输入，任意维度的Tensor。 + - **clip_value_min** (Tensor) - 指定最小值。 + - **clip_value_max** (Tensor) - 指定最大值。 - - **x** (Tensor) - clip_by_value的输入，任意维度的Tensor。 - - **clip_value_min** (Tensor) - 指定最小值。 - - **clip_value_max** (Tensor) - 指定最大值。 - - **返回：** - - Tensor，表示裁剪后的Tensor。其shape和数据类型和 `x` 相同。 \ No newline at end of file + 返回： + Tensor，表示裁剪后的Tensor。其shape和数据类型和 `x` 相同。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_col2im.rst b/docs/api/api_python/ops/mindspore.ops.func_col2im.rst index 03e0f0f2d33..e0145bd7850 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_col2im.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_col2im.rst @@ -5,23 +5,20 @@ mindspore.ops.col2im 将一组滑动局部块组合成一个大的张量。 - **参数：** + 参数： + - **input_x** (Tensor) - 4维Tensor，输入的批量的滑动局部块，数据类型支持float16和float32。 + - **output_size** (Tensor) - 包含两个int元素的1维Tensor，输出张量的后两维的shape。 + - **kernel_size** (Union[int, tuple[int], list[int]]) - 滑动窗口的大小。tuple的两个元素分别对应kernel的高度与宽度。如果为一个int则kernel的高度与宽度均为该值。 + - **dilation** (Union[int, tuple[int], list[int]]) - 滑动窗口扩张的大小。 + - **padding_value** (Union[int, tuple[int], list[int]]) - 填充的大小。 + - **stride** (Union[int, tuple[int], list[int]]) - 步长的大小。 - - **input_x** (Tensor) - 4维Tensor，输入的批量的滑动局部块， 数据类型支持float16和float32。 - - **output_size** (Tensor) - 包含两个int元素的1维Tensor，输出张量的后两维的shape。 - - **kernel_size** (Union[int, tuple[int], list[int]]) - 滑动窗口的大小。tuple的两个元素分别对应kernel的高度与宽度。如果为一个int则kernel的高度与宽度均为该值。 - - **dilation** (Union[int, tuple[int], list[int]]) - 滑动窗口扩张的大小。 - - **padding_value** (Union[int, tuple[int], list[int]]) - 填充的大小。 - - **stride** (Union[int, tuple[int], list[int]]) - 步长的大小。 + 返回： + Tensor，输出的张量，维度和类型和输入一致。 - **返回：** - - Tensor，输出的张量，维度和类型和输入一致。 - - **异常：** - - - **TypeError** - 如果 `kernel_size`，`dilation`，`padding_value`，`stride` 不属于 Union[int, tuple[int], list[int]]。 - - **ValueError** - 如果 `kernel_size`，`dilation`，`stride` 值小于等于0或者个数大于2。 - - **ValueError** - 如果 `padding_value` 值小于0或者个数大于2。 - - **ValueError** - 如果 `input_x.dims(2)` 不等于 `kernel_size[0] * kernel_size[1]` 。 - - **ValueError** - 如果 `input_x.dims(3)` 与计算出的滑动块数量不匹配。 + 异常： + - **TypeError** - 如果 `kernel_size`，`dilation`，`padding_value`，`stride` 不属于 Union[int, tuple[int], list[int]]。 + - **ValueError** - 如果 `kernel_size`，`dilation`，`stride` 值小于等于0或者个数大于2。 + - **ValueError** - 如果 `padding_value` 值小于0或者个数大于2。 + - **ValueError** - 如果 `input_x.dims(2)` 不等于 `kernel_size[0] * kernel_size[1]` 。 + - **ValueError** - 如果 `input_x.dims(3)` 与计算出的滑动块数量不匹配。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_concat.rst b/docs/api/api_python/ops/mindspore.ops.func_concat.rst index f335f0e24bc..698fa24a720 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_concat.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_concat.rst @@ -13,18 +13,15 @@ .. note:: `axis` 的取值范围为 :math:`[-dims, dims - 1]` 。 `dims` 为 `input_x` 的维度长度。 - **参数：** + 参数： + - **input_x** (tuple, list) - 输入为Tensor组成的tuple或list。假设在这个tuple或list中有两个Tensor，即 `x1` 和 `x2` 。要在0轴方向上执行 `Concat` ，除0轴外，其他轴的shape都应相等，即 :math:`x1.shape[1] = x2.shape[1]，x1.shape[2] = x2.shape[2]，...，x1.shape[R] = x2.shape[R]` ，其中 :math:`R` 表示最后一个轴。 + - **axis** (int) - 表示指定的轴。默认值：0。 - - **input_x** (tuple, list) - 输入为Tensor组成的tuple或list。假设在这个tuple或list中有两个Tensor，即 `x1` 和 `x2` 。要在0轴方向上执行 `Concat` ，除0轴外，其他轴的shape都应相等，即 :math:`x1.shape[1] = x2.shape[1]，x1.shape[2] = x2.shape[2]，...，x1.shape[R] = x2.shape[R]` ，其中 :math:`R` 表示最后一个轴。 - - **axis** (int) - 表示指定的轴。默认值：0。 + 返回： + Tensor，shape为 :math:`(x_1, x_2, ..., \sum_{i=1}^Nx_{mi}, ..., x_R)` 。数据类型与 `input_x` 相同。 - **返回：** - - Tensor，shape为 :math:`(x_1, x_2, ..., \sum_{i=1}^Nx_{mi}, ..., x_R)` 。数据类型与 `input_x` 相同。 - - **异常：** - - - **TypeError** - `axis` 不是int。 - - **ValueError** - `input_x` 是不同维度的Tensor。 - - **ValueError** - `axis` 的维度范围不在[-dims, dims - 1]。 - - **RuntimeError** - 除了 `axis` 之外， `input_x` 的shape不相同。 + 异常： + - **TypeError** - `axis` 不是int。 + - **ValueError** - `input_x` 是不同维度的Tensor。 + - **ValueError** - `axis` 的维度范围不在[-dims, dims - 1]。 + - **RuntimeError** - 除了 `axis` 之外， `input_x` 的shape不相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_cosh.rst b/docs/api/api_python/ops/mindspore.ops.func_cosh.rst index f3b8bae8c53..26be0f782cb 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_cosh.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_cosh.rst @@ -8,15 +8,12 @@ mindspore.ops.cosh .. math:: out_i = cosh(x_i) - **参数：** + 参数： + - **x** (Tensor) - cosh的输入，任意维度的Tensor，其数据类型为float16、float32、float64、complex64、complex128。 - - **x** (Tensor) - cosh的输入，任意维度的Tensor，其数据类型为float16、float32、float64、complex64、complex128。 + 返回： + Tensor，数据类型和shape与 `x` 相同。 - **返回：** - - Tensor，数据类型和shape与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 的数据类型不是float16、float32、float64、complex64、complex128。 - - **TypeError** - `x` 不是Tensor。 + 异常： + - **TypeError** - `x` 的数据类型不是float16、float32、float64、complex64、complex128。 + - **TypeError** - `x` 不是Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_cross_entropy.rst b/docs/api/api_python/ops/mindspore.ops.func_cross_entropy.rst index 39daaee8900..a150bfa5713 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_cross_entropy.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_cross_entropy.rst @@ -48,18 +48,16 @@ \text{if reduction} = \text{'sum'.} \end{cases} - **参数：** + 参数： + - **inputs** (Tensor) - 输入预测值，shape为 :math:`(N, C)` 或 :math:`(N, C, H, W)` + (针对二维数据), 或 :math:`(N, C, d_1, d_2, ..., d_K)` (针对高维数据)。`inputs` 需为对数概率。数据类型仅支持float32或float16。 + - **target** (Tensor) - 输入目标值，shape为 :math:`(N)` 或 :math:`(N, d_1, d_2, ..., d_K)` + (针对高维数据)。数据类型仅支持int32。 + - **weight** (Tensor) - 指定各类别的权重。若值不为None，则shape为 (C,)。 + 数据类型仅支持float32或float16。默认值: None。 + - **ignore_index** (int) - 指定target中需要忽略的值(一般为填充值)，使其不对梯度产生影响。默认值：-100。 + - **reduction** (str) - 指定应用于输出结果的计算方式，比如'none'、'mean'、'sum'，默认值：'mean'。 + - **label_smoothing** (float) - 标签平滑值，用于计算Loss时防止模型过拟合的正则化手段。取值范围为[0.0, 1.0]。默认值：0.0。 - - **inputs** (Tensor) - 输入预测值，shape为 :math:`(N, C)` 或 :math:`(N, C, H, W)` - (针对二维数据), 或 :math:`(N, C, d_1, d_2, ..., d_K)` (针对高维数据)。`inputs` 需为对数概率。数据类型仅支持float32或float16。 - - **target** (Tensor) - 输入目标值，shape为 :math:`(N)` 或 :math:`(N, d_1, d_2, ..., d_K)` - (针对高维数据)。数据类型仅支持int32。 - - **weight** (Tensor) - 指定各类别的权重。若值不为None，则shape为 (C,)。 - 数据类型仅支持float32或float16。默认值: None。 - - **ignore_index** (int) - 指定target中需要忽略的值(一般为填充值)，使其不对梯度产生影响。默认值: -100。 - - **reduction** (str) - 指定应用于输出结果的计算方式，比如'none'、'mean'、'sum'，默认值：'mean'。 - - **label_smoothing** (float) - 标签平滑值，用于计算Loss时防止模型过拟合的正则化手段。取值范围为[0.0, 1.0]。 默认值: 0.0。 - - **返回：** - - Tensor，数据类型与 `inputs` 相同。 + 返回： + Tensor，数据类型与 `inputs` 相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_csr_to_coo.rst b/docs/api/api_python/ops/mindspore.ops.func_csr_to_coo.rst index 6cad5d91b8d..bcffee5d7f9 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_csr_to_coo.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_csr_to_coo.rst @@ -8,15 +8,12 @@ mindspore.ops.csr_to_coo .. note:: 现在只支持2维CSRTensor。 - **参数：** - - - **tensor** (CSRTensor) - 一个CSR矩阵，必须是2维。 + 参数： + - **tensor** (CSRTensor) - 一个CSR矩阵，必须是2维。 - **返回：** + 返回： + 返回一个2维的COOTensor，是原COOTensor的CSR格式表示。 - 返回一个2维的COOTensor，是原COOTensor的CSR格式表示。 - - **异常：** - - - **TypeError** - `tensor` 不是CSRTensor。 - - **ValueError** - `tensor` 不是2维CSRTensor。 + 异常： + - **TypeError** - `tensor` 不是CSRTensor。 + - **ValueError** - `tensor` 不是2维CSRTensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_ctc_greedy_decoder.rst b/docs/api/api_python/ops/mindspore.ops.func_ctc_greedy_decoder.rst index cb696c4aa90..98078db2d25 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_ctc_greedy_decoder.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_ctc_greedy_decoder.rst @@ -5,22 +5,19 @@ mindspore.ops.ctc_greedy_decoder 对输入中给定的logits执行贪婪解码。 - **参数：** + 参数： + - **inputs** (Tensor) - shape: :math:`(max\_time, batch\_size, num\_classes)`，数据类型必须是float32或者float64。`num_classes` 为 `num_labels + 1` classes，其中 `num_labels` 表示实际标签的个数，空标签默认使用 `num_classes - 1`。 + - **sequence_length** (Tensor) - shape: :math:`(batch\_size, )`，数据类型必须是int32，并且Tensor中的数值必须小于等于 `max_time`。 + - **merge_repeated** (bool) - True表示返回的结果中会合并重复的类。默认值为True。 - - **inputs** (Tensor) - shape: :math:`(max\_time, batch\_size, num\_classes)`，数据类型必须是float32或者float64。`num_classes` 为 `num_labels + 1` classes，其中 `num_labels` 表示实际标签的个数，空标签默认使用 `num_classes - 1`。 - - **sequence_length** (Tensor) - shape: :math:`(batch\_size, )`，数据类型必须是int32，并且Tensor中的数值必须小于等于 `max_time`。 - - **merge_repeated** (bool) - True表示返回的结果中会合并重复的类。默认值为True。 + 返回： + - **decoded_indices** (Tensor) - shape: :math:`(total\_decoded\_outputs, 2)`，数据类型为int64。 + - **decoded_values** (Tensor) - shape: :math:`(total\_decoded\_outputs, )`，数据类型为int64。 + - **decoded_shape** (Tensor) - shape: :math:`(batch\_size, max\_decoded\_legth)`，数据类型为int64。 + - **log_probability** (Tensor) - shape: :math:`(batch\_size, 1)`，包含序列的对数概率，其数据类型与 `inputs` 保持一致。 - **返回：** - - - **decoded_indices** (Tensor) - shape: :math:`(total\_decoded\_outputs, 2)`，数据类型为int64。 - - **decoded_values** (Tensor) - shape: :math:`(total\_decoded\_outputs, )`，数据类型为int64。 - - **decoded_shape** (Tensor) - shape: :math:`(batch\_size, max\_decoded\_legth)`，数据类型为int64。 - - **log_probability** (Tensor) - shape: :math:`(batch\_size, 1)`，包含序列的对数概率，其数据类型与 `inputs` 保持一致。 - - **异常：** - - - **TypeError** - `merge_repeated` 不是一个布尔值。 - - **ValueError** - `inputs` 的shape长度不等于3。 - - **ValueError** - `sequence_length` 的shape长度不等于1。 - - **ValueError** - `sequence_length` 中的数值大于 `max_time`。 + 异常： + - **TypeError** - `merge_repeated` 不是一个布尔值。 + - **ValueError** - `inputs` 的shape长度不等于3。 + - **ValueError** - `sequence_length` 的shape长度不等于1。 + - **ValueError** - `sequence_length` 中的数值大于 `max_time`。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_cummax.rst b/docs/api/api_python/ops/mindspore.ops.func_cummax.rst index d4d166e57a2..333abb98865 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_cummax.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_cummax.rst @@ -10,17 +10,14 @@ mindspore.ops.cummax y{i} = max(x{1}, x{2}, ... , x{i}) \end{array} - **参数：** + 参数： + - **x** (Tensor) - 输入Tensor，要求维度大于0。 + - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 - - **x** (Tensor) - 输入Tensor，要求维度大于0。 - - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 + 返回： + 一个包含两个Tensor的元组，分别表示累积最大值和对应索引。每个输出Tensor的形状和输入Tensor的形状相同。 - **返回：** - - 一个包含两个Tensor的元组，分别表示累积最大值和对应索引。每个输出Tensor的形状和输入Tensor的形状相同。 - - **异常：** - - - **TypeError** - 如果 `x` 不是Tensor。 - - **TypeError** - 如果 `axis` 不是int。 - - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 \ No newline at end of file + 异常： + - **TypeError** - 如果 `x` 不是Tensor。 + - **TypeError** - 如果 `axis` 不是int。 + - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_cummin.rst b/docs/api/api_python/ops/mindspore.ops.func_cummin.rst index 1824cae70d8..feb8854fb12 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_cummin.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_cummin.rst @@ -10,17 +10,14 @@ mindspore.ops.cummin y{i} = min(x{1}, x{2}, ... , x{i}) \end{array} - **参数：** + 参数： + - **x** (Tensor) - 输入Tensor，要求维度大于0。 + - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 - - **x** (Tensor) - 输入Tensor，要求维度大于0。 - - **axis** (int) - 算子操作的维度，维度的大小范围是[-x.ndim, x.ndim - 1]。 + 返回： + 一个包含两个Tensor的元组，分别表示累积最小值和对应索引。每个输出Tensor的形状和输入Tensor的形状相同。 - **返回：** - - 一个包含两个Tensor的元组，分别表示累积最小值和对应索引。每个输出Tensor的形状和输入Tensor的形状相同。 - - **异常：** - - - **TypeError** - 如果 `x` 不是Tensor。 - - **TypeError** - 如果 `axis` 不是int。 - - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 \ No newline at end of file + 异常： + - **TypeError** - 如果 `x` 不是Tensor。 + - **TypeError** - 如果 `axis` 不是int。 + - **ValueError** - 如果 `axis` 不在范围[-x.ndim, x.ndim - 1]内。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_deformable_conv2d.rst b/docs/api/api_python/ops/mindspore.ops.func_deformable_conv2d.rst index cd4f2cc908d..2ec87641e2f 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_deformable_conv2d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_deformable_conv2d.rst @@ -17,39 +17,36 @@ mindspore.ops.deformable_conv2d 其中 :math:`\Delta{p_{k}}` 和 :math:`\Delta{m_{k}}` 分别为第k个位置的可学习偏移和调制标量。细节请参考论文 `Deformable ConvNets v2: More Deformable, Better Results `_ 和 `Deformable Convolutional Networks `_ 。 - **参数：** + 参数： + - **x** (Tensor) - 一个四维Tensor，表示输入图像。数据格式为"NCHW"，shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 。Dytpe为float16或float32。 + - **weight** (Tensor) - 一个四维Tensor，表示可学习的滤波器。数据类型必须与 `x` 相同，shape为 :math:`(C_{out}, C_{in} / groups, H_{f}, W_{f})` 。 + - **offsets** (Tensor) - 一个四维Tensor，存储x和y坐标的偏移，以及可变形卷积的输入掩码mask。数据格式为"NCHW"，shape为 :math:`(batch, 3 * deformable\_groups * H_{f} * W_{f}, H_{out}, W_{out})` ，注意其中C维度的存储顺序为(offset_x, offset_y, mask)。数据类型必须与 `x` 相同。 + - **kernel_size** (tuple[int]) - 一个包含两个整数的元组，表示卷积核的大小。 + - **strides** (tuple[int]) - 一个包含四个整数的元组，表示对于输入的每个维度的滑动窗口步长。其维度顺序依据 `x` 的数据格式，对应N和C维度的值必须设置成1。 + - **padding** (tuple[int]) - 一个包含四个整数的元组，表示沿（上，下，左，右）四个方向往输入填充的像素点个数。 + - **bias** (Tensor, 可选) - 一个一维Tensor，表示加到卷积输出的偏置参数。shape为 :math:`(C_{out})` 。默认值为None。 + - **dilations** (tuple[int], 可选) - 一个包含四个整数的元组，表示对于输入的每个维度的膨胀系数。其维度顺序依据 `x` 的数据格式，对应N和C维度的值必须设置成1。默认值为(1, 1, 1, 1)。 + - **groups** (int, 可选) - 一个int32类型的整数，表示从输入通道到输出通道的阻塞连接数。输入通道数和输出通道数必须都能被 `groups` 整除。默认值为1。 + - **deformable_groups** (int, 可选) - 一个int32类型的整数，表示可变形卷积组数。输入通道数必须能被 `deformable_groups` 整除。默认值为1。 + - **modulated** (int, 可选) - 指定可变形二维卷积的版本。True表示v2，False表示v1。当前只支持设置为v2版本。默认值为True。 - - **x** (Tensor) - 一个四维Tensor，表示输入图像。数据格式为"NCHW"，shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 。Dytpe为float16或float32。 - - **weight** (Tensor) - 一个四维Tensor，表示可学习的滤波器。数据类型必须与 `x` 相同，shape为 :math:`(C_{out}, C_{in} / groups, H_{f}, W_{f})` 。 - - **offsets** (Tensor) - 一个四维Tensor，存储x和y坐标的偏移，以及可变形卷积的输入掩码mask。数据格式为"NCHW"，shape为 :math:`(batch, 3 * deformable\_groups * H_{f} * W_{f}, H_{out}, W_{out})` ，注意其中C维度的存储顺序为(offset_x, offset_y, mask)。数据类型必须与 `x` 相同。 - - **kernel_size** (tuple[int]) - 一个包含两个整数的元组，表示卷积核的大小。 - - **strides** (tuple[int]) - 一个包含四个整数的元组，表示对于输入的每个维度的滑动窗口步长。其维度顺序依据 `x` 的数据格式，对应N和C维度的值必须设置成1。 - - **padding** (tuple[int]) - 一个包含四个整数的元组，表示沿（上，下，左，右）四个方向往输入填充的像素点个数。 - - **bias** (Tensor, 可选) - 一个一维Tensor，表示加到卷积输出的偏置参数。shape为 :math:`(C_{out})` 。默认值为None。 - - **dilations** (tuple[int], 可选) - 一个包含四个整数的元组，表示对于输入的每个维度的膨胀系数。其维度顺序依据 `x` 的数据格式，对应N和C维度的值必须设置成1。默认值为(1, 1, 1, 1)。 - - **groups** (int, 可选) - 一个int32类型的整数，表示从输入通道到输出通道的阻塞连接数。输入通道数和输出通道数必须都能被 `groups` 整除。默认值为1。 - - **deformable_groups** (int, 可选) - 一个int32类型的整数，表示可变形卷积组数。输入通道数必须能被 `deformable_groups` 整除。默认值为1。 - - **modulated** (int, 可选) - 指定可变形二维卷积的版本。True表示v2，False表示v1。当前只支持设置为v2版本。默认值为True。 + 返回： + Tensor，一个四维Tensor，表示输出特征图。数据类型与 `x` 相同，数据格式为"NCHW"，shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 。 - **返回：** + .. math:: + \begin{array}{ll} \\ + H_{out} = \left \lfloor{\frac{H_{in} + padding[0] + padding[1] - (H_{f} - 1) \times + \text{dilations[2]} - 1 }{\text{stride[0]}} + 1} \right \rfloor \\ + W_{out} = \left \lfloor{\frac{W_{in} + padding[2] + padding[3] - (W_{f} - 1) \times + \text{dilations[3]} - 1 }{\text{stride[1]}} + 1} \right \rfloor \\ + \end{array} - Tensor，一个四维Tensor，表示输出特征图。数据类型与 `x` 相同，数据格式为"NCHW"，shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 。 - - .. math:: - \begin{array}{ll} \\ - H_{out} = \left \lfloor{\frac{H_{in} + padding[0] + padding[1] - (H_{f} - 1) \times - \text{dilations[2]} - 1 }{\text{stride[0]}} + 1} \right \rfloor \\ - W_{out} = \left \lfloor{\frac{W_{in} + padding[2] + padding[3] - (W_{f} - 1) \times - \text{dilations[3]} - 1 }{\text{stride[1]}} + 1} \right \rfloor \\ - \end{array} - - **异常：** - - - **TypeError** - 如果 `strides`， `padding`， `kernel_size` 或者 `dilations` 不是一个整数元组。 - - **TypeError** - 如果 `modulated` 不是一个布尔值。 - - **ValueError** - 如果 `strides`， `padding`， `kernel_size` 或者 `dilations` 的元组不是期望的大小。 - - **ValueError** - 如果 `strides` 或者 `dilations` 对应N和C维度的值不为1。 - - **ValueError** - 如果 `modulated` 的值不是True。 + 异常： + - **TypeError** - 如果 `strides`， `padding`， `kernel_size` 或者 `dilations` 不是一个整数元组。 + - **TypeError** - 如果 `modulated` 不是一个布尔值。 + - **ValueError** - 如果 `strides`， `padding`， `kernel_size` 或者 `dilations` 的元组不是期望的大小。 + - **ValueError** - 如果 `strides` 或者 `dilations` 对应N和C维度的值不为1。 + - **ValueError** - 如果 `modulated` 的值不是True。 .. note:: - 这是一个实验性质的接口，将来有可能被修改或删除。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_coo.rst b/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_coo.rst index 8ab7af32da4..2e64e6eba2b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_coo.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_coo.rst @@ -8,20 +8,17 @@ mindspore.ops.dense_to_sparse_coo .. note:: 现在只支持2维Tensor。 - **参数：** + 参数： + - **tensor** (Tensor) - 一个稠密Tensor，必须是2维。 - - **tensor** (Tensor) - 一个稠密Tensor，必须是2维。 + 返回： + 返回一个2维的COOTensor，是原稠密Tensor的稀疏化表示。分为： - **返回：** - - 返回一个2维的COOTensor，是原稠密Tensor的稀疏化表示。分为： - - - **indices** (Tensor) - 二维整数张量，表示稀疏张量中 `values` 所处的位置索引。 - - **values** (Tensor) - 一维张量，用来给 `indices` 中的每个元素提供数值。 - - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 + - **indices** (Tensor) - 二维整数张量，表示稀疏张量中 `values` 所处的位置索引。 + - **values** (Tensor) - 一维张量，用来给 `indices` 中的每个元素提供数值。 + - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 - **异常：** - - - **TypeError** - `tensor` 不是Tensor。 - - **ValueError** - `tensor` 不是2维Tensor。 + 异常： + - **TypeError** - `tensor` 不是Tensor。 + - **ValueError** - `tensor` 不是2维Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_csr.rst b/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_csr.rst index a2162ea8ef9..16afa6766c3 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_csr.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_dense_to_sparse_csr.rst @@ -8,20 +8,17 @@ mindspore.ops.dense_to_sparse_csr .. note:: 现在只支持2维Tensor。 - **参数：** + 参数： + - **tensor** (Tensor) - 一个稠密Tensor，必须是2维。 - - **tensor** (Tensor) - 一个稠密Tensor，必须是2维。 + 返回： + 返回一个2维的CSRTensor，是原稠密Tensor的稀疏化表示。其中数据分别为： - **返回：** + - **indptr** (Tensor) - 一维整数张量，表示每行非零元素的在 `values` 中存储的起止位置。 + - **indices** (Tensor) - 一维整数张量，表示每个元素的列索引值。 + - **values** (Tensor) - 一维张量，用来表示索引对应的数值。 + - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 - 返回一个2维的CSRTensor，是原稠密Tensor的稀疏化表示。其中数据分别为： - - - **indptr** (Tensor) - 一维整数张量，表示每行非零元素的在 `values` 中存储的起止位置。 - - **indices** (Tensor) - 一维整数张量，表示每个元素的列索引值。 - - **values** (Tensor) - 一维张量，用来表示索引对应的数值。 - - **shape** (tuple(int)) - 整数元组，用来指定稀疏矩阵的稠密形状。 - - **异常：** - - - **TypeError** - `tensor` 不是Tensor。 - - **ValueError** - `tensor` 不是2维Tensor。 + 异常： + - **TypeError** - `tensor` 不是Tensor。 + - **ValueError** - `tensor` 不是2维Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_derivative.rst b/docs/api/api_python/ops/mindspore.ops.func_derivative.rst index d79f4895bca..dcafe1cb1d8 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_derivative.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_derivative.rst @@ -8,21 +8,18 @@ mindspore.ops.derivative .. note:: - 若 `primals` 是int型的Tensor，会被转化成float32格式进行计算。 - **参数：** + 参数： + - **fn** (Union[Function, Cell]) - 待求导的函数或网络。 + - **primals** (Union[Tensor, tuple[Tensor]]) - `fn` 的输入，单输入的type为Tensor，多输入的type为Tensor组成的tuple。 + - **order** (int) - 求导的阶数。 - - **fn** (Union[Function, Cell]) - 待求导的函数或网络。 - - **primals** (Union[Tensor, tuple[Tensor]]) - `fn` 的输入，单输入的type为Tensor，多输入的type为Tensor组成的tuple。 - - **order** (int) - 求导的阶数。 + 返回： + tuple，由 `out_primals` 和 `out_series` 组成。 - **返回：** + - **out_primals** (Union[Tensor, list[Tensor]]) - `fn(primals)` 的结果。 + - **out_series** (Union[Tensor, list[Tensor]]) - `fn` 输出对输入的第n阶导数。 - tuple，由 `out_primals` 和 `out_series` 组成。 - - - **out_primals** (Union[Tensor, list[Tensor]]) - `fn(primals)` 的结果。 - - **out_series** (Union[Tensor, list[Tensor]]) - `fn` 输出对输入的第n阶导数。 - - **异常：** - - - **TypeError** - `primals` 不是Tensor或tuple。 - - **TypeError** - `order` 不是int。 - - **ValueError** - `order` 不是正数。 + 异常： + - **TypeError** - `primals` 不是Tensor或tuple。 + - **TypeError** - `order` 不是int。 + - **ValueError** - `order` 不是正数。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_diag.rst b/docs/api/api_python/ops/mindspore.ops.func_diag.rst index 2300debfc08..39cef00cff6 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_diag.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_diag.rst @@ -7,15 +7,12 @@ mindspore.ops.diag 假设输入Tensor维度为 :math:`[D_1,... D_k]` ，则输出是一个rank为2k的tensor，其维度为 :math:`[D_1,..., D_k, D_1,..., D_k]` ，其中 :math:`output[i_1,..., i_k, i_1,..., i_k] = input_x[i_1,..., i_k]` 并且其他位置的值为0。 - **参数：** + 参数： + - **input_x** (Tensor) - 输入Tensor。 - - **input_x** (Tensor) - 输入Tensor。 + 返回： + Tensor，具有与输入Tensor相同的数据类型。 - **返回：** - - Tensor，具有与输入Tensor相同的数据类型。 - - **异常：** - - - **TypeError** - `input_x` 不是Tensor。 - - **ValueError** - `input_x` 的rank小于1。 + 异常： + - **TypeError** - `input_x` 不是Tensor。 + - **ValueError** - `input_x` 的rank小于1。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_dot.rst b/docs/api/api_python/ops/mindspore.ops.func_dot.rst index 862173652f0..21d05e7344e 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_dot.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_dot.rst @@ -5,17 +5,14 @@ mindspore.ops.dot 两个Tensor之间的点积。 - **参数：** + 参数： + - **x1** (Tensor) - 第一个输入的Tensor，数据类型为float16或float32，秩必须大于或等于2。 + - **x2** (Tensor) - 第二个输入的Tensor，数据类型为float16或float32，秩必须大于或等于2。 - - **x1** (Tensor) - 第一个输入的Tensor，数据类型为float16或float32，秩必须大于或等于2。 - - **x2** (Tensor) - 第二个输入的Tensor，数据类型为float16或float32，秩必须大于或等于2。 + 返回： + Tensor， `x1` 和 `x2` 的点积。 - **返回：** - - Tensor， `x1` 和 `x2` 的点积。 - - **异常：** - - - **TypeError** - `x1` 和 `x2` 的数据类型不相同。 - - **TypeError** - `x1` 或 `x2` 的数据类型不是float16或float32。 - - **ValueError** - `x1` 或 `x2` 的秩小于2。 \ No newline at end of file + 异常： + - **TypeError** - `x1` 和 `x2` 的数据类型不相同。 + - **TypeError** - `x1` 或 `x2` 的数据类型不是float16或float32。 + - **ValueError** - `x1` 或 `x2` 的秩小于2。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_dropout2d.rst b/docs/api/api_python/ops/mindspore.ops.func_dropout2d.rst index 403881bed1c..bd188ff61fa 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_dropout2d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_dropout2d.rst @@ -11,22 +11,19 @@ mindspore.ops.dropout2d `dropout2d` 可以提高通道特征映射之间的独立性。 - **参数：** + 参数： + - **x** (tensor) - 一个形状为 :math:`(N, C, H, W)` 的 `4D` Tensor，其中N是批处理大小，`C` 是通道数，`H` 是特征高度，`W` 是特征宽度。其数据类型应为int8、int16、int32、int64、float16、float32或float64。 + - **p** (float) - 通道的丢弃概率，介于 0 和 1 之间，例如 `p` = 0.8，意味着80%的清零概率。默认值：0.5。 - - **x** (tensor) - 一个形状为 :math:`(N, C, H, W)` 的 `4D` Tensor，其中N是批处理大小，`C` 是通道数，`H` 是特征高度，`W` 是特征宽度。其数据类型应为int8、int16、int32、int64、float16、float32或float64。 - - **p** (float) - 通道的丢弃概率，介于 0 和 1 之间，例如 `p` = 0.8，意味着80%的清零概率。默认值：0.5。 + 返回： + Tensor，输出，具有与输入 `x` 相同的形状和数据类型。 - **返回：** + Tensor，掩码，形状与 `x` 相同，数据类型为bool。 - Tensor，输出，具有与输入 `x` 相同的形状和数据类型。 - - Tensor，掩码，形状与 `x` 相同，数据类型为bool。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是int8、int16、int32、int64、float16、float32或float64。 - - **TypeError** - `p` 的数据类型不是float。 - - **ValueError** - `p` 值不在 `[0.0，1.0]` 之间。 - - **ValueError** - `x` 的维度不等于4。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是int8、int16、int32、int64、float16、float32或float64。 + - **TypeError** - `p` 的数据类型不是float。 + - **ValueError** - `p` 值不在 `[0.0，1.0]` 之间。 + - **ValueError** - `x` 的维度不等于4。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_dropout3d.rst b/docs/api/api_python/ops/mindspore.ops.func_dropout3d.rst index 0d23657a0ae..f42688f3b9c 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_dropout3d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_dropout3d.rst @@ -10,22 +10,19 @@ mindspore.ops.dropout3d `dropout3d` 可以提高通道特征映射之间的独立性。 - **参数：** + 参数： + - **x** (tensor) - 一个形状为 :math:`(N, C, D, H, W)` 的 `5D` Tensor，其中N是批处理大小，`C` 是通道数，`D` 是特征深度， `H` 是特征高度，`W` 是特征宽度。其数据类型应为int8、int16、int32、int64、float16、float32或float64。 + - **p** (float) - 通道的丢弃概率，介于 0 和 1 之间，例如 `p` = 0.8，意味着80%的清零概率。默认值：0.5。 - - **x** (tensor) - 一个形状为 :math:`(N, C, D, H, W)` 的 `5D` Tensor，其中N是批处理大小，`C` 是通道数，`D` 是特征深度， `H` 是特征高度，`W` 是特征宽度。其数据类型应为int8、int16、int32、int64、float16、float32或float64。 - - **p** (float) - 通道的丢弃概率，介于 0 和 1 之间，例如 `p` = 0.8，意味着80%的清零概率。默认值：0.5。 + 返回： + Tensor，输出，具有与输入 `x` 相同的形状和数据类型。 - **返回：** + Tensor，掩码，形状与 `x` 相同，数据类型为bool。 - Tensor，输出，具有与输入 `x` 相同的形状和数据类型。 - - Tensor，掩码，形状与 `x` 相同，数据类型为bool。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型不是int8、int16、int32、int64、float16、float32或float64。 - - **TypeError** - `p` 的数据类型不是float。 - - **ValueError** - `p` 值不在 `[0.0，1.0]` 之间。 - - **ValueError** - `x` 的维度不等于5。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型不是int8、int16、int32、int64、float16、float32或float64。 + - **TypeError** - `p` 的数据类型不是float。 + - **ValueError** - `p` 值不在 `[0.0，1.0]` 之间。 + - **ValueError** - `x` 的维度不等于5。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_dyn_shape.rst b/docs/api/api_python/ops/mindspore.ops.func_dyn_shape.rst index 5b14f5239ce..b2b2741d027 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_dyn_shape.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_dyn_shape.rst @@ -5,14 +5,11 @@ mindspore.ops.dyn_shape 返回输入Tensor的Shape。 - **参数：** + 参数： + - **input_x** (Tensor) - 第一个输入，是一个Tensor类型数据。 - - **input_x** (Tensor) - 第一个输入，是一个Tensor类型数据。 + 返回： + Tensor，输入 `input_x` 的shape。 - **返回：** - - Tensor，输入 `input_x` 的shape。 - - **异常：** - - - **TypeError** - `input_x` 都不是Tensor。 + 异常： + - **TypeError** - `input_x` 都不是Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_equal.rst b/docs/api/api_python/ops/mindspore.ops.func_equal.rst index 4de5f4531d3..1522ca43ffe 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_equal.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_equal.rst @@ -18,15 +18,12 @@ mindspore.ops.equal - 当输入是一个Tensor和一个Scalar时，Scalar只能是一个常数。 - 支持广播。 - **参数：** + 参数： + - **x** (Union[Tensor, Number]) - 第一个输入可以是数值型，也可以是数据类型为数值型的Tensor。 + - **y** (Union[Tensor, Number]) - 当第一个输入是Tensor时，第二个输入是数值型或数据类型为数值型的Tensor。数据类型与第一个输入相同。 - - **x** (Union[Tensor, Number]) - 第一个输入可以是数值型，也可以是数据类型为数值型的Tensor。 - - **y** (Union[Tensor, Number]) - 当第一个输入是Tensor时，第二个输入是数值型或数据类型为数值型的Tensor。数据类型与第一个输入相同。 + 返回： + Tensor，输出的shape与输入广播后的shape相同，数据类型为bool。 - **返回：** - - Tensor，输出的shape与输入广播后的shape相同，数据类型为bool。 - - **异常：** - - - **TypeError** - `x` 和 `y` 都不是Tensor。 \ No newline at end of file + 异常： + - **TypeError** - `x` 和 `y` 都不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_erf.rst b/docs/api/api_python/ops/mindspore.ops.func_erf.rst index 6040aa73c61..01454b62346 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_erf.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_erf.rst @@ -9,15 +9,12 @@ mindspore.ops.erf erf(x)=\frac{2} {\sqrt{\pi}} \int\limits_0^{x} e^{-t^{2}} dt - **参数：** + 参数： + - **x** (Tensor) - 高斯误差函数的输入Tensor。维度必须小于8，数据类型必须为float16或float32。 - - **x** (Tensor) - 高斯误差函数的输入Tensor。维度必须小于8，数据类型必须为float16或float32。 + 返回： + Tensor，具有与 `x` 相同的数据类型和shape。 - **返回：** - - Tensor，具有与 `x` 相同的数据类型和shape。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_erfc.rst b/docs/api/api_python/ops/mindspore.ops.func_erfc.rst index f8eea1485b6..23a6384c83c 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_erfc.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_erfc.rst @@ -9,15 +9,12 @@ mindspore.ops.erfc erfc(x) = 1 - \frac{2} {\sqrt{\pi}} \int\limits_0^{x} e^{-t^{2}} dt - **参数：** + 参数： + - **x** (Tensor) - 互补误差函数的输入Tensor。维度必须小于8，数据类型必须为float16或float32。 - - **x** (Tensor) - 互补误差函数的输入Tensor。维度必须小于8，数据类型必须为float16或float32。 + 返回： + Tensor，具有与 `x` 相同的数据类型和shape。 - **返回：** - - Tensor，具有与 `x` 相同的数据类型和shape。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_expand_dims.rst b/docs/api/api_python/ops/mindspore.ops.func_expand_dims.rst index 4e5276de25d..c8aacb33440 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_expand_dims.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_expand_dims.rst @@ -12,16 +12,13 @@ mindspore.ops.expand_dims If the specified axis is a negative number, the index is counted backward from the end and starts at 1. - **参数：** + 参数： + - **a** (Tensor) - 输入Tensor，shape为 :math:`(x_1, x_2, ..., x_R)`。 + - **axis** (Union[int, list(int), tuple(int)]) - 新插入的维度的位置。`axis` 的值必须在范围 `[-input_x.ndim-1, input_x.ndim]` 内。仅接受常量输入。 - - **a** (Tensor) - 输入Tensor，shape为 :math:`(x_1, x_2, ..., x_R)`。 - - **axis** (Union[int, list(int), tuple(int)]) - 新插入的维度的位置。`axis` 的值必须在范围 `[-input_x.ndim-1, input_x.ndim]` 内。 仅接受常量输入。 + 返回： + Tensor，维度在指定轴扩展之后的Tensor，与 `input_x` 的数据类型相同。如果 `axis` 是0，那么它的shape为 :math:`(1, x_1, x_2, ..., x_R)`。 - **返回：** - - Tensor，维度在指定轴扩展之后的Tensor，与 `input_x` 的数据类型相同。 如果 `axis` 是0，那么它的shape为 :math:`(1, x_1, x_2, ..., x_R)`。 - - **异常：** - - - **TypeError** - 如果 `axis` 不是int。 - - **ValueError** - 如果 `axis` 超出了 :math:`[-a.ndim-1, a.ndim]` 的范围。 + 异常： + - **TypeError** - 如果 `axis` 不是int。 + - **ValueError** - 如果 `axis` 超出了 :math:`[-a.ndim-1, a.ndim]` 的范围。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_eye.rst b/docs/api/api_python/ops/mindspore.ops.func_eye.rst index 49927d866cf..9a3b13ab803 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_eye.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_eye.rst @@ -8,17 +8,14 @@ mindspore.ops.eye .. note:: 结合ReverseV2算子可以得到一个反对角线为1的Tensor，但是目前ReverseV2算子只支持Ascend和GPU平台。 - **参数：** + 参数： + - **n** (int) - 指定返回Tensor的行数。仅支持常量值。 + - **m** (int) - 指定返回Tensor的列数。仅支持常量值。 + - **t** (mindspore.dtype) - 指定返回Tensor的数据类型。数据类型必须是 `bool_ `_ 或 `number `_ 。 - - **n** (int) - 指定返回Tensor的行数。仅支持常量值。 - - **m** (int) - 指定返回Tensor的列数。仅支持常量值。 - - **t** (mindspore.dtype) - 指定返回Tensor的数据类型。数据类型必须是 `bool_ `_ 或 `number `_ 。 + 返回： + Tensor，主对角线上为1，其余的元素为0。它的shape由 `n` 和 `m` 指定。数据类型由 `t` 指定。 - **返回：** - - Tensor，主对角线上为1，其余的元素为0。它的shape由 `n` 和 `m` 指定。数据类型由 `t` 指定。 - - **异常：** - - - **TypeError** - `m` 或 `n` 不是int。 - - **ValueError** - `m` 或 `n` 小于1。 + 异常： + - **TypeError** - `m` 或 `n` 不是int。 + - **ValueError** - `m` 或 `n` 小于1。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_fast_gelu.rst b/docs/api/api_python/ops/mindspore.ops.func_fast_gelu.rst index a9929892b85..7e97d3a6a1f 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_fast_gelu.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_fast_gelu.rst @@ -12,14 +12,11 @@ 其中 :math:`x` 是输入元素。 - **参数：** + 参数： + - **x** (Tensor) - 计算FastGeLU的输入，数据类型为float16或者float32。 - - **x** (Tensor) - 计算FastGeLU的输入，数据类型为float16或者float32。 + 返回： + Tensor，其shape和数据类型和 `x` 相同。 - **返回：** - - Tensor，其shape和数据类型和 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 数据类型不是float16或者float32。 + 异常： + - **TypeError** - `x` 数据类型不是float16或者float32。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_fill.rst b/docs/api/api_python/ops/mindspore.ops.func_fill.rst index 14e88df4b59..66460ef8324 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_fill.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_fill.rst @@ -5,16 +5,13 @@ mindspore.ops.fill 创建一个指定shape的Tensor，并用指定值填充。 - **参数：** + 参数： + - **type** (mindspore.dtype) - 指定输出Tensor的数据类型。数据类型只支持 `bool_ `_ 和 `number `_ 。 + - **shape** (tuple[int]) - 指定输出Tensor的shape。 + - **value** (Union(number.Number, bool)) - 用来填充输出Tensor的值。 - - **type** (mindspore.dtype) - 指定输出Tensor的数据类型。数据类型只支持 `bool_ `_ 和 `number `_ 。 - - **shape** (tuple[int]) - 指定输出Tensor的shape。 - - **value** (Union(number.Number, bool)) - 用来填充输出Tensor的值。 + 返回： + Tensor。 - **返回：** - - Tensor。 - - **异常：** - - **TypeError** - `shape` 不是元组。 + 异常： + - **TypeError** - `shape` 不是元组。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_fills.rst b/docs/api/api_python/ops/mindspore.ops.func_fills.rst index 05aa59478c9..ff1abb53661 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_fills.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_fills.rst @@ -5,18 +5,15 @@ mindspore.ops.fills 创建一个与输入Tensor具有相同shape和type的Tensor，并用指定值填充。 - **参数：** + 参数： + - **x** (Tensor) - 输入Tensor，用来指定输出Tensor的shape和type。数据类型为int8，int16，int32，float16，float32。 + - **value** (Union(int, float, Tensor)) - 用来填充输出Tensor的值。数据类型为int，float或0维Tensor。 - - **x** (Tensor) - 输入Tensor，用来指定输出Tensor的shape和type。数据类型为int8，int16，int32，float16，float32。 - - **value** (Union(int, float, Tensor)) - 用来填充输出Tensor的值。数据类型为int，float或0维Tensor。 + 返回： + Tensor，与输入数据 `x` 具有相同的shape和type。 - **返回：** - - Tensor，与输入数据 `x` 具有相同的shape和type。 - - **异常：** - - - **TypeError** - `x` 不是Tensor。 - - **TypeError** - `value` 具有前面未指定的类型。 - - **RuntimeError** - `value` 不能转换为与当前Tensor相同的类型。 - - **ValueError** - `value` 是非0维Tensor。 + 异常： + - **TypeError** - `x` 不是Tensor。 + - **TypeError** - `value` 具有前面未指定的类型。 + - **RuntimeError** - `value` 不能转换为与当前Tensor相同的类型。 + - **ValueError** - `value` 是非0维Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_flatten.rst b/docs/api/api_python/ops/mindspore.ops.func_flatten.rst index e784e80eb00..c59cf38d5ab 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_flatten.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_flatten.rst @@ -5,15 +5,12 @@ mindspore.ops.flatten 扁平化（Flatten）输入Tensor，不改变0轴的size。 - **参数：** + 参数： + - **input_x** (Tensor) - 待扁平化的Tensor，其shape为 :math:`(N, \ldots)`， :math:`N` 表示batch size。 - - **input_x** (Tensor) - 待扁平化的Tensor，其shape为 :math:`(N, \ldots)`， :math:`N` 表示batch size。 + 返回： + Tensor，其shape为 :math:`(N, X)` 的Tensor，其中 :math:`X` 是余下维度的乘积。 - **返回：** - - Tensor，其shape为 :math:`(N, X)` 的Tensor，其中 :math:`X` 是余下维度的乘积。 - - **异常：** - - - **TypeError** - `input_x` 不是Tensor。 - - **ValueError** - `input_x` 的shape长度小于1。 \ No newline at end of file + 异常： + - **TypeError** - `input_x` 不是Tensor。 + - **ValueError** - `input_x` 的shape长度小于1。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_floor.rst b/docs/api/api_python/ops/mindspore.ops.func_floor.rst index 17fa332bfca..31909567471 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_floor.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_floor.rst @@ -8,15 +8,12 @@ mindspore.ops.floor .. math:: out_i = \lfloor x_i \rfloor - **参数：** + 参数： + - **x** (Tensor) - Floor的输入，任意维度的Tensor，秩应小于8。其数据类型必须为float16、float32。 - - **x** (Tensor) - Floor的输入，任意维度的Tensor，秩应小于8。其数据类型必须为float16、float32。 + 返回： + Tensor，shape与 `x` 相同。 - **返回：** - - Tensor，shape与 `x` 相同。 - - **异常：** - - - **TypeError** - `x` 的数据类型不是Tensor。 - - **TypeError** - `x` 的数据类型不是float16、float32、float64。 \ No newline at end of file + 异常： + - **TypeError** - `x` 的数据类型不是Tensor。 + - **TypeError** - `x` 的数据类型不是float16、float32、float64。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_gamma.rst b/docs/api/api_python/ops/mindspore.ops.func_gamma.rst index fb27ffa705c..af90f31da1b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_gamma.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_gamma.rst @@ -3,22 +3,19 @@ mindspore.ops.gamma .. py:function:: mindspore.ops.gamma(shape, alpha, beta, seed=None) - ٤ֲ + 根据伽马分布产生成随机数。 - **** + 参数： + - **shape** (tuple) - 指定生成随机数的shape。任意维度的Tensor。 + - **alpha** (Tensor) - :math:`\alpha` 分布的参数。应该大于0且数据类型为float32。 + - **beta** (Tensor) - :math:`\beta` 分布的参数。应该大于0且数据类型为float32。 + - **seed** (int) - 随机数生成器的种子，必须是非负数，默认为None，将视为0。 - - **shape** (tuple) - ָshapeάȵTensor - - **alpha** (Tensor) - :math:`\alpha` ֲIJӦô0Ϊfloat32 - - **beta** (Tensor) - :math:`\beta` ֲIJӦô0Ϊfloat32 - - **seed** (int) - ӣǷǸĬΪNoneΪ0 + 返回： + Tensor。shape是输入 `shape` 、 `alpha` 、 `beta` 广播后的shape。数据类型为float32。 - **أ** - - Tensorshape `shape` `alpha` `beta` 㲥shapeΪfloat32 - - **쳣** - - - **TypeError** C `shape` tuple - - **TypeError** C `alpha` `beta` Tensor - - **TypeError** C `seed` Ͳint - - **TypeError** C `alpha` `beta` Ͳfloat32 \ No newline at end of file + 异常： + - **TypeError** - `shape` 不是tuple。 + - **TypeError** - `alpha` 或 `beta` 不是Tensor。 + - **TypeError** - `seed` 的数据类型不是int。 + - **TypeError** - `alpha` 或 `beta` 的数据类型不是float32。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_gather.rst b/docs/api/api_python/ops/mindspore.ops.func_gather.rst index 7e3ad912315..e6c356a952b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_gather.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_gather.rst @@ -15,18 +15,15 @@ mindspore.ops.gather 1. input_indices的值必须在 `[0, input_param.shape[axis])` 范围内，超出该范围结果未定义。 2. Ascend平台上，input_params的数据类型当前不能是 `bool_ `_ 。 - **参数：** + 参数： + - **input_params** (Tensor) - 原始Tensor，shape为 :math:`(x_1, x_2, ..., x_R)` 。 + - **input_indices** (Tensor) - 要切片的索引Tensor，shape为 :math:`(y_1, y_2, ..., y_S)` 。指定原始Tensor中要切片的索引。数据类型必须是int32或int64。 + - **axis** (int) - 指定要切片的维度索引。 - - **input_params** (Tensor) - 原始Tensor，shape为 :math:`(x_1, x_2, ..., x_R)` 。 - - **input_indices** (Tensor) - 要切片的索引Tensor，shape为 :math:`(y_1, y_2, ..., y_S)` 。指定原始Tensor中要切片的索引。数据类型必须是int32或int64。 - - **axis** (int) - 指定要切片的维度索引。 + 返回： + Tensor，shape为 :math:`input\_params.shape[:axis] + input\_indices.shape + input\_params.shape[axis + 1:]` 。 - **返回：** - - Tensor，shape为 :math:`input\_params.shape[:axis] + input\_indices.shape + input\_params.shape[axis + 1:]` 。 - - **异常：** - - - **TypeError** - `axis` 不是int。 - - **TypeError** - `input_params` 不是Tensor。 - - **TypeError** - `input_indices` 不是int类型的Tensor。 + 异常： + - **TypeError** - `axis` 不是int。 + - **TypeError** - `input_params` 不是Tensor。 + - **TypeError** - `input_indices` 不是int类型的Tensor。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_gather_elements.rst b/docs/api/api_python/ops/mindspore.ops.func_gather_elements.rst index 9efa6ff93f5..2ea09175d7b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_gather_elements.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_gather_elements.rst @@ -17,19 +17,16 @@ mindspore.ops.gather_elements `x` 与 `index` 拥有一样的维度长度，且除 `dim` 维外其他维度一致。如果维度 `dim` 为i， `x` 是shape为 :math:`(z_0, z_1, ..., z_i, ..., z_{n-1})` 的n维Tensor，则 `index` 必须是shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})` 的n维Tensor，其中 `y` 大于等于1。输出的shape与 `index` 相同。 - **参数：** + 参数： + - **x** (Tensor) - 输入Tensor。 + - **dim** (int) - 获取元素的轴。数据类型为int32或int64。取值范围为[-x_rank, x_rank)。 + - **index** (Tensor) - 获取收集元素的索引。支持的数据类型包括：int32，int64。每个索引元素的取值范围为[-x_rank[dim], x_rank[dim])。 - - **x** (Tensor) - 输入Tensor。 - - **dim** (int) - 获取元素的轴。数据类型为int32或int64。取值范围为[-x_rank, x_rank)。 - - **index** (Tensor) - 获取收集元素的索引。支持的数据类型包括：int32，int64。每个索引元素的取值范围为[-x_rank[dim], x_rank[dim])。 + 返回： + Tensor，shape与 `index` 相同，即其shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})`，数据类型与 `x` 相同。 - **返回：** - - Tensor，shape与 `index` 相同，即其shape为 :math:`(z_0, z_1, ..., y, ..., z_{n-1})`，数据类型与 `x` 相同。 - - **异常：** - - - **TypeError** - `dim` 或 `index` 的数据类型既不是int32，也不是int64。 - - **ValueError** - `x` 和 `index` 的维度长度不一致。 - - **ValueError** - `x` 和 `index` 除 `dim` 维外的维度不一致。 - - **ValueError** - `dim` 的值不在合理范围内。 \ No newline at end of file + 异常： + - **TypeError** - `dim` 或 `index` 的数据类型既不是int32，也不是int64。 + - **ValueError** - `x` 和 `index` 的维度长度不一致。 + - **ValueError** - `x` 和 `index` 除 `dim` 维外的维度不一致。 + - **ValueError** - `dim` 的值不在合理范围内。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_gather_nd.rst b/docs/api/api_python/ops/mindspore.ops.func_gather_nd.rst index 52a8d8dcbe4..acd0d4699a2 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_gather_nd.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_gather_nd.rst @@ -12,15 +12,12 @@ mindspore.ops.gather_nd `indices` 的最后一维的长度不能超过 `input_x` 的秩： :math:`indices.shape[-1] <= input\_x.rank` 。 - **参数：** + 参数： + - **input_x** (Tensor) - GatherNd的输入。任意维度的Tensor。 + - **indices** (Tensor) - 索引Tensor，其数据类型为int32或int64。 - - **input_x** (Tensor) - GatherNd的输入。任意维度的Tensor。 - - **indices** (Tensor) - 索引Tensor，其数据类型为int32或int64。 + 返回： + Tensor，数据类型与 `input_x` 相同，shape为 `indices_shape[:-1] + input_x_shape[indices_shape[-1]:]` 。 - **返回：** - - Tensor，数据类型与 `input_x` 相同，shape为 `indices_shape[:-1] + input_x_shape[indices_shape[-1]:]` 。 - - **异常：** - - - **ValueError** - `input_x` 的shape长度小于 `indices` 的最后一维的长度。 + 异常： + - **ValueError** - `input_x` 的shape长度小于 `indices` 的最后一维的长度。