blob: 70f37f589fb48a89920c0c40439d95a309130fc5 [file] [log] [blame]
``mx.symbol.sample_normal``
======================================================
Description
----------------------
Concurrent sampling from multiple
normal distributions with parameters *mu* (mean) and *sigma* (standard deviation).
The parameters of the distributions are provided as input arrays.
Let *[s]* be the shape of the input arrays, *n* be the dimension of *[s]*, *[t]*
be the shape specified as the parameter of the operator, and *m* be the dimension
of *[t]*. Then the output will be a *(n+m)*-dimensional array with shape *[s]x[t]*.
For any valid *n*-dimensional index *i* with respect to the input arrays, *output[i]*
will be an *m*-dimensional array that holds randomly drawn samples from the distribution
which is parameterized by the input values at index *i*. If the shape parameter of the
operator is not set, then one sample will be drawn per distribution and the output array
has the same shape as the input arrays.
**Example**::
mu = [ 0.0, 2.5 ]
sigma = [ 1.0, 3.7 ]
// Draw a single sample for each distribution
sample_normal(mu, sigma) = [-0.56410581, 0.95934606]
// Draw a vector containing two samples for each distribution
sample_normal(mu, sigma, shape=(2)) = [[-0.56410581, 0.2928229 ],
[ 0.95934606, 4.48287058]]
Usage
----------
.. code:: r
mx.symbol.sample_normal(...)
Arguments
------------------
+----------------------------------------+------------------------------------------------------------+
| Argument | Description |
+========================================+============================================================+
| ``mu`` | NDArray-or-Symbol. |
| | |
| | Means of the distributions. |
+----------------------------------------+------------------------------------------------------------+
| ``shape`` | Shape(tuple), optional, default=[]. |
| | |
| | Shape to be sampled from each random distribution. |
+----------------------------------------+------------------------------------------------------------+
| ``dtype`` | {'None', 'float16', 'float32', 'float64'},optional, |
| | default='None'. |
| | |
| | DType of the output in case this can't be inferred. |
| | Defaults to float32 if not defined |
| | (dtype=None). |
+----------------------------------------+------------------------------------------------------------+
| ``sigma`` | NDArray-or-Symbol. |
| | |
| | Standard deviations of the distributions. |
+----------------------------------------+------------------------------------------------------------+
| ``name`` | string, optional. |
| | |
| | Name of the resulting symbol. |
+----------------------------------------+------------------------------------------------------------+
Value
----------
``out`` The result mx.symbol
Link to Source Code: http://github.com/apache/incubator-mxnet/blob/1.6.0/src/operator/random/multisample_op.cc#L279