mindspore-Ecosystem
/
mindspore
21
0
Fork 27
Code Issues Pull Requests 6 Projects Releases Wiki Activity

!15 Correct the comments for `RandomChoiceWithMask` op. 

Merge pull request !15 from seatea/randomchoicewithmask-doc
This commit is contained in:
mindspore-ci-bot 2020-03-31 14:37:36 +08:00 committed by Gitee
parent 630dd746af 840280e784
commit 2753aa8768
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
mindspore/ops/operations/random_ops.py
View File

@ -25,20 +25,23 @@ class RandomChoiceWithMask(PrimitiveWithInfer):
"""
Generates a random samply as index tensor with a mask tensor from a given tensor.
The input must be a tensor of rank >= 2, the first dimension specify the number of sample.
The index tensor and the mask tensor have the same and fixed shape. The index tensor denotes the index
of the nonzero sample, while the mask tensor denotes which element in the index tensor are valid.
The input must be a tensor of rank >= 1. If its rank >= 2, the first dimension specify the number of sample.
The index tensor and the mask tensor have the fixed shapes. The index tensor denotes the index of the nonzero
sample, while the mask tensor denotes which elements in the index tensor are valid.
Args:
count (int): Number of items expected to get. Default: 256.
seed (int): Random seed.
seed2 (int): Random seed2.
count (int): Number of items expected to get and the number should be greater than 0. Default: 256.
seed (int): Random seed. Default: 0.
seed2 (int): Random seed2. Default: 0.
Inputs:
- **input_x** (Tensor) - The input tensor.
- **input_x** (Tensor[bool]) - The input tensor.
Outputs:
Tuple, two tensors, the first one is the index tensor and the other one is the mask tensor.
Two tensors, the first one is the index tensor and the other one is the mask tensor.
- **index** (Tensor) - The output has shape between 2-D and 5-D.
- **mask** (Tensor) - The output has shape 1-D.
Examples:
>>> rnd_choice_mask = RandomChoiceWithMask()