Browse Source

modify apiformat

r1.7
xumengjuan1 4 years ago
parent
commit
0c3e47f872
9 changed files with 12 additions and 12 deletions
  1. +2
    -2
      docs/api/api_python/mindspore/mindspore.CSRTensor.rst
  2. +1
    -1
      docs/api/api_python/mindspore/mindspore.Parameter.rst
  3. +2
    -2
      docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst
  4. +1
    -1
      docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst
  5. +1
    -1
      docs/api/api_python/ops/mindspore.ops.ScatterNd.rst
  6. +1
    -1
      docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst
  7. +1
    -1
      docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst
  8. +1
    -1
      docs/api/api_python/ops/mindspore.ops.SigmoidCrossEntropyWithLogits.rst
  9. +2
    -2
      docs/api/api_python/ops/mindspore.ops.sequence_mask.rst

+ 2
- 2
docs/api/api_python/mindspore/mindspore.CSRTensor.rst View File

@@ -3,8 +3,8 @@ mindspore.CSRTensor

.. py:class:: mindspore.CSRTensor(indptr=None, indices=None, values=None, shape=None)

用来表示某一张量在给定索引上非零元素的集合,其中行索引由`indptr`表示,列索引由`indices`
表示,非零值由`values`表示。
用来表示某一张量在给定索引上非零元素的集合,其中行索引由 `indptr` 表示,列索引由 `indices`
表示,非零值由 `values` 表示。

.. note::
- 这是一个实验特性,在未来可能会发生API的变化。


+ 1
- 1
docs/api/api_python/mindspore/mindspore.Parameter.rst View File

@@ -13,7 +13,7 @@
**参数:**

- **default_input** (Union[Tensor, int, float, numpy.ndarray, list]) - 初始化参数的输入值。
- **name** (str) - 参数的名称。默认值:None。如果一个网络中存在两个及以上相同名称的`Parameter`对象,在定义时将提示设置一个特有的名称。
- **name** (str) - 参数的名称。默认值:None。如果一个网络中存在两个及以上相同名称的 `Parameter` 对象,在定义时将提示设置一个特有的名称。
- **requires_grad** (bool) - 是否需要微分求梯度。默认值:True。
- **layerwise_parallel** (bool) - 在数据/混合并行模式下,`layerwise_parallel` 配置为True时,参数广播和梯度聚合时会过滤掉该参数。默认值:False。
- **parallel_optimizer** (bool) - 用于在 `semi_auto_parallel` 或 `auto_parallel` 并行模式下区分参数是否进行优化器切分。仅在 `mindspore.context.set_auto_parallel_context()` 并行配置模块中设置 `enable_parallel_optimizer` 启用优化器并行时有效。默认值:True。


+ 2
- 2
docs/api/api_python/nn/mindspore.nn.ResizeBilinear.rst View File

@@ -1,13 +1,13 @@
mindspore.nn.ResizeBilinear
============================

.. py:class:: mindspore.nn.ResizeBilinear
.. py:class:: mindspore.nn.ResizeBilinear(half_pixel_centers=False)

使用双线性插值调整输入Tensor为指定的大小。

**参数:**

- **half_pixel_centers** (bool) - 是否几何中心对齐。如果设置为True, 那么`scale_factor`应该设置为False。默认值:False。
- **half_pixel_centers** (bool) - 是否几何中心对齐。如果设置为True, 那么 `scale_factor` 应该设置为False。默认值:False。

**输入:**



+ 1
- 1
docs/api/api_python/ops/mindspore.ops.ScatterAdd.rst View File

@@ -27,7 +27,7 @@ mindspore.ops.ScatterAdd

**输出:**

Tensor,更新后的 `input_x` ,shape和数据类型与`input_x`相同。
Tensor,更新后的 `input_x` ,shape和数据类型与 `input_x` 相同。

**异常:**



+ 1
- 1
docs/api/api_python/ops/mindspore.ops.ScatterNd.rst View File

@@ -11,7 +11,7 @@ mindspore.ops.ScatterNd

`indices` 的shape为 :math:`(i_0, i_1, ..., i_{Q-2}, N)` , `N <= P` 。

`indices` 的最后一个维度(长度为`N`)表示沿着空Tensor的 `N` 个维度进行切片。
`indices` 的最后一个维度(长度为 `N` )表示沿着空Tensor的 `N` 个维度进行切片。

`updates` 表示秩为 `Q-1+P-N` 的Tensor,shape为 :math:`(i_0, i_1, ..., i_{Q-2}, shape_N, ..., shape_{P-1})` 。



+ 1
- 1
docs/api/api_python/ops/mindspore.ops.ScatterNdUpdate.rst View File

@@ -5,7 +5,7 @@ mindspore.ops.ScatterNdUpdate

使用给定值以及输入索引更新输入数据的值。

`input_x` 的rank为P,而`indices` 的rank为Q, `Q >= 2` 。
`input_x` 的rank为P,而 `indices` 的rank为Q, `Q >= 2` 。

`indices` 的shape为 :math:`(i_0, i_1, ..., i_{Q-2}, N)` , `N <= P` 。



+ 1
- 1
docs/api/api_python/ops/mindspore.ops.ScatterNonAliasingAdd.rst View File

@@ -7,7 +7,7 @@

输入的 `input_x` 和 `updates` 遵循隐式类型转换规则,以确保数据类型一致。如果它们具有不同的数据类型,则低精度数据类型将转换为高精度数据类型。当需要转换Parameter的数据类型时,则会抛出RuntimeError异常。

** 输入:**
**输入:**

- **input_x** (Parameter) - ScatterNonAliasingAdd的输入,任意维度的Parameter。其数据类型为float16、float32或int32。
- **indices** (Tensor) - 指定加法操作的索引。其数据类型为mindspore.int32。


+ 1
- 1
docs/api/api_python/ops/mindspore.ops.SigmoidCrossEntropyWithLogits.rst View File

@@ -9,7 +9,7 @@

将输入 `logits` 设置为 :math:`X` ,输入 `label` 为 :math:`Y` ,输出为 :math:`loss` 。然后,

.. math::
.. math::
\begin{array}{ll} \\
p_{ij} = sigmoid(X_{ij}) = \frac{1}{1 + e^{-X_{ij}}} \\
loss_{ij} = -[Y_{ij} * ln(p_{ij}) + (1 - Y_{ij})ln(1 - p_{ij})]


+ 2
- 2
docs/api/api_python/ops/mindspore.ops.sequence_mask.rst View File

@@ -1,13 +1,13 @@
mindspore.ops.sequence_mask
============================

.. py:function:: mindspore.ops.sequence_mask(lengths, maxlen=None, prim_name='sequence_mask')
.. py:function:: mindspore.ops.sequence_mask(lengths, maxlen=None)

返回一个表示每个单元的前N个位置的掩码Tensor。内部元素数据类型为bool。

如果lengths的shape为 :math:`[d_1, d_2, ..., d_n]` ,则生成的Tensor掩码拥有数据类型,其shape为 :math:`[d_1, d_2, ..., d_n, maxlen]` ,且mask :math:`[i_1, i_2, ..., i_n, j] = (j < lengths[i_1, i_2, ..., i_n])` 。

**输入:**
**参数:**

- **lengths** (Tensor) - 用来计算掩码的Tensor,一般代表长度。此Tensor中的所有值都应小于或等于 `maxlen` 。大于 `maxlen` 的值将被视为 `maxlen` 。其数据类型为int32或int64。
- **maxlen** (int) - 指定返回Tensor的长度。其值为正数,且与 `lengths` 中的元素数据类型相同。默认为None。


Loading…
Cancel
Save