Update documentation of random.uniform to reflect data type conversion behavior #3013
Conversation
jantonguirao
changed the title
| This argument is mutually exclusive with ``values``.)code", | ||
| This argument is mutually exclusive with ``values``. | ||
|
|
||
| Warning: When specifying an integer type as ``dtype``, the generated numbers can go outside |
There was a problem hiding this comment.
Should we use the .. warning:: and .. note:: boxes from rst?
There was a problem hiding this comment.
Shouldn't we clamp. I think this is the last thing I would expect TBH.
There was a problem hiding this comment.
There are one more Warning and Note.
Signed-off-by: Joaquin Anton <janton@nvidia.com>
jantonguirao
force-pushed
the
update_uniform_docstr
branch
from
72059e7
to
d31a5dc
Compare
|
!build |
|
CI MESSAGE: [2432816]: BUILD STARTED |
|
|
||
| Warning: When specifying an integer type as ``dtype``, the generated numbers can go outside |
|
|
||
| .. warning:: | ||
| When specifying an integer type as ``dtype``, the generated numbers can go outside | ||
| the specified range, due to rounding. |
There was a problem hiding this comment.
the generated numbers can go outside the specified range
Can't we clamp? It is a bit unexpected.
There was a problem hiding this comment.
So the RNG work like that, you generate the number in whatever is the natural type for the distribution, in this case float. Then if the user request the output data type to be a different type, we just ConvertSat(...). It's equivalent to doing fn.cast( fn.random.uniform(...), dtype=...), the numbers when converted to an integer data type, can go outside of the float range that was specified for the distribution. If the user needs a continuous distribution, it doesn't make much sense to request dtype to be an integer data type, I'd say.
| This argument is mutually exclusive with ``values``.)code", | ||
| This argument is mutually exclusive with ``values``. | ||
|
|
||
| Warning: When specifying an integer type as ``dtype``, the generated numbers can go outside |
dali/operators/random/rng_base.cc
Outdated
| R"code(Output data type.)code", nullptr); | ||
| R"code(Output data type. | ||
|
|
||
| Note: The generated numbers are converted to the output data type, rounding and clamping if necessary. |
Signed-off-by: Joaquin Anton <janton@nvidia.com>
|
!build |
|
CI MESSAGE: [2432989]: BUILD STARTED |
|
CI MESSAGE: [2432989]: BUILD PASSED |
Signed-off-by: Joaquin Anton janton@nvidia.com
Why we need this PR?
Pick one, remove the rest
What happened in this PR?
Fill relevant points, put NA otherwise. Replace anything inside []
Documentation was extended
random.Uniform
NA
NA
NA
JIRA TASK: [NA]