Skip to content

Commit

Permalink
Closes #3017: Add documentation for our random number generation (#3044)
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
stress-tess and stress-tess committed Mar 18, 2024
1 parent f807941 commit e07f70e
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions pydoc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ Usage Guide
usage/groupby
usage/strings
usage/categorical
usage/random
usage/segarray
usage/arrayview
34 changes: 34 additions & 0 deletions pydoc/usage/random.rst
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

0 comments on commit e07f70e

Please sign in to comment.