Skip to content

Commit 0c4d814

Browse files
committed
fix get_state docstrings
1 parent f98e9d5 commit 0c4d814

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

mkl_random/interfaces/_numpy_random.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def get_state(self, legacy=True):
8484
8585
Returns
8686
-------
87-
out : {tuple(str, bytes), dict}
87+
out : tuple[str, bytes] or dict
8888
The returned tuple has the following items:
8989
9090
1. a string specifying the basic pseudo-random number generation
@@ -95,12 +95,12 @@ def get_state(self, legacy=True):
9595
If `legacy` is False, a dictionary containing the state information
9696
is returned instead, with the following keys:
9797
98-
1. `bit_generator`: a string specifying the basic pseudo-random
99-
number generation algorithm. It should always be `MT19937`
100-
for this class.
101-
2. `state`: a dictionary guaranteed to contain the key
102-
`mkl_stream`, whose value is a bytes object holding content of
103-
Intel MKL's stream for the generator.
98+
* "bit_generator" - a string specifying the basic pseudo-random
99+
number generation algorithm. It should always be `MT19937`
100+
for this class.
101+
* "state" - a dictionary guaranteed to contain the key
102+
"mkl_stream", whose value is a bytes object holding content of
103+
Intel MKL's stream for the generator.
104104
105105
Compare with `numpy.random.get_state`.
106106

mkl_random/mklrand.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1652,7 +1652,7 @@ cdef class _MKLRandomState:
16521652
16531653
Returns
16541654
-------
1655-
out : {tuple(str, bytes), dict}
1655+
out : tuple[str, bytes] or dict
16561656
The returned tuple has the following items:
16571657
16581658
1. a string specifying the basic pseudo-random number generation
@@ -1708,7 +1708,7 @@ cdef class _MKLRandomState:
17081708
17091709
Parameters
17101710
----------
1711-
state : {tuple(str, bytes), dict}
1711+
state : tuple[str, bytes] or dict
17121712
The `state` tuple has the following items:
17131713
17141714
1. a string specifying the basic pseudo-random number generation

0 commit comments

Comments
 (0)