diff --git a/docs/api/api_python/mindspore.Tensor.rst b/docs/api/api_python/mindspore.Tensor.rst deleted file mode 100644 index 89e6dd29aaf..00000000000 --- a/docs/api/api_python/mindspore.Tensor.rst +++ /dev/null @@ -1,1014 +0,0 @@ - .. py:method:: argmax(axis=None) - - 返回指定轴上最大值的索引。 - - **参数：** - - **axis** (int, optional) - 默认情况下，返回扁平化Tensor的最大值序号，否则返回指定轴方向上。 - - **返回：** - - Tensor，最大值的索引。它具有与此Tensor相同的shape，但移除了轴方向上的维度。 - - **异常：** - - **ValueError** - 轴超出了范围。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.arange(10, 16).reshape(2, 3).astype("float32")) - >>> print(a.argmax()) - 5 - - .. py:method:: argmin(axis=None) - - 返回指定轴上最小值的索引。 - - **参数：** - - **axis** (int, optional) - 返回扁平化Tensor的最小值序号，否则返回指定轴方向上的最小值序号。默认值: None。 - - **返回：** - - Tensor，最小Tensor的索引。它与Tensor的shape相同，但移除了轴方向上的维度。 - - **异常：** - - **ValueError** - 轴超出了范围。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.arange(10, 16).reshape(2, 3).astype("float32")) - >>> print(a.argmin()) - 0 - - .. py:method:: astype(dtype, copy=True) - - 返回Tensor的副本，并将其转换为指定类型。 - - **参数：** - - - **dtype** (Union[`mindspore.dtype`, str]) - 指定的Tensor数据类型，可以是: `mindspore.dtype.float32` 或 `float32` 的格式。默认值：`mindspore.dtype.float32` 。 - - **copy** (bool, optional) - 默认情况下，astype返回新拷贝的Tensor。如果该参数设为False，则返回输入Tensor而不是副本。默认值：True。 - - **返回：** - - Tensor，指定数据类型的Tensor。 - - **异常：** - - **TypeError** - 指定了无法解析的类型。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.ones((1,2,2,1), dtype=np.float32)) - >>> x = x.astype("int32") - >>> print(x.dtype) - Int32 - - .. py:method:: choose(choices, mode='clip') - - 通过索引数组和Tensor数组中构造一个Tensor。 - - **参数：** - - - **choices** (Union[tuple, list, Tensor]) - 选择数组。输入的索引数组和 `choose` 广播维度必须相同。如果 `choices` 本身是一个数组，则其最外层的维度（即，对应于 `choices.shape[0]` 的维度）被用来定义长度。 - - **mode** ('raise', 'wrap', 'clip', optional) - 指定如何处理 `[0, n-1]` 外部的索引： - - - **raise** – 引发异常（默认）； - - **wrap** – 绕接； - - **clip** – 裁剪到范围。`clip` 模式意味着所有过大的索引都将替换为在轴方向上寻址最后一个元素的索引。注：这将禁用具有负数的索引。 - - **返回：** - - Tensor，合并后的结果。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **异常：** - - **ValueError** - 输入Tensor和任一 `choices` 无法广播。 - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> choices = [[0, 1, 2, 3], [10, 11, 12, 13], [20, 21, 22, 23], [30, 31, 32, 33]] - >>> x = Tensor(np.array([2, 3, 1, 0])) - >>> print(x.choose(choices)) - [20 31 12 3] - - .. py:method:: clip(xmin, xmax, dtype=None) - - 裁剪Tensor中的值。 - - 给定一个区间，区间外的值将被裁剪到区间边缘。 - 例如，如果指定的间隔为 :math:`[0, 1]` ，则小于0的值将变为0，大于1的值将变为1。 - - .. note:: - 目前不支持裁剪 `xmin=nan` 或 `xmax=nan` 。 - - **参数：** - - - **xmin** (Tensor, scalar, None) - 最小值。如果值为None，则不在间隔的下边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。 - - **xmax** (Tensor, scalar, None) - 最大值。如果值为None，则不在间隔的上边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。如果 `xmin` 或 `xmax` 是Tensor，则三个Tensor将被广播进行shape匹配。 - - **dtype** (`mindspore.dtype` , optional) - 覆盖输出Tensor的dtype。默认值为None。 - - **返回：** - - Tensor，含有输入Tensor的元素，其中values < `xmin` 被替换为 `xmin` ，values > `xmax` 被替换为 `xmax` 。 - - **异常：** - - - **TypeError** - 输入的类型与Tensor不一致。 - - **ValueError** - 输入与Tensor的shape不能广播，或者 `xmin` 和 `xmax` 都是 `None` 。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> from mindspore import Tensor - >>> x = Tensor([1, 2, 3, -4, 0, 3, 2, 0]).astype("float32") - >>> output = x.clip(0, 2) - >>> print(output) - [1.2.2.0.0.2.2.0.] - - .. py:method:: copy() - - 返回复制的Tensor。 - - .. note:: - 当前实现不支持类似NumPy的 `order` 参数。 - - **返回：** - - 复制的Tensor。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.ones((3,3)).astype("float32")) - >>> output = a.copy() - >>> print(output) - [[1.1.1.] - [1.1.1.] - [1.1.1.]] - - .. py:method:: cumsum(axis=None, dtype=None) - - 返回指定轴方向上元素的累加值。 - - .. note:: - 如果 `dtype` 为 `int8` , `int16` 或 `bool` ，则结果 `dtype` 将提升为 `int32` ，不支持 `int64` 。 - - **参数：** - - - **axis** (int, optional) - 轴，在该轴方向上的累积和。其默认值（None）用来计算扁平轴上的累加和。 - - **dtype** (`mindspore.dtype`, optional) - 如果未指定参数值，则保持与原始Tensor相同，除非参数值是一个精度小于 :class:`float32` 的整数。在这种情况下，使用 `float32` 。默认值：None。 - - **异常：** - - **ValueError** - 轴超出范围。 - - **返回：** - - Tensor。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.ones((3,3)).astype("float32")) - >>> output = a.cumsum(axis=0) - >>> print(output) - [[1.1.1.] - [2.2.2.] - [3.3.3.]] - - .. py:method:: diagonal(offset=0, axis1=0, axis2=1) - - 返回指定的对角线。 - - **参数：** - - - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 - - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 - - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 - - **返回：** - - Tensor，如果Tensor是二维，则返回值是一维数组。 - - **异常：** - - **ValueError** - 输入Tensor的维度少于2。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.arange(4).reshape(2, 2)) - >>> print(a) - [[0 1] - [2 3]] - >>> output = a.diagonal() - >>> print(output) - [0 3] - - .. py:method:: fill(value) - - 用标量值填充数组。 - - .. note:: - 与NumPy不同，Tensor.fill()将始终返回一个新的Tensor，而不是填充原来的Tensor。 - - **参数：** - - **value** (Union[None, int, float, bool]) - 所有元素都被赋予这个值。 - - **返回：** - - Tensor，与原来的dtype和shape相同的Tensor。 - - **异常：** - - **TypeError** - 输入参数具有前面未指定的类型。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.arange(4).reshape((2,2)).astype('float32')) - >>> print(a.fill(1.0)) - [[1.1.] - [1.1.]] - - .. py:method:: flatten(order='C') - - 返回展开成一维的Tensor的副本。 - - **参数：** - - **order** (str, optional) - 可以在'C'和'F'之间进行选择。'C'表示按行优先（C风格）顺序展开。'F'表示按列优先顺序（Fortran风格）进行扁平化。仅支持'C'和'F'。默认值：C。 - - **返回：** - - Tensor，具有与输入相同的数据类型。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **异常：** - - - **TypeError** - `order` 不是字符串类型。 - - **ValueError** - `order` 是字符串类型，但不是'C'或'F'。 - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.ones((2,3,4), dtype=np.float32)) - >>> output = x.flatten() - >>> print(output.shape) - (24,) - - .. py:method:: flush_from_cache() - - 如果Tensor开启缓存作用，则将缓存数据刷新到host侧。 - - .. py:method:: has_init - :property: - - Tensor是否已经初始化。 - - .. py:method:: init_data(slice_index=None, shape=None, opt_shard_group=None) - - 获取此Tensor的数据。 - 对于同一个Tensor，只可以调用一次init_data函数。 - - **参数：** - - - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 - - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 - - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数的切片。默认值：None。 - - **返回：** - - 初始化的Tensor。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import mindspore as ms - >>> import mindspore.common.initializer as init - >>> x = init.initializer(init.Constant(1), [2, 2], ms.float32) - >>> out = x.init_data() - >>> print(out) - [[1.1.] - [1.1.]] - - .. py:method:: item(index=None) - - 使用索引从Tensor中获取值。 - - .. note:: - Tensor.item返回的是Tensor标量，而不是Python标量。 - - **参数：** - - **index** (Union[None, int, tuple(int)]) - Tensor的索引。默认值：None。 - - **返回：** - - Tensor标量，dtype与原始Tensor的相同。 - - **异常：** - - **ValueError** - `index` 的长度不等于Tensor的ndim。 - - **支持平台：** - - ``Ascend`` ``GPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.array([[1,2,3],[4,5,6]], dtype=np.float32)) - >>> x = x.item((0,1)) - >>> print(x) - 2.0 - - .. py:method:: itemset(*args) - - 将标量插入到Tensor（并将标量转换为Tensor的数据类型）。 - - 必须至少有1个参数，并且最后一个参数被定义为项。 - Tensor.itemset(\*args)等同于 :math:`Tensor[args] = item` 。 - - **参数：** - - **args** (Union[(numbers.Number), (int/tuple(int), numbers.Number)]) - 指定索引和值的参数。如果 `args` 包含一个参数（标量），则其仅在Tensor大小为1的情况下使用。如果 `args` 包含两个参数，则最后一个参数是要设置的值且必须是标量，而第一个参数指定单个Tensor元素的位置。参数值是整数或者元组。 - - **返回：** - - 一个新的Tensor，其值为 :math:`Tensor[args] = item` 。 - - **异常：** - - - **ValueError** - 第一个参数的长度不等于Tensor的ndim。 - - **IndexError** - 只提供了一个参数，并且原来的Tensor不是标量。 - - **支持平台：** - - ``Ascend`` ``GPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.array([[1,2,3],[4,5,6]], dtype=np.float32)) - >>> x = x.itemset((0,1), 4) - >>> print(x) - [[1.4.3.] - [4.5.6.]] - - .. py:method:: itemsize - :property: - - 返回一个Tensor元素的长度（以字节为单位）。 - - .. py:method:: max(axis=None, keepdims=False, initial=None, where=True) - - 返回Tensor的最大值或轴方向上的最大值。 - - **参数：** - - - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最大值，而不是在单个轴或所有轴上进行选择。默认值：None。 - - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 - - **initial** (scalar, optional) - 输出元素的最小值。该参数必须设置，才能对空切片进行计算。默认值：None。 - - **where** (bool Tensor, optional) - 一个bool数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 - - **返回：** - - Tensor或标量，输入Tensor的最大值。如果 `axis` 为None，则结果是一个标量值。如果提供了 `axis` ，则结果是Tensor ndim - 1维度的一个数组。 - - **异常：** - - **TypeError** - 参数具有前面未指定的类型。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.arange(4).reshape((2, 2)).astype('float32')) - >>> output = a.max() - >>> print(output) - 3.0 - - .. py:method:: min(axis=None, keepdims=False, initial=None, where=True) - - 返回Tensor的最小值或轴方向上的最小值。 - - **参数：** - - - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最小值，而不是在单个轴或所有轴上进行选择。默认值：None。 - - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 - - **initial** (scalar, optional) - 输出元素的最大值。该参数必须设置，才能对空切片进行计算。默认值：None。 - - **where** (bool Tensor, optional) - 一个布尔数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 - - **返回：** - - Tensor或标量，输入Tensor的最小值。如果轴为None，则结果为一个标量值。如果提供了 `axis` ，则结果是Tensor.ndim - 1维度的一个数组。 - - **异常：** - - **TypeError** - 参数具有前面未指定的类型。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> import mindspore.numpy as np - >>> a = Tensor(np.arange(4).reshape((2,2)).astype('float32')) - >>> output = a.min() - >>> print(output) - 0.0 - - .. py:method:: nbytes - :property: - - 返回Tensor占用的总字节数。 - - .. py:method:: ndim - :property: - - 返回Tensor维度的数量。 - - .. py:method:: ptp(axis=None, keepdims=False) - - 该函数名称是"peak to peak"的缩写。 - - .. note:: - 不支持NumPy参数 `dtype` 和 `out` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 轴，在轴方向上可以计算范围。默认计算扁平数组的方差。默认值：None。 - - **keepdims** (bool) - 如果设为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果将针对输入数组正确传递。默认值为False。 - - **返回：** - - Tensor。 - - **异常：** - - **TypeError** - `self` 不是Tensor，或者 `axis` 和 `keepdims` 具有前面未指定的类型。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> from mindspore import Tensor - >>> x = Tensor([[4.0, 9.0, 2.0, 10.0], [6.0, 9.0, 7.0, 12.0]]).astype("float32") - >>> print(x.ptp(axis=1)) - [8.6.] - >>> print(x.ptp(axis=0)) - [2.0.5.2.] - - .. py:method:: ravel() - - 返回一个展开的一维Tensor。 - - **返回：** - - 一维Tensor，含有与输入相同的元素。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.ones((2,3,4), dtype=np.float32)) - >>> output = x.ravel() - >>> print(output.shape) - (24,) - - .. py:method:: repeat(repeats, axis=None) - - 对数组中的元素进行重复复制。 - - **参数：** - - - **repeats** (Union[int, tuple, list]) - 每个元素的重复次数，`repeats` 被广播以适应指定轴的shape。 - - **axis** (int, optional) - 轴方向上的重复值。默认情况下，使用展开的输入Tensor，并返回一个展开的输出Tensor。 - - **返回：** - - Tensor，除了维度外，与输入Tensor具有相同的shape。 - - **异常：** - - - **ValueError** - 维度超出范围。 - - **TypeError** - 参数类型不匹配。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.array(3)) - >>> print(x.repeat(4)) - [3 3 3 3] - >>> x = Tensor(np.array([[1, 2],[3, 4]])) - >>> print(x.repeat(2)) - [1 1 2 2 3 3 4 4] - >>> print(x.repeat(3, axis=1)) - [[1 1 1 2 2 2] - [3 3 3 4 4 4]] - >>> print(x.repeat([1,2], axis=0)) - [[1 2] - [3 4] - [3 4]] - - .. py:method:: reshape(*shape) - - 不改变数据的情况下，为Tensor提供新的shape。 - - **参数：** - - **shape** (Union[int, tuple(int), list(int)]) - 新的shape应与原来的shape兼容。如果参数值为整数，则结果是该长度的一维数组。shape的维度可以为-1。在这种情况下，将根据数组的长度和剩下的维度计算出该值。 - - **返回：** - - Tensor，具有新shape的Tensor。 - - **异常：** - - - **TypeError** - 新shape不是整数、列表或元组。 - - **ValueError** - 新shape与原来Tensor的shape不兼容。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> from mindspore import Tensor - >>> from mindspore import dtype as mstype - >>> x = Tensor([[-0.1, 0.3, 3.6], [0.4, 0.5, -3.2]], dtype=mstype.float32) - >>> output = x.reshape((3, 2)) - >>> print(output) - [[-0.1 0.3] - [ 3.6 0.4] - [ 0.5 -3.2]] - - .. py:method:: resize(*new_shape) - - 更改Tensor的shape。 - - .. note:: - 此方法不更改输入数组的大小，也不返回NumPy中的任何内容，而是返回一个具有输入大小的新Tensor。不支持Numpy参数 `refcheck` 。 - - **参数：** - - **new_shape** (Union[ints, tuple of ints]) - 指定Tensor的新shape。 - - **返回：** - - Tensor。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.array([[0, 1], [2, 3]])) - >>> x = x.resize(2, 3) - >>> print(x) - [[0 1 2] - [3 0 0]] - - .. py:method:: searchsorted(v, side='left', sorter=None) - - 查找应插入元素以保存顺序的位置索引。 - - **参数：** - - - **v** (Union[int, float, bool, list, tuple, Tensor]) - 要插入元素的值。 - - **side** ('left', 'right', optional) - 如果参数值为'left'，则给出找到的第一个合适位置的索引。如果参数值为'right'，则返回最后一个这样的索引。如果没有合适的索引，则返回0或N（其中N是Tensor的长度）。默认值：`left` 。 - - **sorter** (Union[int, float, bool, list, tuple, Tensor]) - 整数索引的可选一维数组，将Tensor按升序排序。它们通常是NumPy argsort方法的结果。 - - **返回：** - - Tensor，shape与 `v` 相同的插入点数组。 - - **异常：** - - **ValueError** - `side` 或 `sorter` 的参数无效。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.array([1, 2, 3, 4, 5])) - >>> print(x.searchsorted(3)) - 2 - - .. py:method:: shape - :property: - - 返回Tensor的shape。 - - .. py:method:: size - :property: - - 返回Tensor中的元素总数。 - - .. py:method:: squeeze(axis=None) - - 从Tensor中删除shape为1的维度。 - - **参数：** - - **axis** (Union[None, int, list(int), tuple(int)], optional) - 选择shape中长度为1的条目的子集。如果选择shape条目长度大于1的轴，则报错。默认值为None。 - - **返回：** - - Tensor，删除了长度为1的维度的全部子集或一个子集。 - - **异常：** - - - **TypeError** - 输入的参数类型有误。 - - **ValueError** - 指定维度的shape大于1。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.ones((1,2,2,1), dtype=np.float32)) - >>> x = x.squeeze() - >>> print(x.shape) - (2, 2) - - .. py:method:: std(axis=None, ddof=0, keepdims=False) - - 计算指定维度的标准差。 - 标准差是方差的算术平方根，如：:math:`std = sqrt(mean(abs(x - x.mean())**2))` 。 - - 返回标准差。默认情况下计算展开数组的标准差，否则在指定维度上计算。 - - .. note:: - 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 在该维度上计算标准差。默认值：`None` 。如果为 `None` ，则计算展开数组的标准偏差。 - - **ddof** (int) - δ自由度。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。默认值：0。 - - **keepdims** - 默认值：`False`。 - - **返回：** - - 含有标准差数值的Tensor。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> input_x = Tensor(np.array([1, 2, 3, 4], dtype=np.float32)) - >>> output = input_x.std() - >>> print(output) - 1.118034 - - .. py:method:: strides - :property: - - Tensor上每个维度跨度的字节元组。 - - .. py:method:: sum(axis=None, dtype=None, keepdims=False, initial=None) - - 返回指定维度上数组元素的总和。 - - .. note:: - 不支持NumPy参数 `out` 、 `where` 、 `casting` 、 `order` 、 `subok` 、 `signature` 和 `extobj` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 指定维度，在该维度方向上进行求和运算。默认值：None。如果参数值为None，会计算输入数组中所有元素的和。如果axis为负数，则从最后一维开始往第一维计算。如果axis为整数元组，会对该元组指定的所有轴方向上的元素进行求和。 - - **dtype** (`mindspore.dtype`, optional) - 默认值为None。会覆盖输出Tensor的dtype。 - - **keepdims** (bool) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。如果设为默认值，那么keepdims不会被传递给ndarray子类的sum方法。但是任何非默认值都会被传递。如果子类的方法未实现keepdims，则引发异常。默认值：`False`。 - - **initial** (scalar) - 初始化的起始值。默认值：`None` 。 - - **返回：** - - Tensor。具有与输入相同shape的Tensor，删除了指定的轴。如果输入Tensor是0维数组，或axis为None时，返回一个标量。 - - **异常：** - - - **TypeError** - input不是Tensor，`axis` 不是整数或整数元组，`keepdims` 不是整数，或者 `initial` 不是标量。 - - **ValueError** - 任意轴超出范围或存在重复的轴。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> input_x = Tensor(np.array([-1, 0, 1]).astype(np.float32)) - >>> print(input_x.sum()) - 0.0 - >>> input_x = Tensor(np.arange(10).reshape(2, 5).astype(np.float32)) - >>> print(input_x.sum(axis=1)) - [10.35.] - - .. py:method:: swapaxes(axis1, axis2) - - 交换Tensor的两个维度。 - - **参数：** - - - **axis1** (int) - 第一个维度。 - - **axis2** (int) - 第二个维度。 - - **返回：** - - 转化后的Tensor，与输入具有相同的数据类型。 - - **异常：** - - - **TypeError** - `axis1` 或 `axis2` 不是整数。 - - **ValueError** - `axis1` 或 `axis2` 不在 `[-ndim, ndim-1]` 范围内。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.ones((2,3,4), dtype=np.float32)) - >>> output = x.swapaxes(0, 2) - >>> print(output.shape) - (4,3,2) - - .. py:method:: T - - 返回被转置后的Tensor。 - - .. py:method:: take(indices, axis=None, mode='clip') - - 在指定维度上获取Tensor中的元素。 - - **参数：** - - - **indices** (Tensor) - 待提取的值的shape为 `(Nj...)` 的索引。 - - **axis** (int, optional) - 在指定维度上选择值。默认情况下，使用展开的输入数组。默认值：`None` 。 - - **mode** ('raise', 'wrap', 'clip', optional) - - - edge：填充Tensor的边缘值。 - - raise：引发错误。 - - wrap：绕接。 - - clip：裁剪到范围。 `clip` 模式意味着所有过大的索引都会被在指定轴方向上指向最后一个元素的索引替换。注：这将禁用具有负数的索引。默认值：`clip` 。 - - **返回：** - - Tensor，索引的结果。 - - **异常：** - - **ValueError** - `axis` 超出范围，或 `mode` 被设置为'raise'、'wrap'和'clip'以外的值。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> a = Tensor(np.array([4, 3, 5, 7, 6, 8])) - >>> indices = Tensor(np.array([0, 1, 4])) - >>> output = a.take(indices) - >>> print(output) - [4 3 6] - - .. py:method:: to_tensor(slice_index=None, shape=None, opt_shard_group=None) - - 返回init_data()的结果，并获取此Tensor的数据。 - - .. note:: - 不建议使用 `to_tensor`。请使用 `init_data` 。 - - **参数：** - - - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 - - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 - - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数切片的分片。默认值：None。 - - **返回：** - - 初始化的Tensor。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import mindspore as ms - >>> import mindspore.common.initializer as init - >>> x = init.initializer(init.Constant(1), [2, 2], ms.float32) - >>> out = x.to_tensor() - >>> print(out) - [[1.1.] - [1.1.]] - - .. py:method:: trace(offset=0, axis1=0, axis2=1, dtype=None) - - 在Tensor的对角线方向上的总和。 - - **参数：** - - - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 - - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 - - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 - - **dtype** (`mindspore.dtype`, optional) - 默认值为None。覆盖输出Tensor的dtype。 - - **返回：** - - Tensor，对角线方向上的总和。 - - **异常：** - - **ValueError** - 输入Tensor的维度少于2。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.eye(3, dtype=np.float32)) - >>> print(x.trace()) - 3.0 - - .. py:method:: transpose(*axes) - - 返回被转置后的Tensor。 - - - 对于一维Tensor，这没有影响，因为转置后的向量是相同的。 - - 对于二维Tensor，是标准的矩阵转置。 - - 对于n维Tensor，如果提供了维度，则它们的顺序代表维度的置换方式。 - - 如果未提供轴，且Tensor.shape等于(i[0], i[1],...i[n-2], i[n-1])，则Tensor.transpose().shape等于(i[n-1], i[n-2], ... i[1], i[0])。 - - **参数：** - - **axes** (Union[None, tuple(int), list(int), int], optional) - 如果axes为None或未设置，则该方法将反转维度。如果axes为tuple(int)或list(int)，则Tensor.transpose()把Tensor转置为新的维度。如果axes为整数，则此表单仅作为元组/列表表单的备选。 - - **返回：** - - Tensor，具有与输入Tensor相同的维度，其中维度被准确的排列。 - - **异常：** - - - **TypeError** - 输入参数类型有误。 - - **ValueError** - `axes` 的数量不等于Tensor.ndim。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> x = Tensor(np.ones((1,2,3), dtype=np.float32)) - >>> x = x.transpose() - >>> print(x.shape) - (3, 2, 1) - - .. py:method:: var(axis=None, ddof=0, keepdims=False) - - 在指定维度上的方差。 - - 方差是平均值的平方偏差的平均值，即：:math:`var = mean(abs(x - x.mean())**2)`。 - - 返回方差值。默认情况下计算展开Tensor的方差，否则在指定维度上计算。 - - .. note:: - 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 - - **参数：** - - - **axis** (Union[None, int, tuple(int)]) - 维度，在指定维度上计算方差。其默认值是展开Tensor的方差。默认值：`None` 。 - - **ddof** (int) - δ自由度。默认值：0。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。 - - **keepdims** (bool) - 默认值：`False` 。 - - **支持平台：** - - ``Ascend`` ``GPU`` ``CPU`` - - **返回：** - - 含有方差值的Tensor。 - - **样例：** - - >>> import numpy as np - >>> from mindspore import Tensor - >>> input_x = Tensor(np.array([1., 2., 3., 4.], np.float32)) - >>> output = input_x.var() - >>> print(output) - 1.25 - - .. py:method:: view(*shape) - - 根据输入shape重新创建一个Tensor，与原Tensor数据相同。 - - **参数：** - - **shape** (Union[tuple(int), int]) - 输出Tensor的维度。 - - **返回：** - - Tensor，具有与输入shape相同的维度。 diff --git a/docs/api/api_python/mindspore.nn.probability.rst b/docs/api/api_python/mindspore.nn.probability.rst new file mode 100644 index 00000000000..a656f3d0d0c --- /dev/null +++ b/docs/api/api_python/mindspore.nn.probability.rst @@ -0,0 +1,43 @@ +mindspore.nn.probability +============================ + +.. py:class:: mindspore.nn.probability + + 用于构造概率网络的高级组件。 + +Bijectors +--------- + +.. cnmsplatformautosummary:: + :toctree: nn_probability + + mindspore.nn.Metric + mindspore.nn.probability.bijector.Bijector + mindspore.nn.probability.bijector.Exp + mindspore.nn.probability.bijector.GumbelCDF + mindspore.nn.probability.bijector.Invert + mindspore.nn.probability.bijector.PowerTransform + mindspore.nn.probability.bijector.ScalarAffine + mindspore.nn.probability.bijector.Softplus + +Distributions +------------- + +.. cnmsplatformautosummary:: + :toctree: nn_probability + + mindspore.nn.probability.distribution.Bernoulli + mindspore.nn.probability.distribution.Beta + mindspore.nn.probability.distribution.Categorical + mindspore.nn.probability.distribution.Cauchy + mindspore.nn.probability.distribution.Distribution + mindspore.nn.probability.distribution.Exponential + mindspore.nn.probability.distribution.Gamma + mindspore.nn.probability.distribution.Geometric + mindspore.nn.probability.distribution.Gumbel + mindspore.nn.probability.distribution.LogNormal + mindspore.nn.probability.distribution.Logistic + mindspore.nn.probability.distribution.Normal + mindspore.nn.probability.distribution.Poisson + mindspore.nn.probability.distribution.TransformedDistribution + mindspore.nn.probability.distribution.Uniform diff --git a/docs/api/api_python/mindspore.nn.rst b/docs/api/api_python/mindspore.nn.rst index 93886238c88..e43cd31afeb 100644 --- a/docs/api/api_python/mindspore.nn.rst +++ b/docs/api/api_python/mindspore.nn.rst @@ -1,6 +1,24 @@ mindspore.nn ============= +Cell +---- + +.. cnmsplatformautosummary:: + :toctree: nn + + mindspore.nn.Cell + +Dynamic Learning Rate +--------------------- + +.. cnmsplatformautosummary:: + :toctree: nn + + mindspore.nn.CosineDecayLR + mindspore.nn.ExponentialDecayLR + mindspore.nn.WarmUpLR + Gradient --------- diff --git a/docs/api/api_python/mindspore.rst b/docs/api/api_python/mindspore.rst index c10721b61b2..dcdaa1213ad 100644 --- a/docs/api/api_python/mindspore.rst +++ b/docs/api/api_python/mindspore.rst @@ -35,7 +35,11 @@ Serialization :toctree: mindspore mindspore.build_searched_strategy + mindspore.export + mindspore.load_checkpoint + mindspore.load_param_into_net mindspore.merge_sliced_parameter + mindspore.save_checkpoint JIT --- diff --git a/docs/api/api_python/mindspore.train.rst b/docs/api/api_python/mindspore.train.rst new file mode 100644 index 00000000000..58d494cff8f --- /dev/null +++ b/docs/api/api_python/mindspore.train.rst @@ -0,0 +1,20 @@ +mindspore.train +=============== + +.. include:: mindspore.train/mindspore.train.summary.rst + +.. include:: mindspore.train/mindspore.train.callback.Callback.rst + +.. include:: mindspore.train/mindspore.train.callback.LossMonitor.rst + +.. include:: mindspore.train/mindspore.train.callback.TimeMonitor.rst + +.. include:: mindspore.train/mindspore.train.callback.ModelCheckpoint.rst + +.. include:: mindspore.train/mindspore.train.SummaryCollector.rst + +.. include:: mindspore.train/mindspore.train.callback.CheckpointConfig.rst + +.. include:: mindspore.train/mindspore.train.callback.RunContext.rst + +.. include:: mindspore.train/mindspore.train.callback.LearningRateScheduler.rst diff --git a/docs/api/api_python/mindspore.train/mindspore.train.callback.rst b/docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst similarity index 100% rename from docs/api/api_python/mindspore.train/mindspore.train.callback.rst rename to docs/api/api_python/mindspore.train/mindspore.train.SummaryCollector.rst diff --git a/docs/api/api_python/mindspore/mindspore.Tensor.rst b/docs/api/api_python/mindspore/mindspore.Tensor.rst index f1f2b12be6b..4bbd64f1af6 100644 --- a/docs/api/api_python/mindspore/mindspore.Tensor.rst +++ b/docs/api/api_python/mindspore/mindspore.Tensor.rst @@ -173,3 +173,1018 @@ mindspore.Tensor >>> output = input_x.mean() >>> print(output) 2.0 + + .. py:method:: argmax(axis=None) + + 返回指定轴上最大值的索引。 + + **参数：** + + **axis** (int, optional) - 默认情况下，返回扁平化Tensor的最大值序号，否则返回指定轴方向上。 + + **返回：** + + Tensor，最大值的索引。它具有与此Tensor相同的shape，但移除了轴方向上的维度。 + + **异常：** + + **ValueError** - 轴超出了范围。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.arange(10, 16).reshape(2, 3).astype("float32")) + >>> print(a.argmax()) + 5 + + .. py:method:: argmin(axis=None) + + 返回指定轴上最小值的索引。 + + **参数：** + + **axis** (int, optional) - 返回扁平化Tensor的最小值序号，否则返回指定轴方向上的最小值序号。默认值: None。 + + **返回：** + + Tensor，最小Tensor的索引。它与Tensor的shape相同，但移除了轴方向上的维度。 + + **异常：** + + **ValueError** - 轴超出了范围。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.arange(10, 16).reshape(2, 3).astype("float32")) + >>> print(a.argmin()) + 0 + + .. py:method:: astype(dtype, copy=True) + + 返回Tensor的副本，并将其转换为指定类型。 + + **参数：** + + - **dtype** (Union[`mindspore.dtype`, str]) - 指定的Tensor数据类型，可以是: `mindspore.dtype.float32` 或 `float32` 的格式。默认值：`mindspore.dtype.float32` 。 + - **copy** (bool, optional) - 默认情况下，astype返回新拷贝的Tensor。如果该参数设为False，则返回输入Tensor而不是副本。默认值：True。 + + **返回：** + + Tensor，指定数据类型的Tensor。 + + **异常：** + + **TypeError** - 指定了无法解析的类型。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.ones((1,2,2,1), dtype=np.float32)) + >>> x = x.astype("int32") + >>> print(x.dtype) + Int32 + + .. py:method:: choose(choices, mode='clip') + + 通过索引数组和Tensor数组中构造一个Tensor。 + + **参数：** + + - **choices** (Union[tuple, list, Tensor]) - 选择数组。输入的索引数组和 `choose` 广播维度必须相同。如果 `choices` 本身是一个数组，则其最外层的维度（即，对应于 `choices.shape[0]` 的维度）被用来定义长度。 + - **mode** ('raise', 'wrap', 'clip', optional) - 指定如何处理 `[0, n-1]` 外部的索引： + + - **raise** – 引发异常（默认）； + - **wrap** – 绕接； + - **clip** – 裁剪到范围。`clip` 模式意味着所有过大的索引都将替换为在轴方向上寻址最后一个元素的索引。注：这将禁用具有负数的索引。 + + **返回：** + + Tensor，合并后的结果。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **异常：** + + **ValueError** - 输入Tensor和任一 `choices` 无法广播。 + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> choices = [[0, 1, 2, 3], [10, 11, 12, 13], [20, 21, 22, 23], [30, 31, 32, 33]] + >>> x = Tensor(np.array([2, 3, 1, 0])) + >>> print(x.choose(choices)) + [20 31 12 3] + + .. py:method:: clip(xmin, xmax, dtype=None) + + 裁剪Tensor中的值。 + + 给定一个区间，区间外的值将被裁剪到区间边缘。 + 例如，如果指定的间隔为 :math:`[0, 1]` ，则小于0的值将变为0，大于1的值将变为1。 + + .. note:: + 目前不支持裁剪 `xmin=nan` 或 `xmax=nan` 。 + + **参数：** + + - **xmin** (Tensor, scalar, None) - 最小值。如果值为None，则不在间隔的下边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。 + - **xmax** (Tensor, scalar, None) - 最大值。如果值为None，则不在间隔的上边缘执行裁剪操作。`xmin` 或 `xmax` 只能有一个为None。如果 `xmin` 或 `xmax` 是Tensor，则三个Tensor将被广播进行shape匹配。 + - **dtype** (`mindspore.dtype` , optional) - 覆盖输出Tensor的dtype。默认值为None。 + + **返回：** + + Tensor，含有输入Tensor的元素，其中values < `xmin` 被替换为 `xmin` ，values > `xmax` 被替换为 `xmax` 。 + + **异常：** + + - **TypeError** - 输入的类型与Tensor不一致。 + - **ValueError** - 输入与Tensor的shape不能广播，或者 `xmin` 和 `xmax` 都是 `None` 。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> from mindspore import Tensor + >>> x = Tensor([1, 2, 3, -4, 0, 3, 2, 0]).astype("float32") + >>> output = x.clip(0, 2) + >>> print(output) + [1.2.2.0.0.2.2.0.] + + .. py:method:: copy() + + 返回复制的Tensor。 + + .. note:: + 当前实现不支持类似NumPy的 `order` 参数。 + + **返回：** + + 复制的Tensor。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.ones((3,3)).astype("float32")) + >>> output = a.copy() + >>> print(output) + [[1.1.1.] + [1.1.1.] + [1.1.1.]] + + .. py:method:: cumsum(axis=None, dtype=None) + + 返回指定轴方向上元素的累加值。 + + .. note:: + 如果 `dtype` 为 `int8` , `int16` 或 `bool` ，则结果 `dtype` 将提升为 `int32` ，不支持 `int64` 。 + + **参数：** + + - **axis** (int, optional) - 轴，在该轴方向上的累积和。其默认值（None）用来计算扁平轴上的累加和。 + - **dtype** (`mindspore.dtype`, optional) - 如果未指定参数值，则保持与原始Tensor相同，除非参数值是一个精度小于 :class:`float32` 的整数。在这种情况下，使用 `float32` 。默认值：None。 + + **异常：** + + **ValueError** - 轴超出范围。 + + **返回：** + + Tensor。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.ones((3,3)).astype("float32")) + >>> output = a.cumsum(axis=0) + >>> print(output) + [[1.1.1.] + [2.2.2.] + [3.3.3.]] + + .. py:method:: diagonal(offset=0, axis1=0, axis2=1) + + 返回指定的对角线。 + + **参数：** + + - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 + - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 + - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 + + **返回：** + + Tensor，如果Tensor是二维，则返回值是一维数组。 + + **异常：** + + **ValueError** - 输入Tensor的维度少于2。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.arange(4).reshape(2, 2)) + >>> print(a) + [[0 1] + [2 3]] + >>> output = a.diagonal() + >>> print(output) + [0 3] + + .. py:method:: fill(value) + + 用标量值填充数组。 + + .. note:: + 与NumPy不同，Tensor.fill()将始终返回一个新的Tensor，而不是填充原来的Tensor。 + + **参数：** + + **value** (Union[None, int, float, bool]) - 所有元素都被赋予这个值。 + + **返回：** + + Tensor，与原来的dtype和shape相同的Tensor。 + + **异常：** + + **TypeError** - 输入参数具有前面未指定的类型。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.arange(4).reshape((2,2)).astype('float32')) + >>> print(a.fill(1.0)) + [[1.1.] + [1.1.]] + + .. py:method:: flatten(order='C') + + 返回展开成一维的Tensor的副本。 + + **参数：** + + **order** (str, optional) - 可以在'C'和'F'之间进行选择。'C'表示按行优先（C风格）顺序展开。'F'表示按列优先顺序（Fortran风格）进行扁平化。仅支持'C'和'F'。默认值：C。 + + **返回：** + + Tensor，具有与输入相同的数据类型。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **异常：** + + - **TypeError** - `order` 不是字符串类型。 + - **ValueError** - `order` 是字符串类型，但不是'C'或'F'。 + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.ones((2,3,4), dtype=np.float32)) + >>> output = x.flatten() + >>> print(output.shape) + (24,) + + .. py:method:: flush_from_cache() + + 如果Tensor开启缓存作用，则将缓存数据刷新到host侧。 + + .. py:method:: has_init + :property: + + Tensor是否已经初始化。 + + .. py:method:: init_data(slice_index=None, shape=None, opt_shard_group=None) + + 获取此Tensor的数据。 + 对于同一个Tensor，只可以调用一次init_data函数。 + + **参数：** + + - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 + - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 + - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数的切片。默认值：None。 + + **返回：** + + 初始化的Tensor。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import mindspore as ms + >>> import mindspore.common.initializer as init + >>> x = init.initializer(init.Constant(1), [2, 2], ms.float32) + >>> out = x.init_data() + >>> print(out) + [[1.1.] + [1.1.]] + + .. py:method:: item(index=None) + + 使用索引从Tensor中获取值。 + + .. note:: + Tensor.item返回的是Tensor标量，而不是Python标量。 + + **参数：** + + **index** (Union[None, int, tuple(int)]) - Tensor的索引。默认值：None。 + + **返回：** + + Tensor标量，dtype与原始Tensor的相同。 + + **异常：** + + **ValueError** - `index` 的长度不等于Tensor的ndim。 + + **支持平台：** + + ``Ascend`` ``GPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.array([[1,2,3],[4,5,6]], dtype=np.float32)) + >>> x = x.item((0,1)) + >>> print(x) + 2.0 + + .. py:method:: itemset(*args) + + 将标量插入到Tensor（并将标量转换为Tensor的数据类型）。 + + 必须至少有1个参数，并且最后一个参数被定义为项。 + Tensor.itemset(\*args)等同于 :math:`Tensor[args] = item` 。 + + **参数：** + + **args** (Union[(numbers.Number), (int/tuple(int), numbers.Number)]) - 指定索引和值的参数。如果 `args` 包含一个参数（标量），则其仅在Tensor大小为1的情况下使用。如果 `args` 包含两个参数，则最后一个参数是要设置的值且必须是标量，而第一个参数指定单个Tensor元素的位置。参数值是整数或者元组。 + + **返回：** + + 一个新的Tensor，其值为 :math:`Tensor[args] = item` 。 + + **异常：** + + - **ValueError** - 第一个参数的长度不等于Tensor的ndim。 + - **IndexError** - 只提供了一个参数，并且原来的Tensor不是标量。 + + **支持平台：** + + ``Ascend`` ``GPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.array([[1,2,3],[4,5,6]], dtype=np.float32)) + >>> x = x.itemset((0,1), 4) + >>> print(x) + [[1.4.3.] + [4.5.6.]] + + .. py:method:: itemsize + :property: + + 返回一个Tensor元素的长度（以字节为单位）。 + + .. py:method:: max(axis=None, keepdims=False, initial=None, where=True) + + 返回Tensor的最大值或轴方向上的最大值。 + + **参数：** + + - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最大值，而不是在单个轴或所有轴上进行选择。默认值：None。 + - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 + - **initial** (scalar, optional) - 输出元素的最小值。该参数必须设置，才能对空切片进行计算。默认值：None。 + - **where** (bool Tensor, optional) - 一个bool数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 + + **返回：** + + Tensor或标量，输入Tensor的最大值。如果 `axis` 为None，则结果是一个标量值。如果提供了 `axis` ，则结果是Tensor ndim - 1维度的一个数组。 + + **异常：** + + **TypeError** - 参数具有前面未指定的类型。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.arange(4).reshape((2, 2)).astype('float32')) + >>> output = a.max() + >>> print(output) + 3.0 + + .. py:method:: min(axis=None, keepdims=False, initial=None, where=True) + + 返回Tensor的最小值或轴方向上的最小值。 + + **参数：** + + - **axis** (Union[None, int, tuple of ints], optional) - 轴，在该轴方向上进行操作。默认情况下，使用扁平输入。如果该参数为整数元组，则在多个轴上选择最小值，而不是在单个轴或所有轴上进行选择。默认值：None。 + - **keepdims** (bool, optional) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。默认值：False。 + - **initial** (scalar, optional) - 输出元素的最大值。该参数必须设置，才能对空切片进行计算。默认值：None。 + - **where** (bool Tensor, optional) - 一个布尔数组，被广播以匹配数组维度和选择包含在降维中的元素。如果传递了一个非默认值，则还必须提供初始值。默认值：True。 + + **返回：** + + Tensor或标量，输入Tensor的最小值。如果轴为None，则结果为一个标量值。如果提供了 `axis` ，则结果是Tensor.ndim - 1维度的一个数组。 + + **异常：** + + **TypeError** - 参数具有前面未指定的类型。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> import mindspore.numpy as np + >>> a = Tensor(np.arange(4).reshape((2,2)).astype('float32')) + >>> output = a.min() + >>> print(output) + 0.0 + + .. py:method:: nbytes + :property: + + 返回Tensor占用的总字节数。 + + .. py:method:: ndim + :property: + + 返回Tensor维度的数量。 + + .. py:method:: ptp(axis=None, keepdims=False) + + 该函数名称是"peak to peak"的缩写。 + + .. note:: + 不支持NumPy参数 `dtype` 和 `out` 。 + + **参数：** + + - **axis** (Union[None, int, tuple(int)]) - 轴，在轴方向上可以计算范围。默认计算扁平数组的方差。默认值：None。 + - **keepdims** (bool) - 如果设为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果将针对输入数组正确传递。默认值为False。 + + **返回：** + + Tensor。 + + **异常：** + + **TypeError** - `self` 不是Tensor，或者 `axis` 和 `keepdims` 具有前面未指定的类型。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> from mindspore import Tensor + >>> x = Tensor([[4.0, 9.0, 2.0, 10.0], [6.0, 9.0, 7.0, 12.0]]).astype("float32") + >>> print(x.ptp(axis=1)) + [8.6.] + >>> print(x.ptp(axis=0)) + [2.0.5.2.] + + .. py:method:: ravel() + + 返回一个展开的一维Tensor。 + + **返回：** + + 一维Tensor，含有与输入相同的元素。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.ones((2,3,4), dtype=np.float32)) + >>> output = x.ravel() + >>> print(output.shape) + (24,) + + .. py:method:: repeat(repeats, axis=None) + + 对数组中的元素进行重复复制。 + + **参数：** + + - **repeats** (Union[int, tuple, list]) - 每个元素的重复次数，`repeats` 被广播以适应指定轴的shape。 + - **axis** (int, optional) - 轴方向上的重复值。默认情况下，使用展开的输入Tensor，并返回一个展开的输出Tensor。 + + **返回：** + + Tensor，除了维度外，与输入Tensor具有相同的shape。 + + **异常：** + + - **ValueError** - 维度超出范围。 + - **TypeError** - 参数类型不匹配。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.array(3)) + >>> print(x.repeat(4)) + [3 3 3 3] + >>> x = Tensor(np.array([[1, 2],[3, 4]])) + >>> print(x.repeat(2)) + [1 1 2 2 3 3 4 4] + >>> print(x.repeat(3, axis=1)) + [[1 1 1 2 2 2] + [3 3 3 4 4 4]] + >>> print(x.repeat([1,2], axis=0)) + [[1 2] + [3 4] + [3 4]] + + .. py:method:: reshape(*shape) + + 不改变数据的情况下，为Tensor提供新的shape。 + + **参数：** + + **shape** (Union[int, tuple(int), list(int)]) - 新的shape应与原来的shape兼容。如果参数值为整数，则结果是该长度的一维数组。shape的维度可以为-1。在这种情况下，将根据数组的长度和剩下的维度计算出该值。 + + **返回：** + + Tensor，具有新shape的Tensor。 + + **异常：** + + - **TypeError** - 新shape不是整数、列表或元组。 + - **ValueError** - 新shape与原来Tensor的shape不兼容。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> from mindspore import Tensor + >>> from mindspore import dtype as mstype + >>> x = Tensor([[-0.1, 0.3, 3.6], [0.4, 0.5, -3.2]], dtype=mstype.float32) + >>> output = x.reshape((3, 2)) + >>> print(output) + [[-0.1 0.3] + [ 3.6 0.4] + [ 0.5 -3.2]] + + .. py:method:: resize(*new_shape) + + 更改Tensor的shape。 + + .. note:: + 此方法不更改输入数组的大小，也不返回NumPy中的任何内容，而是返回一个具有输入大小的新Tensor。不支持Numpy参数 `refcheck` 。 + + **参数：** + + **new_shape** (Union[ints, tuple of ints]) - 指定Tensor的新shape。 + + **返回：** + + Tensor。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.array([[0, 1], [2, 3]])) + >>> x = x.resize(2, 3) + >>> print(x) + [[0 1 2] + [3 0 0]] + + .. py:method:: searchsorted(v, side='left', sorter=None) + + 查找应插入元素以保存顺序的位置索引。 + + **参数：** + + - **v** (Union[int, float, bool, list, tuple, Tensor]) - 要插入元素的值。 + - **side** ('left', 'right', optional) - 如果参数值为'left'，则给出找到的第一个合适位置的索引。如果参数值为'right'，则返回最后一个这样的索引。如果没有合适的索引，则返回0或N（其中N是Tensor的长度）。默认值：`left` 。 + - **sorter** (Union[int, float, bool, list, tuple, Tensor]) - 整数索引的可选一维数组，将Tensor按升序排序。它们通常是NumPy argsort方法的结果。 + + **返回：** + + Tensor，shape与 `v` 相同的插入点数组。 + + **异常：** + + **ValueError** - `side` 或 `sorter` 的参数无效。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.array([1, 2, 3, 4, 5])) + >>> print(x.searchsorted(3)) + 2 + + .. py:method:: shape + :property: + + 返回Tensor的shape。 + + .. py:method:: size + :property: + + 返回Tensor中的元素总数。 + + .. py:method:: squeeze(axis=None) + + 从Tensor中删除shape为1的维度。 + + **参数：** + + **axis** (Union[None, int, list(int), tuple(int)], optional) - 选择shape中长度为1的条目的子集。如果选择shape条目长度大于1的轴，则报错。默认值为None。 + + **返回：** + + Tensor，删除了长度为1的维度的全部子集或一个子集。 + + **异常：** + + - **TypeError** - 输入的参数类型有误。 + - **ValueError** - 指定维度的shape大于1。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.ones((1,2,2,1), dtype=np.float32)) + >>> x = x.squeeze() + >>> print(x.shape) + (2, 2) + + .. py:method:: std(axis=None, ddof=0, keepdims=False) + + 计算指定维度的标准差。 + 标准差是方差的算术平方根，如：:math:`std = sqrt(mean(abs(x - x.mean())**2))` 。 + + 返回标准差。默认情况下计算展开数组的标准差，否则在指定维度上计算。 + + .. note:: + 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 + + **参数：** + + - **axis** (Union[None, int, tuple(int)]) - 在该维度上计算标准差。默认值：`None` 。如果为 `None` ，则计算展开数组的标准偏差。 + - **ddof** (int) - δ自由度。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。默认值：0。 + - **keepdims** - 默认值：`False`。 + + **返回：** + + 含有标准差数值的Tensor。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> input_x = Tensor(np.array([1, 2, 3, 4], dtype=np.float32)) + >>> output = input_x.std() + >>> print(output) + 1.118034 + + .. py:method:: strides + :property: + + Tensor上每个维度跨度的字节元组。 + + .. py:method:: sum(axis=None, dtype=None, keepdims=False, initial=None) + + 返回指定维度上数组元素的总和。 + + .. note:: + 不支持NumPy参数 `out` 、 `where` 、 `casting` 、 `order` 、 `subok` 、 `signature` 和 `extobj` 。 + + **参数：** + + - **axis** (Union[None, int, tuple(int)]) - 指定维度，在该维度方向上进行求和运算。默认值：None。如果参数值为None，会计算输入数组中所有元素的和。如果axis为负数，则从最后一维开始往第一维计算。如果axis为整数元组，会对该元组指定的所有轴方向上的元素进行求和。 + - **dtype** (`mindspore.dtype`, optional) - 默认值为None。会覆盖输出Tensor的dtype。 + - **keepdims** (bool) - 如果这个参数为True，被删去的维度保留在结果中，且维度大小设为1。有了这个选项，结果就可以与输入数组进行正确的广播运算。如果设为默认值，那么keepdims不会被传递给ndarray子类的sum方法。但是任何非默认值都会被传递。如果子类的方法未实现keepdims，则引发异常。默认值：`False`。 + - **initial** (scalar) - 初始化的起始值。默认值：`None` 。 + + **返回：** + + Tensor。具有与输入相同shape的Tensor，删除了指定的轴。如果输入Tensor是0维数组，或axis为None时，返回一个标量。 + + **异常：** + + - **TypeError** - input不是Tensor，`axis` 不是整数或整数元组，`keepdims` 不是整数，或者 `initial` 不是标量。 + - **ValueError** - 任意轴超出范围或存在重复的轴。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> input_x = Tensor(np.array([-1, 0, 1]).astype(np.float32)) + >>> print(input_x.sum()) + 0.0 + >>> input_x = Tensor(np.arange(10).reshape(2, 5).astype(np.float32)) + >>> print(input_x.sum(axis=1)) + [10.35.] + + .. py:method:: swapaxes(axis1, axis2) + + 交换Tensor的两个维度。 + + **参数：** + + - **axis1** (int) - 第一个维度。 + - **axis2** (int) - 第二个维度。 + + **返回：** + + 转化后的Tensor，与输入具有相同的数据类型。 + + **异常：** + + - **TypeError** - `axis1` 或 `axis2` 不是整数。 + - **ValueError** - `axis1` 或 `axis2` 不在 `[-ndim, ndim-1]` 范围内。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.ones((2,3,4), dtype=np.float32)) + >>> output = x.swapaxes(0, 2) + >>> print(output.shape) + (4,3,2) + + .. py:method:: T + + 返回被转置后的Tensor。 + + .. py:method:: take(indices, axis=None, mode='clip') + + 在指定维度上获取Tensor中的元素。 + + **参数：** + + - **indices** (Tensor) - 待提取的值的shape为 `(Nj...)` 的索引。 + - **axis** (int, optional) - 在指定维度上选择值。默认情况下，使用展开的输入数组。默认值：`None` 。 + - **mode** ('raise', 'wrap', 'clip', optional) + + - edge：填充Tensor的边缘值。 + - raise：引发错误。 + - wrap：绕接。 + - clip：裁剪到范围。 `clip` 模式意味着所有过大的索引都会被在指定轴方向上指向最后一个元素的索引替换。注：这将禁用具有负数的索引。默认值：`clip` 。 + + **返回：** + + Tensor，索引的结果。 + + **异常：** + + **ValueError** - `axis` 超出范围，或 `mode` 被设置为'raise'、'wrap'和'clip'以外的值。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> a = Tensor(np.array([4, 3, 5, 7, 6, 8])) + >>> indices = Tensor(np.array([0, 1, 4])) + >>> output = a.take(indices) + >>> print(output) + [4 3 6] + + .. py:method:: to_tensor(slice_index=None, shape=None, opt_shard_group=None) + + 返回init_data()的结果，并获取此Tensor的数据。 + + .. note:: + 不建议使用 `to_tensor`。请使用 `init_data` 。 + + **参数：** + + - **slice_index** (int) - 参数切片的索引。在初始化参数切片的时候使用，保证使用相同切片的设备可以生成相同的Tensor。默认值：None。 + - **shape** (list[int]) - 切片的shape，在初始化参数切片时使用。默认值：None。 + - **opt_shard_group** (str) - 优化器分片组，在自动或半自动并行模式下用于获取参数切片的分片。默认值：None。 + + **返回：** + + 初始化的Tensor。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import mindspore as ms + >>> import mindspore.common.initializer as init + >>> x = init.initializer(init.Constant(1), [2, 2], ms.float32) + >>> out = x.to_tensor() + >>> print(out) + [[1.1.] + [1.1.]] + + .. py:method:: trace(offset=0, axis1=0, axis2=1, dtype=None) + + 在Tensor的对角线方向上的总和。 + + **参数：** + + - **offset** (int, optional) - 对角线与主对角线的偏移。可以是正值或负值。默认为主对角线。 + - **axis1** (int, optional) - 二维子数组的第一轴，对角线应该从这里开始。默认为第一轴(0)。 + - **axis2** (int, optional) - 二维子数组的第二轴，对角线应该从这里开始。默认为第二轴。 + - **dtype** (`mindspore.dtype`, optional) - 默认值为None。覆盖输出Tensor的dtype。 + + **返回：** + + Tensor，对角线方向上的总和。 + + **异常：** + + **ValueError** - 输入Tensor的维度少于2。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.eye(3, dtype=np.float32)) + >>> print(x.trace()) + 3.0 + + .. py:method:: transpose(*axes) + + 返回被转置后的Tensor。 + + - 对于一维Tensor，这没有影响，因为转置后的向量是相同的。 + - 对于二维Tensor，是标准的矩阵转置。 + - 对于n维Tensor，如果提供了维度，则它们的顺序代表维度的置换方式。 + + 如果未提供轴，且Tensor.shape等于(i[0], i[1],...i[n-2], i[n-1])，则Tensor.transpose().shape等于(i[n-1], i[n-2], ... i[1], i[0])。 + + **参数：** + + **axes** (Union[None, tuple(int), list(int), int], optional) - 如果axes为None或未设置，则该方法将反转维度。如果axes为tuple(int)或list(int)，则Tensor.transpose()把Tensor转置为新的维度。如果axes为整数，则此表单仅作为元组/列表表单的备选。 + + **返回：** + + Tensor，具有与输入Tensor相同的维度，其中维度被准确的排列。 + + **异常：** + + - **TypeError** - 输入参数类型有误。 + - **ValueError** - `axes` 的数量不等于Tensor.ndim。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> x = Tensor(np.ones((1,2,3), dtype=np.float32)) + >>> x = x.transpose() + >>> print(x.shape) + (3, 2, 1) + + .. py:method:: var(axis=None, ddof=0, keepdims=False) + + 在指定维度上的方差。 + + 方差是平均值的平方偏差的平均值，即：:math:`var = mean(abs(x - x.mean())**2)`。 + + 返回方差值。默认情况下计算展开Tensor的方差，否则在指定维度上计算。 + + .. note:: + 不支持NumPy参数 `dtype` 、 `out` 和 `where` 。 + + **参数：** + + - **axis** (Union[None, int, tuple(int)]) - 维度，在指定维度上计算方差。其默认值是展开Tensor的方差。默认值：`None` 。 + - **ddof** (int) - δ自由度。默认值：0。计算中使用的除数是 :math:`N - ddof` ，其中 :math:`N` 表示元素的数量。 + - **keepdims** (bool) - 默认值：`False` 。 + + **支持平台：** + + ``Ascend`` ``GPU`` ``CPU`` + + **返回：** + + 含有方差值的Tensor。 + + **样例：** + + >>> import numpy as np + >>> from mindspore import Tensor + >>> input_x = Tensor(np.array([1., 2., 3., 4.], np.float32)) + >>> output = input_x.var() + >>> print(output) + 1.25 + + .. py:method:: view(*shape) + + 根据输入shape重新创建一个Tensor，与原Tensor数据相同。 + + **参数：** + + **shape** (Union[tuple(int), int]) - 输出Tensor的维度。 + + **返回：** + + Tensor，具有与输入shape相同的维度。 diff --git a/docs/api/api_python/mindspore.export.rst b/docs/api/api_python/mindspore/mindspore.export.rst similarity index 98% rename from docs/api/api_python/mindspore.export.rst rename to docs/api/api_python/mindspore/mindspore.export.rst index 878b8beaeff..f2646c4906c 100644 --- a/docs/api/api_python/mindspore.export.rst +++ b/docs/api/api_python/mindspore/mindspore.export.rst @@ -1,39 +1,39 @@ -mindspore.export -================= - -.. py:class:: mindspore.export(net, *inputs, file_name, file_format="AIR", **kwargs) - - 将MindSpore网络模型导出为指定格式的文件。 - - .. note:: - - 当导出文件格式为AIR、ONNX时，单个Tensor的大小不能超过2GB。 - - 当file_name 没有后缀时，系统会根据file_format 自动添加后缀。 - - **参数：** - - - **net** (Cell) – MindSpore网络结构。 - - **inputs** (Tensor) – 网络的输入，如果网络有多个输入，需要将张量组成元组。 - - **file_name** (str) – 导出模型的文件名称。 - - **file_format** (str) – MindSpore目前支持导出"AIR"，"ONNX"和"MINDIR"格式的模型。 - - - **AIR** - Ascend Intermediate Representation。一种Ascend模型的中间表示格式。推荐的输出文件后缀是".air"。 - - **ONNX** - Open Neural Network eXchange。一种针对机器学习所设计的开放式的文件格式。推荐的输出文件后缀是“.onnx”。 - - **MINDIR** - MindSpore Native Intermediate Representation for Anf。一种MindSpore模型的中间表示格式。推荐的输出文件后缀是".mindir"。 - - - **kwargs** (dict) – 配置选项字典。 - - - **quant_mode** (str) - 如果网络是量化感知训练网络，那么quant_mode需要设置为"QUANT"，否则 `quant_mode` 需要设置为"NONQUANT"。 - - **mean** (float) - 预处理后输入数据的平均值，用于量化网络的第一层。默认值：127.5。 - - **std_dev** (float) - 预处理后输入数据的方差，用于量化网络的第一层。默认值：127.5。 - - **enc_key** (str) - 用于加密的字节类型密钥，有效长度为16、24或者32。 - - **enc_mode** (str) - 指定加密模式，当设置 `enc_key` 时，选项有："AES-GCM"，"AES-CBC"。默认值："AES-GCM"。 - - **dataset** (Dataset) - 指定数据集的预处理方法，用于将数据集的预处理导入MindIR。 - - **样例：** - - >>> import numpy as np - >>> from mindspore import export, Tensor - >>> - >>> net = LeNet() - >>> input = Tensor(np.ones([1, 1, 32, 32]).astype(np.float32)) - >>> export(net, Tensor(input), file_name='lenet', file_format='MINDIR') +mindspore.export +================= + +.. py:class:: mindspore.export(net, *inputs, file_name, file_format="AIR", **kwargs) + + 将MindSpore网络模型导出为指定格式的文件。 + + .. note:: + - 当导出文件格式为AIR、ONNX时，单个Tensor的大小不能超过2GB。 + - 当file_name 没有后缀时，系统会根据file_format 自动添加后缀。 + + **参数：** + + - **net** (Cell) – MindSpore网络结构。 + - **inputs** (Tensor) – 网络的输入，如果网络有多个输入，需要将张量组成元组。 + - **file_name** (str) – 导出模型的文件名称。 + - **file_format** (str) – MindSpore目前支持导出"AIR"，"ONNX"和"MINDIR"格式的模型。 + + - **AIR** - Ascend Intermediate Representation。一种Ascend模型的中间表示格式。推荐的输出文件后缀是".air"。 + - **ONNX** - Open Neural Network eXchange。一种针对机器学习所设计的开放式的文件格式。推荐的输出文件后缀是“.onnx”。 + - **MINDIR** - MindSpore Native Intermediate Representation for Anf。一种MindSpore模型的中间表示格式。推荐的输出文件后缀是".mindir"。 + + - **kwargs** (dict) – 配置选项字典。 + + - **quant_mode** (str) - 如果网络是量化感知训练网络，那么quant_mode需要设置为"QUANT"，否则 `quant_mode` 需要设置为"NONQUANT"。 + - **mean** (float) - 预处理后输入数据的平均值，用于量化网络的第一层。默认值：127.5。 + - **std_dev** (float) - 预处理后输入数据的方差，用于量化网络的第一层。默认值：127.5。 + - **enc_key** (str) - 用于加密的字节类型密钥，有效长度为16、24或者32。 + - **enc_mode** (str) - 指定加密模式，当设置 `enc_key` 时，选项有："AES-GCM"，"AES-CBC"。默认值："AES-GCM"。 + - **dataset** (Dataset) - 指定数据集的预处理方法，用于将数据集的预处理导入MindIR。 + + **样例：** + + >>> import numpy as np + >>> from mindspore import export, Tensor + >>> + >>> net = LeNet() + >>> input = Tensor(np.ones([1, 1, 32, 32]).astype(np.float32)) + >>> export(net, Tensor(input), file_name='lenet', file_format='MINDIR') diff --git a/docs/api/api_python/mindspore.load_checkpoint.rst b/docs/api/api_python/mindspore/mindspore.load_checkpoint.rst similarity index 98% rename from docs/api/api_python/mindspore.load_checkpoint.rst rename to docs/api/api_python/mindspore/mindspore.load_checkpoint.rst index 7bf817da5a4..5c23a58fe0f 100644 --- a/docs/api/api_python/mindspore.load_checkpoint.rst +++ b/docs/api/api_python/mindspore/mindspore.load_checkpoint.rst @@ -1,31 +1,31 @@ -mindspore.load_checkpoint -========================== - -.. py:class:: mindspore.load_checkpoint(ckpt_file_name, net=None, strict_load=False, filter_prefix=None, dec_key=None, dec_mode="AES-GCM") - - 加载checkpoint文件。 - - **参数：** - - - **ckpt_file_name** (str) – checkpoint的文件名称。 - - **net** (Cell) – 加载checkpoint参数的网络。默认值：None。 - - **strict_load** (bool) – 是否将严格加载参数到网络中。如果是False, 它将根据相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行强制精度转换，比如将float32转换为float16。默认值：False。 - - **filter_prefix** (Union[str, list[str], tuple[str]]) – 以 `filter_prefix` 开头的参数将不会被加载。默认值：None。 - - **dec_key** (Union[None, bytes]) – 用于解密的字节类型密钥，如果值为None，则不需要解密。默认值：None。 - - **dec_mode** (str) – 该参数仅当 `dec_key` 不为None时有效。指定解密模式，目前支持“AES-GCM”和“AES-CBC”。默认值：“AES-GCM”。 - - **返回：** - - 字典，key是参数名称，value是Parameter类型。 - - **异常：** - - **ValueError** – checkpoint文件格式正确。 - - **样例：** - - >>> from mindspore import load_checkpoint - >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" - >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") - >>> print(param_dict["conv2.weight"]) - Parameter (name=conv2.weight, shape=(16, 6, 5, 5), dtype=Float32, requires_grad=True) +mindspore.load_checkpoint +========================== + +.. py:class:: mindspore.load_checkpoint(ckpt_file_name, net=None, strict_load=False, filter_prefix=None, dec_key=None, dec_mode="AES-GCM") + + 加载checkpoint文件。 + + **参数：** + + - **ckpt_file_name** (str) – checkpoint的文件名称。 + - **net** (Cell) – 加载checkpoint参数的网络。默认值：None。 + - **strict_load** (bool) – 是否将严格加载参数到网络中。如果是False, 它将根据相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行强制精度转换，比如将float32转换为float16。默认值：False。 + - **filter_prefix** (Union[str, list[str], tuple[str]]) – 以 `filter_prefix` 开头的参数将不会被加载。默认值：None。 + - **dec_key** (Union[None, bytes]) – 用于解密的字节类型密钥，如果值为None，则不需要解密。默认值：None。 + - **dec_mode** (str) – 该参数仅当 `dec_key` 不为None时有效。指定解密模式，目前支持“AES-GCM”和“AES-CBC”。默认值：“AES-GCM”。 + + **返回：** + + 字典，key是参数名称，value是Parameter类型。 + + **异常：** + + **ValueError** – checkpoint文件格式正确。 + + **样例：** + + >>> from mindspore import load_checkpoint + >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" + >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") + >>> print(param_dict["conv2.weight"]) + Parameter (name=conv2.weight, shape=(16, 6, 5, 5), dtype=Float32, requires_grad=True) diff --git a/docs/api/api_python/mindspore.load_param_into_net.rst b/docs/api/api_python/mindspore/mindspore.load_param_into_net.rst similarity index 97% rename from docs/api/api_python/mindspore.load_param_into_net.rst rename to docs/api/api_python/mindspore/mindspore.load_param_into_net.rst index a382686b1a1..fc2f6b66768 100644 --- a/docs/api/api_python/mindspore.load_param_into_net.rst +++ b/docs/api/api_python/mindspore/mindspore.load_param_into_net.rst @@ -1,31 +1,31 @@ -mindspore.load_param_into_net -============================= - -.. py:class:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False) - - 将参数加载到网络中。 - - **参数：** - - - **net** (Cell) – 将要加载参数的网络。 - - **parameter_dict** (dict) – 加载checkpoint文件得到的字典。 - - **strict_load** (bool) – 是否将参数严格加载到网络中。如果是False, 它将以相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。 - - **返回：** - - List，网络中没有被加载的参数。 - - **异常：** - - **TypeError** – 如果参数不是Cell或者 `parameter_dict` 不是Parameter类型的字典。 - - **样例：** - - >>> from mindspore import load_checkpoint, load_param_into_net - >>> - >>> net = Net() - >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" - >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") - >>> param_not_load = load_param_into_net(net, param_dict) - >>> print(param_not_load) - ['conv1.weight'] +mindspore.load_param_into_net +============================= + +.. py:class:: mindspore.load_param_into_net(net, parameter_dict, strict_load=False) + + 将参数加载到网络中。 + + **参数：** + + - **net** (Cell) – 将要加载参数的网络。 + - **parameter_dict** (dict) – 加载checkpoint文件得到的字典。 + - **strict_load** (bool) – 是否将参数严格加载到网络中。如果是False, 它将以相同的后缀名将参数字典中的参数加载到网络中，并会在精度不匹配时，进行精度转换，比如将float32转换为float16。默认值：False。 + + **返回：** + + List，网络中没有被加载的参数。 + + **异常：** + + **TypeError** – 如果参数不是Cell或者 `parameter_dict` 不是Parameter类型的字典。 + + **样例：** + + >>> from mindspore import load_checkpoint, load_param_into_net + >>> + >>> net = Net() + >>> ckpt_file_name = "./checkpoint/LeNet5-1_32.ckpt" + >>> param_dict = load_checkpoint(ckpt_file_name, filter_prefix="conv1") + >>> param_not_load = load_param_into_net(net, param_dict) + >>> print(param_not_load) + ['conv1.weight'] diff --git a/docs/api/api_python/mindspore.save_checkpoint.rst b/docs/api/api_python/mindspore/mindspore.save_checkpoint.rst similarity index 95% rename from docs/api/api_python/mindspore.save_checkpoint.rst rename to docs/api/api_python/mindspore/mindspore.save_checkpoint.rst index 97faaba48ad..6fad4f85eb8 100644 --- a/docs/api/api_python/mindspore.save_checkpoint.rst +++ b/docs/api/api_python/mindspore/mindspore.save_checkpoint.rst @@ -1,27 +1,27 @@ -mindspore.save_checkpoint -========================= - -.. py:class:: mindspore.save_checkpoint(save_obj, ckpt_file_name, integrated_save=True, async_save=False, append_dict=None, enc_key=None, enc_mode="AES-GCM") - - 将网络权重保存到checkpoint文件中。 - - **参数：** - - - **save_obj** (Union[Cell, list]) – Cell对象或者数据列表（列表的每个元素为字典类型，比如[{"name": param_name, “data”: param_data},…]，`param_name` 的类型必须是str，`param_data` 的类型必须是Parameter或者Tensor）。 - - **ckpt_file_name** (str) – checkpoint文件名称。如果文件已存在，将会覆盖原有文件。 - - **integrated_save** (bool) – 在并行场景下是否合并保存拆分的Tensor。默认值：True。 - - **async_save** (bool) – 是否异步执行保存checkpoint文件。默认值：False。 - - **append_dict** (dict) – 需要保存的其他信息。dict的键必须为str类型，dict的值类型必须是float或者bool类型。默认值：None。 - - **enc_key** (Union[None, bytes]) – 用于加密的字节类型密钥。如果值为None，那么不需要加密。默认值：None。 - - **enc_mode** (str) – 该参数在 `enc_key` 不为None时有效，指定加密模式，目前仅支持"AES-GCM"和"AES-CBC"。 默认值：“AES-GCM”。 - - **异常：** - - **TypeError** – 如果参数 `save_obj` 类型不为nn.Cell或者list，且如果参数 `integrated_save` 及 `async_save` 非bool类型。 - - **样例：** - - >>> from mindspore import save_checkpoint - >>> - >>> net = Net() +mindspore.save_checkpoint +========================= + +.. py:class:: mindspore.save_checkpoint(save_obj, ckpt_file_name, integrated_save=True, async_save=False, append_dict=None, enc_key=None, enc_mode="AES-GCM") + + 将网络权重保存到checkpoint文件中。 + + **参数：** + + - **save_obj** (Union[Cell, list]) – Cell对象或者数据列表（列表的每个元素为字典类型，比如[{"name": param_name, “data”: param_data},…]，`param_name` 的类型必须是str，`param_data` 的类型必须是Parameter或者Tensor）。 + - **ckpt_file_name** (str) – checkpoint文件名称。如果文件已存在，将会覆盖原有文件。 + - **integrated_save** (bool) – 在并行场景下是否合并保存拆分的Tensor。默认值：True。 + - **async_save** (bool) – 是否异步执行保存checkpoint文件。默认值：False。 + - **append_dict** (dict) – 需要保存的其他信息。dict的键必须为str类型，dict的值类型必须是float或者bool类型。默认值：None。 + - **enc_key** (Union[None, bytes]) – 用于加密的字节类型密钥。如果值为None，那么不需要加密。默认值：None。 + - **enc_mode** (str) – 该参数在 `enc_key` 不为None时有效，指定加密模式，目前仅支持"AES-GCM"和"AES-CBC"。 默认值：“AES-GCM”。 + + **异常：** + + **TypeError** – 如果参数 `save_obj` 类型不为nn.Cell或者list，且如果参数 `integrated_save` 及 `async_save` 非bool类型。 + + **样例：** + + >>> from mindspore import save_checkpoint + >>> + >>> net = Net() >>> save_checkpoint(net, "lenet.ckpt") \ No newline at end of file diff --git a/docs/api/api_python/mindspore.nn/mindspore.nn.CosineDecayLR.rst.rst b/docs/api/api_python/nn/mindspore.nn.CosineDecayLR.rst similarity index 100% rename from docs/api/api_python/mindspore.nn/mindspore.nn.CosineDecayLR.rst.rst rename to docs/api/api_python/nn/mindspore.nn.CosineDecayLR.rst diff --git a/docs/api/api_python/mindspore.nn/mindspore.nn.ExponentialDecayLR.rst b/docs/api/api_python/nn/mindspore.nn.ExponentialDecayLR.rst similarity index 100% rename from docs/api/api_python/mindspore.nn/mindspore.nn.ExponentialDecayLR.rst rename to docs/api/api_python/nn/mindspore.nn.ExponentialDecayLR.rst diff --git a/docs/api/api_python/mindspore.nn/mindspore.nn.WarmUpLR.rst b/docs/api/api_python/nn/mindspore.nn.WarmUpLR.rst similarity index 100% rename from docs/api/api_python/mindspore.nn/mindspore.nn.WarmUpLR.rst rename to docs/api/api_python/nn/mindspore.nn.WarmUpLR.rst diff --git a/docs/api/api_python/nn/probability/mindspore.nn.probability.rst b/docs/api/api_python/nn/probability/mindspore.nn.probability.rst deleted file mode 100644 index ab6b3a561f5..00000000000 --- a/docs/api/api_python/nn/probability/mindspore.nn.probability.rst +++ /dev/null @@ -1,6 +0,0 @@ -mindspore.nn.probability -============================ - -.. py:class:: mindspore.nn.probability - - 用于构造概率网络的高级组件。 diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Bijector.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Bijector.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Bijector.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Bijector.rst diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Exp.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Exp.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Exp.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Exp.rst diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.GumbelCDF.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.GumbelCDF.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.GumbelCDF.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.GumbelCDF.rst diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Invert.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Invert.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Invert.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Invert.rst diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.PowerTransform.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.PowerTransform.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.PowerTransform.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.PowerTransform.rst diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.ScalarAffine.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.ScalarAffine.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.ScalarAffine.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.ScalarAffine.rst diff --git a/docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Softplus.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Softplus.rst similarity index 100% rename from docs/api/api_python/nn/probability/bijector/mindspore.nn.probability.bijector.Softplus.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.bijector.Softplus.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Bernoulli.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Bernoulli.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Bernoulli.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Bernoulli.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Beta.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Beta.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Beta.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Beta.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Categorical.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Categorical.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Categorical.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Categorical.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Cauchy.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Cauchy.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Cauchy.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Cauchy.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Distribution.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Distribution.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Distribution.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Distribution.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Exponential.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Exponential.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Exponential.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Exponential.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Gamma.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Gamma.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Gamma.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Gamma.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Geometric.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Geometric.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Geometric.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Geometric.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Gumbel.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Gumbel.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Gumbel.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Gumbel.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.LogNormal.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.LogNormal.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.LogNormal.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.LogNormal.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Logistic.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Logistic.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Logistic.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Logistic.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Normal.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Normal.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Normal.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Normal.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Poisson.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Poisson.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Poisson.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Poisson.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.TransformedDistribution.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.TransformedDistribution.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.TransformedDistribution.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.TransformedDistribution.rst diff --git a/docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Uniform.rst b/docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Uniform.rst similarity index 100% rename from docs/api/api_python/nn/probability/distribution/mindspore.nn.probability.distribution.Uniform.rst rename to docs/api/api_python/nn_probability/mindspore.nn.probability.distribution.Uniform.rst