edit the Chinese api describe.

This commit is contained in:
GongLiyao 2021-12-18 22:53:06 +08:00
parent 4705d5dce2
commit e5089d48da
2 changed files with 22 additions and 22 deletions

View File

@ -13,7 +13,7 @@ mindspore.common.initializer
.. py:class:: mindspore.common.initializer.TruncatedNormal(sigma=0.01)
生成一个数组用于初始化Tensor,数组中的数值从截断正态分布中采样得到
生成一个服从截断正态(高斯)分布的随机数组用于初始化Tensor。
**参数:**
@ -28,7 +28,7 @@ mindspore.common.initializer
.. py:class:: mindspore.common.initializer.Normal(sigma=0.01, mean=0.0)
生成一个数组用于初始化Tensor数组中的数值从正态分布N(sigma, mean)中采样得到
生成一个服从正态分布N(sigma, mean)的随机数组用于初始化Tensor
.. math::
f(x) = \frac{1} {\sqrt{2*π} * sigma}exp(-\frac{(x - mean)^2} {2*{sigma}^2})
@ -47,7 +47,7 @@ mindspore.common.initializer
.. py:class:: mindspore.common.initializer.Uniform(scale=0.07)
生成一个数组用于初始化Tensor数组中的数值从均匀分布U(-scale, scale)中采样得到
生成一个服从均匀分布U(-scale, scale)的随机数组用于初始化Tensor
**参数:**
@ -62,13 +62,13 @@ mindspore.common.initializer
.. py:class:: mindspore.common.initializer.HeUniform(negative_slope=0, mode="fan_in", nonlinearity="leaky_relu")
生成一个数组用于初始化Tensor数组中的数值从HeKaiming均匀分布U[-boundary,boundary]中采样得到,其中
生成一个服从HeKaiming均匀分布U(-boundary, boundary)的随机数组用于初始化Tensor。
HeKaiming均匀分布范围的上下界
.. math::
boundary = \sqrt{\frac{6}{(1 + a^2) \times \text{fan_in}}}
是HeUniform分布的边界。
**参数:**
- **negative_slope** (int, float, bool) - 本层激活函数的负数区间斜率(仅适用于非线性激活函数"leaky_relu"默认值为0。
@ -84,7 +84,7 @@ mindspore.common.initializer
.. py:class:: mindspore.common.initializer.HeNormal(negative_slope=0, mode="fan_in", nonlinearity="leaky_relu")
生成一个数组用于初始化Tensor数组中的数值从HeKaiming正态分布N(0, sigma^2)中采样得到,其中
生成一个服从HeKaiming正态分布N(0, sigma^2)的随机数组用于初始化Tensor其中
.. math::
sigma = \frac{gain} {\sqrt{N}}
@ -108,7 +108,7 @@ mindspore.common.initializer
.. py:class:: mindspore.common.initializer.XavierUniform(gain=1)
生成一个数组用于初始化Tensor数组中的数值从Xarvier均匀分布U[-boundary,boundary]中采样得到,其中
生成一个服从Xarvier均匀分布U(-boundary, boundary)的随机数组用于初始化Tensor均匀分布的取值范围为[-boundary, boundary],其中:
.. math::
boundary = gain * \sqrt{\frac{6}{n_{in} + n_{out}}}
@ -180,7 +180,7 @@ mindspore.common.initializer
- **str** - `init` 是继承自 `Initializer` 的类的别名,实际使用时会调用相应的类。`init` 的值可以是"normal"、"ones"或"zeros"等。
- **Initializer** - `init` 是继承自 `Initializer` 用于初始化Tensor的类。
- **numbers.Number** - 调用常量来初始化张量。
- **numbers.Number** - 用于初始化Tensor的常量。
- **shape** (Union[[tuple, list, int]) - 被初始化的Tensor的shape默认值为None。
- **dtype** (mindspore.dtype) 被初始化的Tensor的数据类型默认值为 `mindspore.float32`
@ -192,7 +192,7 @@ mindspore.common.initializer
**异常:**
- **TypeError** - 参数 `init` 的类型不正确。
- **ValueError** - 通过 `init` 传入的Tensor的shape和作为参数传入的shape不一致。
- **ValueError** - `init` 传入Tensor对象时 `init` 的shape与形参 `shape` 内的数值不一致。
**样例:**

View File

@ -63,17 +63,17 @@ mindspore.communication
.. py:class:: mindspore.communication.get_group_size(group=GlobalComm.WORLD_COMM_GROUP)
获取指定通信组的设备总数
获取指定通信组实例的rank_size
.. note:: `get_group_size` 方法应该在 `init` 方法之后使用。
**参数:**
- **group** (str) - 通信组名称,通常由 `create_group` 方法创建,否则将使用默认组。默认值:WORLD_COMM_GROUP
- **group** (str) - 指定工作组实例(由 create_group 方法创建的名称支持数据类型为str默认值为WORLD_COMM_GROUP
**返回:**
int, 指定通信组的设备总数
指定通信组实例的rank_size数据类型为int
**异常:**
@ -118,7 +118,7 @@ mindspore.communication
.. py:class:: mindspore.communication.get_group_rank_from_world_rank(world_rank_id, group)
由通信集群中的全局设备序号获取指定用户通信组中的设备序号
由通信集群中的全局设备序号获取指定用户通信组中的rank ID
.. note::
- GPU 版本的MindSpore不支持此方法
@ -127,12 +127,12 @@ mindspore.communication
**参数:**
- **world_rank_id** (`int`) - 通信集群内的全局设备序号
- **group** (`str`) - 传入的通信组名称,通常由 `create_group` 方法创建
- **world_rank_id** (`int`) - 通信集群内的全局rank ID
- **group** (`str`) - 指定通信组实例(由 create_group 方法创建)的名称
**返回:**
int, 当前用户通信组中的设备序号
当前通信组内的rank_ID数据类型为int
**异常:**
@ -153,7 +153,7 @@ mindspore.communication
.. py:class:: mindspore.communication.create_group(group, rank_ids)
创建用户通信组。
创建用户自定义的通信组实例
.. note::
- GPU 版本的MindSpore不支持此方法
@ -163,7 +163,7 @@ mindspore.communication
**参数:**
- **group** (str) - 将被创建的通信组名称
- **group** (str) - 输入用户自定义的通信组实例名称支持数据类型为str
- **rank_ids** (list) - 设备编号列表。
**异常:**
@ -227,7 +227,7 @@ mindspore.communication
.. py:class:: mindspore.communication.destroy_group(group)
用户通信组。
销用户通信组。
.. note::
- GPU 版本的MindSpore不支持此方法
@ -236,7 +236,7 @@ mindspore.communication
**参数:**
- **group** (str) - 将被销毁的通信组,通常由 `create_group` 方法创建
- **group** (str) - 被注销通信组实例(通常由 create_group 方法创建)的名称
**异常:**