DOC improve random state docsting for extmath module
@@ -184,10 +184,9 @@ def randomized_range_finder(A, size, n_iter,
random_state : int, RandomState instance or None, optional (default=None)
The seed of the pseudo random number generator to use when shuffling
- the data. If int, random_state is the seed used by the random number
- generator; If RandomState instance, random_state is the random number
- generator; If None, the random number generator is the RandomState
- instance used by `np.random`.
+ the data, i.e. getting the random vectors to initialize the algorithm.
+ Pass an int for reproducible results across multiple function calls.
+ See :term:`Glossary <random_state>`.
Returns
-------
@@ -296,10 +295,9 @@ def randomized_svd(M, n_components, n_oversamples=10, n_iter='auto',
random_state : int, RandomState instance or None, optional (default=None)
The seed of the pseudo random number generator to use when shuffling
- the data. If int, random_state is the seed used by the random number
- generator; If RandomState instance, random_state is the random number
- generator; If None, the random number generator is the RandomState
- instance used by `np.random`.
+ the data, i.e. getting the random vectors to initialize the algorithm.
+ Pass an int for reproducible results across multiple function calls.
+ See :term:`Glossary <random_state>`.
Notes
-----
