-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
This PR (closes #3017) adds docs for our new random number generation using Generators. Co-authored-by: Tess Hayes <stress-tess@users.noreply.github.com>
- Loading branch information
1 parent
f807941
commit e07f70e
Showing
2 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,5 +17,6 @@ Usage Guide | |
usage/groupby | ||
usage/strings | ||
usage/categorical | ||
usage/random | ||
usage/segarray | ||
usage/arrayview |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
*********** | ||
Random in Arkouda | ||
*********** | ||
Pseudo random number generation in Arkouda is modeled after numpy. | ||
Just like in numpy the preferred way to access the random functionality in arkouda is via ``Generator`` objects. | ||
If a ``Generator`` is initialized with a seed, the stream of random numbers it produces can be reproduced | ||
by a new ``Generator`` with the same seed. This reproducibility is not guaranteed across releases. | ||
|
||
.. autoclass:: arkouda.random.Generator | ||
|
||
Creation | ||
========= | ||
To create a ``Generator`` use the ``default_rng`` constructor | ||
|
||
.. autofunction:: arkouda.random.default_rng | ||
|
||
Features | ||
========== | ||
|
||
integers | ||
--------- | ||
.. autofunction:: arkouda.random.Generator.integers | ||
|
||
random | ||
--------- | ||
.. autofunction:: arkouda.random.Generator.random | ||
|
||
standard_normal | ||
--------- | ||
.. autofunction:: arkouda.random.Generator.standard_normal | ||
|
||
uniform | ||
--------- | ||
.. autofunction:: arkouda.random.Generator.uniform |