haojin2 commented on a change in pull request #15388: Doc
URL: https://github.com/apache/incubator-mxnet/pull/15388#discussion_r299001885
##########
File path: python/mxnet/ndarray/numpy/random.py
##########
@@ -129,6 +138,47 @@ def normal(loc=0.0, scale=1.0, size=None, **kwargs):
Notes
-----
This function currently does not support ``loc`` and ``scale`` as ndarrays.
+ The probability density for the Gaussian distribution is
+
+ .. math:: p(x) = \frac{1}{\sqrt{ 2 \pi \sigma^2 }}
+ e^{ - \frac{ (x - \mu)^2 } {2 \sigma^2} },
+
+ where :math:`\mu` is the mean and :math:`\sigma` the standard
+ deviation. The square of the standard deviation, :math:`\sigma^2`,
+ is called the variance.
+
+ The function has its peak at the mean, and its "spread" increases with
+ the standard deviation (the function reaches 0.607 times its maximum at
+ :math:`x + \sigma` and :math:`x - \sigma` [2]_). This implies that
+ `numpy.random.normal` is more likely to return samples lying close to
+ the mean, rather than those far away.
+
+ This function differs from the original numpy.random.normal in the
following aspects:
+
+ - Argument must be named from the fourth.
Review comment:
This is not very clear to the users, I think you can emphasize that the
order of arguments is different.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
