Skip to content

NEP: update NEP 19 with API terminology #13595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2019
Merged

Conversation

mattip
Copy link
Member

@mattip mattip commented May 20, 2019

With #13163 almost ready to merge, this updates the NEP with the terminology adopted there:

  • the BitGenerator is the class that generates a stream of random bits
  • the Generator holds a BitGenerator instance and can turn the stream of bits into ints and floats drawn from various distributions (uniform, normal, ...)
  • the canonical function to produce uniformly distributed integers is integers (as an implementation detail it accepts an endpoint keyword to produce open or closed intervals)
  • the canonical function to produce uniformly distributed floats is random, which parallels the use of random.random in the python (non-numpy) module.

@rkern
Copy link
Member

rkern commented May 20, 2019

LGTM.

@mattip mattip force-pushed the update-nep-0019 branch from 6265662 to 7349f13 Compare May 21, 2019 02:20
@mattip
Copy link
Member Author

mattip commented May 21, 2019

Added an Updated field

@seberg
Copy link
Member

seberg commented May 21, 2019

Looks good, there are still a few occurances of "basic RNG" (and one "RandomGenerator"), those should probably be replaced as well?

@mattip mattip force-pushed the update-nep-0019 branch from 7349f13 to 3349fec Compare May 21, 2019 18:54
@mattip
Copy link
Member Author

mattip commented May 21, 2019

a few occurances of "basic RNG" (and one "RandomGenerator")

Could you review again? I think I got them all

@seberg
Copy link
Member

seberg commented May 21, 2019

Thanks Matti, since Robert Kern likes it also, lets put it in.

@seberg seberg merged commit 62d8844 into numpy:master May 21, 2019
@mattip mattip deleted the update-nep-0019 branch August 8, 2019 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants