p47068915
/
mindspore
forked from mindspore-Ecosystem/mindspore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

!26925 update api format 

Merge pull request !26925 from yingchen/code_docs_api1129
This commit is contained in:
i-robot 2021-11-30 06:07:40 +00:00 committed by Gitee
parent 4aa9d269b7 d6a23fee8c
commit 03554c47ca
12 changed files with 157 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/api_python/dataset/mindspore.dataset.GraphData.rst
View File

@ -11,9 +11,9 @@ mindspore.dataset.GraphData
- **num_parallel_workers** (int, 可选)：读取数据的工作线程数（默认为None）。
- **working_mode** (str, 可选)：设置工作模式，目前支持'local'/'client'/'server'（默认为'local'）。
-'local'，用于非分布式训练场景。
-'client'，用于分布式训练场景。客户端不加载数据，而是从服务器获取数据。
-'server'，用于分布式训练场景。服务器加载数据并可供客户端使用。
- 'local'，用于非分布式训练场景。
- 'client'，用于分布式训练场景。客户端不加载数据，而是从服务器获取数据。
- 'server'，用于分布式训练场景。服务器加载数据并可供客户端使用。
- **hostname** (str, 可选)：图数据集服务器的主机名。该参数仅在工作模式设置为'client'或'server'时有效（默认为'127.0.0.1'）。
- **port** (int, 可选)：图数据服务器的端口，取值范围为1024-65535。此参数仅当工作模式设置为'client'或'server'（默认为50051）时有效。
@ -46,7 +46,7 @@ mindspore.dataset.GraphData
**异常：**
**TypeError**：参数`edge_type`的类型不为整型。
**TypeError**：参数 `edge_type` 的类型不为整型。
.. py:method:: get_all_neighbors(node_list, neighbor_type, output_format=<OutputFormat.NORMAL: 0。
@ -181,7 +181,7 @@ mindspore.dataset.GraphData
**异常：**
**TypeError**：参数`node_type`的类型不为整型。
**TypeError**：参数 `node_type` 的类型不为整型。
.. py:method:: get_edges_from_nodes(node_list)

2
docs/api/api_python/dataset/mindspore.dataset.ImageFolderDataset.rst
View File

@ -5,7 +5,7 @@ mindspore.dataset.ImageFolderDataset
从树状结构的文件目录中读取图像作为源数据集，同一个文件夹中的所有图像都具有相同的标签。
生成的数据集有两列： :py:obj:`[image, label]`。列:py:obj:`image` 的数据为uint8类型，列:py:obj:`label` 的数据是uint32类型的标量。
生成的数据集有两列：`[image, label]`。列: `image` 的数据为uint8类型，列: `label` 的数据是uint32类型的标量。
**参数：**

2
docs/api/api_python/dataset/mindspore.dataset.MnistDataset.rst
View File

@ -1,7 +1,7 @@
mindspore.dataset.MnistDataset
===============================
.. py:class:: MnistDataset(dataset_dir, usage=None, num_samples=None, num_parallel_workers=None, shuffle=None, sampler=None, num_shards=None, shard_id=None, cache=None)
.. py:class:: mindspore.dataset.MnistDataset(dataset_dir, usage=None, num_samples=None, num_parallel_workers=None, shuffle=None, sampler=None, num_shards=None, shard_id=None, cache=None)
用于读取和解析MNIST数据集的源数据集文件。

2
docs/api/api_python/dataset/mindspore.dataset.WeightedRandomSampler.rst
View File

@ -15,7 +15,7 @@ mindspore.dataset.WeightedRandomSampler
>>> weights = [0.9, 0.01, 0.4, 0.8, 0.1, 0.1, 0.3]
>>>
>>> # 创建一个WeightedRandomSampler，在没有replacement的情况下对4个元素进行采样
>>> # 创建一个WeightedRandomSampler，将对4个元素进行有放回采样
>>> sampler = ds.WeightedRandomSampler(weights, 4)
>>> dataset = ds.ImageFolderDataset(image_folder_dataset_dir,
... num_parallel_workers=8,

2
docs/api/api_python/dataset/mindspore.dataset.zip.rst
View File

@ -4,7 +4,7 @@
**参数：**
- **datasets** (tuple of class Dataset) - 输入元组格式的多个dataset对象。 `datasets` 参数的长度必须大于1。
**datasets** (tuple of class Dataset) - 输入元组格式的多个dataset对象。 `datasets` 参数的长度必须大于1。
**返回：**

8
docs/api/api_python/mindspore/mindspore.RowTensor.rst
View File

@ -7,11 +7,11 @@ mindspore.RowTensor
通常用于表示一个有着形状为[L0, D1, .., DN]的更大的稠密张量（其中L0>>D0）的子集。
其中，参数`indices`用于指定`RowTensor`从该稠密张量的第一维度的哪些位置来进行切片。
其中，参数 `indices` 用于指定 `RowTensor` 从该稠密张量的第一维度的哪些位置来进行切片。
由`RowTensor`切片表示的稠密张量具有以下属性： `dense[slices.indices[i], :, :, :, ...] = slices.values[i, :, :, :, ...]` 。
由 `RowTensor` 切片表示的稠密张量具有以下属性： `dense[slices.indices[i], :, :, :, ...] = slices.values[i, :, :, :, ...]` 。
`RowTensor`只能在 `Cell` 的构造方法中使用。
`RowTensor` 只能在 `Cell` 的构造方法中使用。
目前不支持PyNative模式。
@ -27,8 +27,6 @@ mindspore.RowTensor
**样例：**
.. code-block::
>>> import mindspore as ms
>>> import mindspore.nn as nn
>>> from mindspore import RowTensor

6
docs/api/api_python/mindspore/mindspore.SparseTensor.rst
View File

@ -5,11 +5,11 @@ mindspore.SparseTensor
用来表示某一张量在给定索引上非零元素的集合。
`SparseTensor`只能在 `Cell` 的构造方法中使用。
`SparseTensor` 只能在 `Cell` 的构造方法中使用。
目前不支持PyNative模式。
对于稠密张量，其`SparseTensor(indices, values, dense_shape)`具有 `dense[indices[i]] = values[i]` 。
对于稠密张量，其 `SparseTensor(indices, values, dense_shape)` 具有 `dense[indices[i]] = values[i]` 。
**参数：**
@ -23,8 +23,6 @@ mindspore.SparseTensor
**样例：**
.. code-block::
>>> import mindspore as ms
>>> import mindspore.nn as nn
>>> from mindspore import SparseTensor

16
docs/api/api_python/mindspore/mindspore.Tensor.rst
View File

@ -3,7 +3,7 @@ mindspore.Tensor
.. py:class:: mindspore.Tensor(input_data=None, dtype=None, shape=None, init=None)
用来存储数据。 继承自C++中的`Tensor`对象。有些函数是用C++实现的，有些函数是用Python实现的。
用来存储数据。 继承自C++中的 `Tensor` 对象。有些函数是用C++实现的，有些函数是用Python实现的。
**参数：**
@ -18,8 +18,6 @@ mindspore.Tensor
**样例：**
.. code-block::
>>> import numpy as np
>>> import mindspore as ms
>>> from mindspore import Tensor
@ -61,8 +59,6 @@ mindspore.Tensor
**样例：**
.. code-block::
>>> from mindspore import Tensor
>>> a = Tensor([1.1, -2.1]).astype("float32")
>>> output = a.abs()
@ -76,7 +72,7 @@ mindspore.Tensor
**参数：**
- **axis** (Union[None, int, tuple(int))：被简化的维度。 当`axis`为None或者空元组的时候，简化所有维度。 默认值：()。
- **axis** (Union[None, int, tuple(int))：被简化的维度。 当 `axis` 为None或者空元组的时候，简化所有维度。 默认值：()。
- **keep_dims** (bool)：是否会保留被简化的维度。 默认值： False。
**返回：**
@ -89,8 +85,6 @@ mindspore.Tensor
**样例：**
.. code-block::
>>> from mindspore import Tensor
>>> a = Tensor([True, True, False])
>>> output = a.all()
@ -116,8 +110,6 @@ mindspore.Tensor
**样例：**
.. code-block::
>>> from mindspore import Tensor
>>> a = Tensor([True, True, False])
>>> output = a.any()
@ -139,7 +131,7 @@ mindspore.Tensor
**参数：**
- **x** (Tensor)：输入的张量。该张量的形状必须遵守广播规则。
**x** (Tensor)：输入的张量。该张量的形状必须遵守广播规则。
**返回：**
@ -178,8 +170,6 @@ mindspore.Tensor
**样例：**
.. code-block::
>>> import numpy as np
>>> from mindspore import Tensor
>>> input_x = Tensor(np.array([1, 2, 3], dtype=np.float32))