forked from mindspore-Ecosystem/mindspore
fix doc of RandomChoiceWithMask
This commit is contained in:
parent
4cbf97af70
commit
e0cc7cae82
|
@ -5,24 +5,4 @@
|
|||
|
||||
对输入进行随机取样,返回取样索引和掩码。
|
||||
|
||||
输入必须是秩不小于1的Tensor。如果其秩大于等于2,则第一个维度指定样本数。索引Tensor和掩码Tensor有固定的shape。
|
||||
索引Tensor为取样的索引,掩码Tensor表示索引Tensor中的哪些元素取值为True。
|
||||
|
||||
参数:
|
||||
- **count** (int) - 取样数量,必须大于0。默认值:256。
|
||||
- **seed** (int) - 随机种子。默认值:0。
|
||||
- **seed2** (int) - 随机种子2。默认值:0。
|
||||
|
||||
输入:
|
||||
- **input_x** (Tensor[bool]) - 输入Tensor,bool类型。秩必须大于等于1且小于等于5。
|
||||
|
||||
输出:
|
||||
两个Tensor,第一个为索引,另一个为掩码。
|
||||
|
||||
- **index** (Tensor) - 2维Tensor。
|
||||
- **mask** (Tensor) - 1维Tensor。
|
||||
|
||||
异常:
|
||||
- **TypeError** - `count` 不是int类型。
|
||||
- **TypeError** - `seed` 或 `seed2` 不是int类型。
|
||||
- **TypeError** - `input_x` 不是Tensor。
|
||||
更多参考详见 :func:`mindspore.ops.choice_with_mask`。
|
||||
|
|
|
@ -639,7 +639,7 @@ class RandomChoiceWithMask(Primitive):
|
|||
"""
|
||||
Generates a random sample as index tensor with a mask tensor from a given tensor.
|
||||
|
||||
Refer to :func:'mindspore.ops.choice_with_mask' for more detail.
|
||||
Refer to :func:`mindspore.ops.choice_with_mask` for more detail.
|
||||
|
||||
Supported Platforms:
|
||||
``Ascend`` ``GPU`` ``CPU``
|
||||
|
|
Loading…
Reference in New Issue