diff --git a/docs/api/api_python/mindspore.boost.rst b/docs/api/api_python/mindspore.boost.rst index 292aa6156f4..c46ddb97aa5 100644 --- a/docs/api/api_python/mindspore.boost.rst +++ b/docs/api/api_python/mindspore.boost.rst @@ -24,7 +24,7 @@ Boost能够自动加速网络,如减少BN/梯度冻结/累积梯度等。 **输出:** - Tuple(Tensor), adasum处理后更新的权重。 + - **Tuple** (Tensor) - adasum处理后更新的权重。 .. py:class:: mindspore.boost.AutoBoost(level="O0", boost_config_dict="") @@ -169,8 +169,8 @@ Boost能够自动加速网络,如减少BN/梯度冻结/累积梯度等。 **参数:** - - network (Cell),训练网络。 - - optimizer (Union[Cell]),用于更新权重的优化器。 + - **network** (Cell) - 训练网络。 + - **optimizer** (Union[Cell]) - 用于更新权重的优化器。 .. py:method:: network_auto_process_eval(network) @@ -178,7 +178,7 @@ Boost能够自动加速网络,如减少BN/梯度冻结/累积梯度等。 **参数:** - network(Cell),推理网络。 + **network** (Cell) - 推理网络。 .. py:class:: mindspore.boost.BoostTrainOneStepCell(network, optimizer, sens=1.0) diff --git a/docs/api/api_python/nn/mindspore.nn.Cell.rst b/docs/api/api_python/nn/mindspore.nn.Cell.rst index ce18f944848..8e1fc3e3a04 100644 --- a/docs/api/api_python/nn/mindspore.nn.Cell.rst +++ b/docs/api/api_python/nn/mindspore.nn.Cell.rst @@ -314,9 +314,11 @@ - **hook_fn** (function) – 捕获Cell对象信息和正向输入数据的hook_fn函数。 **返回:** + - **handle** – 与hook_fn函数对应的handle对象。 **异常:** + - **TypeError** – 如果 `hook_fn` 不是Python函数。 .. py:method:: register_forward_hook(hook_fn) @@ -333,9 +335,11 @@ - **hook_fn** (function) – 捕获Cell对象信息和正向输入,输出数据的hook_fn函数。 **返回:** + - **handle** – 与hook_fn函数对应的handle对象。 **异常:** + - **TypeError** – 如果 `hook_fn` 不是Python函数。 .. py:method:: register_backward_hook(hook_fn) @@ -352,9 +356,11 @@ - **hook_fn** (function) – 捕获Cell对象信息和反向输入,输出梯度的hook_fn函数。 **返回:** + - **handle** – 与hook_fn函数对应的handle对象。 **异常:** + - **TypeError** – 如果 `hook_fn` 不是Python函数。 .. py:method:: remove_redundant_parameters() diff --git a/docs/api/api_python/nn/mindspore.nn.ConfusionMatrix.rst b/docs/api/api_python/nn/mindspore.nn.ConfusionMatrix.rst index 995529386a7..0ae39bf0062 100644 --- a/docs/api/api_python/nn/mindspore.nn.ConfusionMatrix.rst +++ b/docs/api/api_python/nn/mindspore.nn.ConfusionMatrix.rst @@ -1,7 +1,7 @@ mindspore.nn.ConfusionMatrix ============================ -.. py:class:: mindspore.nn.ConfusionMatrix(num_classes, normalize='NO_NORM', threshold=0.5) +.. py:class:: mindspore.nn.ConfusionMatrix(num_classes, normalize='no_norm', threshold=0.5) 计算混淆矩阵(confusion matrix),通常用于评估分类模型的性能,包括二分类和多分类场景。 diff --git a/docs/api/api_python/nn/mindspore.nn.GRU.rst b/docs/api/api_python/nn/mindspore.nn.GRU.rst index 58910f8d8cd..cf0db73eb61 100644 --- a/docs/api/api_python/nn/mindspore.nn.GRU.rst +++ b/docs/api/api_python/nn/mindspore.nn.GRU.rst @@ -36,6 +36,7 @@ mindspore.nn.GRU **输出:** Tuple,包含(`output`, `h_n`)的tuple。 + - **output** (Tensor) - shape为(seq_len, batch_size, num_directions * `hidden_size`)或(batch_size, seq_len, num_directions * `hidden_size`)的Tensor。 - **hx_n** (Tensor) - shape为(num_directions * `num_layers`, batch_size, `hidden_size`)的Tensor。 diff --git a/docs/api/api_python/nn/mindspore.nn.GRUCell.rst b/docs/api/api_python/nn/mindspore.nn.GRUCell.rst index 7dbd9042e54..62aa6f46ee2 100644 --- a/docs/api/api_python/nn/mindspore.nn.GRUCell.rst +++ b/docs/api/api_python/nn/mindspore.nn.GRUCell.rst @@ -29,7 +29,7 @@ mindspore.nn.GRUCell **输出:** - - **h'** (Tensor) - shape为(batch_size, `hidden_size`)的Tensor。 + - **hx** (Tensor) - shape为(batch_size, `hidden_size`)的Tensor。 **异常:** diff --git a/docs/api/api_python/nn/mindspore.nn.HausdorffDistance.rst b/docs/api/api_python/nn/mindspore.nn.HausdorffDistance.rst index b0af445c4f0..e3a36309564 100644 --- a/docs/api/api_python/nn/mindspore.nn.HausdorffDistance.rst +++ b/docs/api/api_python/nn/mindspore.nn.HausdorffDistance.rst @@ -44,7 +44,7 @@ mindspore.nn.HausdorffDistance **参数:** - - inputs:`y_pred`、`y` 和 `label_idx`。`y_pred` 和 `y` 为Tensor, list或numpy.ndarray,`y_pred` 是预测的二值图像,`y` 是实际的二值图像。`label_idx` 的数据类型为int或float,表示像素点的类别值。 + - **inputs** - `y_pred`、`y` 和 `label_idx`。`y_pred` 和 `y` 为Tensor, list或numpy.ndarray,`y_pred` 是预测的二值图像,`y` 是实际的二值图像。`label_idx` 的数据类型为int或float,表示像素点的类别值。 **异常:** diff --git a/docs/api/api_python/nn/mindspore.nn.L1Regularizer.rst b/docs/api/api_python/nn/mindspore.nn.L1Regularizer.rst index 20623f0edef..50f86f90e53 100644 --- a/docs/api/api_python/nn/mindspore.nn.L1Regularizer.rst +++ b/docs/api/api_python/nn/mindspore.nn.L1Regularizer.rst @@ -13,11 +13,11 @@ mindspore.nn.L1Regularizer **参数:** - - **scale (int, float)** - L1正则化因子,其值大于0。 + - **scale** (int, float) - L1正则化因子,其值大于0。 **输入:** - - **weights** (Tensor)** - L1Regularizer的输入,任意维度的Tensor,数据类型为float16或float32。 + - **weights** (Tensor) - L1Regularizer的输入,任意维度的Tensor,数据类型为float16或float32。 **输出:** diff --git a/docs/api/api_python/nn/mindspore.nn.LSTMCell.rst b/docs/api/api_python/nn/mindspore.nn.LSTMCell.rst index 958465b3fc5..1212535c317 100644 --- a/docs/api/api_python/nn/mindspore.nn.LSTMCell.rst +++ b/docs/api/api_python/nn/mindspore.nn.LSTMCell.rst @@ -20,6 +20,7 @@ mindspore.nn.LSTMCell 其中 :math:`\sigma` 是sigmoid函数, :math:`*` 是乘积。 :math:`W,b` 是公式中输出和输入之间的可学习权重。例如,:math:`W_{ix}, b_{ix}` 是用于从输入 :math:`x` 转换为 :math:`i` 的权重和偏置。详见论文 `LONG SHORT-TERM MEMORY `_ 和 `Long Short-Term Memory Recurrent Neural Network Architectures for Large Scale Acoustic Modeling `_ 。 **参数:** + - **input_size** (int) - 输入的大小。 - **hidden_size** (int)- 隐藏状态大小。 - **has_bias** (bool) - cell是否有偏置 `b_ih` 和 `b_hh` 。默认值:True。 diff --git a/docs/api/api_python/ops/mindspore.ops.ArgMaxWithValue.rst b/docs/api/api_python/ops/mindspore.ops.ArgMaxWithValue.rst index 6baeede93dc..9b532626d61 100644 --- a/docs/api/api_python/ops/mindspore.ops.ArgMaxWithValue.rst +++ b/docs/api/api_python/ops/mindspore.ops.ArgMaxWithValue.rst @@ -26,6 +26,7 @@ **输出:** tuple (Tensor),表示2个Tensor组成的tuple,包含对应的索引和输入Tensor的最大值。 + - **index** (Tensor) - 输入Tensor最大值的索引。如果 `keep_dims` 为true,则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则,shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。 - **output_x** (Tensor) - 输入Tensor的最大值,其shape与索引相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.ComputeAccidentalHits.rst b/docs/api/api_python/ops/mindspore.ops.ComputeAccidentalHits.rst index 048b5ea9b4a..358672f61b2 100644 --- a/docs/api/api_python/ops/mindspore.ops.ComputeAccidentalHits.rst +++ b/docs/api/api_python/ops/mindspore.ops.ComputeAccidentalHits.rst @@ -9,7 +9,7 @@ **参数:** - num_true (int):每个训练样本的目标类数。默认值:1。 + - **num_true** (int):每个训练样本的目标类数。默认值:1。 **输入:** diff --git a/docs/api/api_python/ops/mindspore.ops.Dropout3D.rst b/docs/api/api_python/ops/mindspore.ops.Dropout3D.rst index ad22326b9b0..845a746f36d 100644 --- a/docs/api/api_python/ops/mindspore.ops.Dropout3D.rst +++ b/docs/api/api_python/ops/mindspore.ops.Dropout3D.rst @@ -13,7 +13,7 @@ **参数:** - keep_prob (float):输入通道保留率,数值范围在0到1之间,例如 `keep_prob` = 0.8,意味着过滤20%的通道。默认值:0.5。 + - **keep_prob** (float):输入通道保留率,数值范围在0到1之间,例如 `keep_prob` = 0.8,意味着过滤20%的通道。默认值:0.5。 **输入:** diff --git a/docs/api/api_python/ops/mindspore.ops.NLLLoss.rst b/docs/api/api_python/ops/mindspore.ops.NLLLoss.rst index cb0e57df123..b3e2c2e815c 100644 --- a/docs/api/api_python/ops/mindspore.ops.NLLLoss.rst +++ b/docs/api/api_python/ops/mindspore.ops.NLLLoss.rst @@ -41,5 +41,5 @@ mindspore.ops.NLLLoss **异常:** - - ** TypeError** - `logits` 或 `weight` 的数据类型既不是float16也不是float32, `labels` 不是int32。 - - ** ValueError** - `logits` 不是一维或二维Tensor, `labels` 和 `weight` 不是一维Tensor。 `logits` 是二维Tensor时, `logits` 的第一个维度不等于 `labels` , `logits` 的第二个维度不等于 `weight` 。 `logits` 是一维Tensor时, `logits` 、 `labels` 和 `weight` 的维度应该相同。 \ No newline at end of file + - **TypeError** - `logits` 或 `weight` 的数据类型既不是float16也不是float32, `labels` 不是int32。 + - **ValueError** - `logits` 不是一维或二维Tensor, `labels` 和 `weight` 不是一维Tensor。 `logits` 是二维Tensor时, `logits` 的第一个维度不等于 `labels` , `logits` 的第二个维度不等于 `weight` 。 `logits` 是一维Tensor时, `logits` 、 `labels` 和 `weight` 的维度应该相同。 \ No newline at end of file diff --git a/docs/api/api_python/transformer/mindspore.nn.VocabEmbedding.rst b/docs/api/api_python/transformer/mindspore.nn.VocabEmbedding.rst index f85da7cc50e..5fc9408dcba 100644 --- a/docs/api/api_python/transformer/mindspore.nn.VocabEmbedding.rst +++ b/docs/api/api_python/transformer/mindspore.nn.VocabEmbedding.rst @@ -14,7 +14,7 @@ **输入:** - - **input_ids** (Tensor) - shape为(batch_size, seq_length)的输入,其数据类型为int32。 + **input_ids** (Tensor) - shape为(batch_size, seq_length)的输入,其数据类型为int32。 **输出:**