diff --git a/docs/api/api_python/dataset/mindspore.dataset.GraphData.rst b/docs/api/api_python/dataset/mindspore.dataset.GraphData.rst index 002865401ca..6670eb588a9 100644 --- a/docs/api/api_python/dataset/mindspore.dataset.GraphData.rst +++ b/docs/api/api_python/dataset/mindspore.dataset.GraphData.rst @@ -29,10 +29,6 @@ mindspore.dataset.GraphData - **ValueError:** - `port` 参数不在范围[1024, 65535]内。 - **ValueError:** - `num_client` 参数不在范围[1, 255]内。 - **支持平台：**: - - - ``CPU`` - .. py:method:: get_all_edges(edge_type) 获取图的所有边。 diff --git a/docs/api/api_python/mindspore/mindspore.run_check.rst b/docs/api/api_python/mindspore/mindspore.run_check.rst index 78bf00f2741..7504fbe593c 100644 --- a/docs/api/api_python/mindspore/mindspore.run_check.rst +++ b/docs/api/api_python/mindspore/mindspore.run_check.rst @@ -4,10 +4,3 @@ mindspore.run_check .. py:method:: mindspore.run_check() 提供了便捷的API用以查询MindSpore的安装是否成功。 - - **样例:** - - >>> import mindspore - >>> mindspore.run_check() - MindSpore version: xxx - The result of multiplication calculation is correct, MindSpore has been installed successfully! \ No newline at end of file diff --git a/docs/api/api_python/nn/mindspore.nn.Conv1d.rst b/docs/api/api_python/nn/mindspore.nn.Conv1d.rst index 6f020b138b4..5e5ce41fc29 100644 --- a/docs/api/api_python/nn/mindspore.nn.Conv1d.rst +++ b/docs/api/api_python/nn/mindspore.nn.Conv1d.rst @@ -30,7 +30,7 @@ mindspore.nn.Conv1d - pad：对输入进行填充。在输入对两侧填充 `padding` 大小的0。如果设置此模式， `padding` 的值必须大于或等于0。 - **padding** (int) - 输入两侧填充的数量。值应该要大于等于0，默认值：0。 - - **dilation** (int) - 一维卷积核膨胀尺寸。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。 ｀k｀ 取值范围为[1, L]。默认值：1。 + - **dilation** (int) - 一维卷积核膨胀尺寸。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。 `k` 取值范围为[1, L]。默认值：1。 - **group** (int) - 将过滤器拆分为组， `in_channels` 和 `out_channels` 必须可被 `group` 整除。默认值：1。 - **has_bias** (bool) - Conv1d层是否添加偏置参数。默认值：False。 - **weight_init** (Union[Tensor, str, Initializer, numbers.Number]) - 权重参数的初始化方法。它可以是Tensor，str，Initializer或numbers.Number。当使用str时，可选"TruncatedNormal"，"Normal"，"Uniform"，"HeUniform"和"XavierUniform"分布以及常量"One"和"Zero"分布的值，可接受别名"xavier_uniform"，"he_uniform"，"ones"和"zeros"。上述字符串大小写均可。更多细节请参考Initializer的值。默认值："normal"。 diff --git a/docs/api/api_python/nn/mindspore.nn.Conv1dTranspose.rst b/docs/api/api_python/nn/mindspore.nn.Conv1dTranspose.rst index a403ba53f41..874bd64fa59 100644 --- a/docs/api/api_python/nn/mindspore.nn.Conv1dTranspose.rst +++ b/docs/api/api_python/nn/mindspore.nn.Conv1dTranspose.rst @@ -24,7 +24,7 @@ mindspore.nn.Conv1dTranspose - pad：对输入进行填充。在输入对两侧填充 `padding` 大小的0。如果设置此模式， `padding` 必须大于或等于0。 - **padding** (int) - 输入两侧填充的数量。默认值：0。 - - **dilation** (int) - 一维卷积核膨胀尺寸。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。 ｀k｀ 取值范围为[1, L]。默认值：1。 + - **dilation** (int) - 一维卷积核膨胀尺寸。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。 `k` 取值范围为[1, L]。默认值：1。 - **group** (int) - 将过滤器拆分为组， `in_channels` 和 `out_channels` 必须可被 `group` 整除。当 `group` 大于1时，暂不支持Ascend平台。默认值：1。 - **has_bias** (bool) - Conv1dTranspose层是否添加偏置参数。默认值：False。 - **weight_init** (Union[Tensor, str, Initializer, numbers.Number]) - 权重参数的初始化方法。它可以是Tensor，str，Initializer或numbers.Number。当使用str时，可选"TruncatedNormal"，"Normal"，"Uniform"，"HeUniform"和"XavierUniform"分布以及常量"One"和"Zero"分布的值，可接受别名"xavier_uniform"，"he_uniform"，"ones"和"zeros"。上述字符串大小写均可。更多细节请参考Initializer的值。默认值："normal"。 diff --git a/docs/api/api_python/nn/mindspore.nn.Conv2d.rst b/docs/api/api_python/nn/mindspore.nn.Conv2d.rst index 95fd9825315..5746f6b4327 100644 --- a/docs/api/api_python/nn/mindspore.nn.Conv2d.rst +++ b/docs/api/api_python/nn/mindspore.nn.Conv2d.rst @@ -29,7 +29,7 @@ mindspore.nn.Conv2d - **pad**：对输入进行填充。在输入的高度和宽度方向上填充 `padding` 大小的0。如果设置此模式， `padding` 必须大于或等于0。 - **padding** (`Union[int, tuple[int]]`) – 输入的高度和宽度方向上填充的数量。数据类型为int或包含4个整数的tuple。如果 `padding` 是一个整数，那么上、下、左、右的填充都等于 `padding` 。如果 `padding` 是一个有4个整数的tuple，那么上、下、左、右的填充分别等于 `padding[0]` 、 `padding[1]` 、 `padding[2]` 和 `padding[3]` 。值应该要大于等于0，默认值：0。 - - **dilation** (`Union[int, tuple[int]]`) – 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。垂直和水平方向上的 ｀k｀ ，其取值范围分别为[1, H]和[1, W]。默认值：1。 + - **dilation** (`Union[int, tuple[int]]`) – 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。垂直和水平方向上的 `k` ，其取值范围分别为[1, H]和[1, W]。默认值：1。 - **group** (`int`) – 将过滤器拆分为组， `in_channels` 和 `out_channels` 必须可被 `group` 整除。如果组数等于 `in_channels` 和 `out_channels` ，这个二维卷积层也被称为二维深度卷积层。默认值：1. - **has_bias** (`bool`) – Conv2d层是否添加偏置参数。默认值：False。 - **weight_init** (Union[Tensor, str, Initializer, numbers.Number]) - 权重参数的初始化方法。它可以是Tensor，str，Initializer或numbers.Number。当使用str时，可选"TruncatedNormal"，"Normal"，"Uniform"，"HeUniform"和"XavierUniform"分布以及常量"One"和"Zero"分布的值，可接受别名"xavier_uniform"，"he_uniform"，"ones"和"zeros"。上述字符串大小写均可。更多细节请参考Initializer的值。默认值："normal"。 diff --git a/docs/api/api_python/nn/mindspore.nn.Conv2dTranspose.rst b/docs/api/api_python/nn/mindspore.nn.Conv2dTranspose.rst index d8ef3c4a6ac..a5abb4470c0 100644 --- a/docs/api/api_python/nn/mindspore.nn.Conv2dTranspose.rst +++ b/docs/api/api_python/nn/mindspore.nn.Conv2dTranspose.rst @@ -24,7 +24,7 @@ mindspore.nn.Conv2dTranspose - **pad**：对输入进行填充。在输入的高度和宽度方向上填充 `padding` 大小的0。如果设置此模式， `padding` 必须大于或等于0。 - **padding** (`Union[int, tuple[int]]`) – 输入的高度和宽度方向上填充的数量。数据类型为整型或包含四个整数的tuple。如果 `padding` 是一个整数，那么上、下、左、右的填充都等于 `padding` 。如果 `padding` 是一个有四个整数的tuple，那么上、下、左、右的填充分别等于 `padding[0]` 、 `padding[1]` 、 `padding[2]` 和 `padding[3]` 。值应该要大于等于0，默认值：0。 - - **dilation** (`Union[int, tuple[int]]`) – 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。高度和宽度方向上的 ｀k｀ ，其取值范围分别为[1, H]和[1, W]。默认值：1。 + - **dilation** (`Union[int, tuple[int]]`) – 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。高度和宽度方向上的 `k` ，其取值范围分别为[1, H]和[1, W]。默认值：1。 - **group** (`int`) – 将过滤器拆分为组， `in_channels` 和 `out_channels` 必须可被 `group` 整除。如果组数等于 `in_channels` 和 `out_channels` ，这个二维卷积层也被称为二维深度卷积层。默认值：1. - **has_bias** (`bool`) – Conv2dTranspose层是否添加偏置参数。默认值：False。 - **weight_init** (Union[Tensor, str, Initializer, numbers.Number]) - 权重参数的初始化方法。它可以是Tensor，str，Initializer或numbers.Number。当使用str时，可选"TruncatedNormal"，"Normal"，"Uniform"，"HeUniform"和"XavierUniform"分布以及常量"One"和"Zero"分布的值，可接受别名"xavier_uniform"，"he_uniform"，"ones"和"zeros"。上述字符串大小写均可。更多细节请参考Initializer的值。默认值："normal"。 diff --git a/docs/api/api_python/nn/mindspore.nn.L1Loss.rst b/docs/api/api_python/nn/mindspore.nn.L1Loss.rst index abfbf27674c..128fc93c210 100644 --- a/docs/api/api_python/nn/mindspore.nn.L1Loss.rst +++ b/docs/api/api_python/nn/mindspore.nn.L1Loss.rst @@ -34,5 +34,5 @@ mindspore.nn.L1Loss **异常：** - **ValueError** - `reduction` 不为"mean"、"sum"或"none"。 - **ValueError** - `logits` 和 `labels` 有不同的shape，且不能互相广播。 + - **ValueError** - `reduction` 不为"mean"、"sum"或"none"。 + - **ValueError** - `logits` 和 `labels` 有不同的shape，且不能互相广播。