!2042 fix document api error

Merge pull request !2042 from yanghaitao/yht_fix_api_document
This commit is contained in:
mindspore-ci-bot 2020-06-12 15:53:39 +08:00 committed by Gitee
commit a3ab142f1c
1 changed files with 32 additions and 8 deletions

View File

@ -158,14 +158,38 @@ class BuiltinSampler:
Given these conditions, we need to output what the sampler count is for this sampler.
The following table shows the possible results from calling this function.
child sampler num_samples child_samples result
------------- ----------- ------------- --------
T x y min(x, y)
T x None x
T None y y
T None None None
None x n/a x
None None n/a None
.. list-table::
:widths: 25 25 25 25
:header-rows: 1
* - child sampler
- num_samples
- child_samples
- result
* - T
- x
- y
- min(x, y)
* - T
- x
- None
- x
* - T
- None
- y
- y
* - T
- None
- None
- None
* - None
- x
- n/a
- x
* - None
- None
- n/a
- None
Returns:
int, The number of samples, or None