Skip to content

Commit 5f90b4a

Browse files
Align docs random with NumPy/CuPy short names
1 parent d2a7862 commit 5f90b4a

File tree

1 file changed

+55
-54
lines changed

1 file changed

+55
-54
lines changed

doc/reference/random.rst

Lines changed: 55 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
Random sampling (``dpnp.random``)
2-
=================================
1+
.. currentmodule:: dpnp.random
32

4-
.. https://numpy.org/doc/stable/reference/random/legacy.html
3+
Random sampling (:mod:`dpnp.random`)
4+
====================================
55

6+
.. hint:: `NumPy API Reference: Legacy random generation <https://numpy.org/doc/stable/reference/random/legacy.html>`_
67

78
Simple random data
89
------------------
@@ -11,16 +12,16 @@ Simple random data
1112
:toctree: generated/
1213
:nosignatures:
1314

14-
dpnp.random.rand
15-
dpnp.random.randn
16-
dpnp.random.randint
17-
dpnp.random.random_integers
18-
dpnp.random.random_sample
19-
dpnp.random.random
20-
dpnp.random.ranf
21-
dpnp.random.sample
22-
dpnp.random.choice
23-
dpnp.random.bytes
15+
rand
16+
randn
17+
randint
18+
random_integers
19+
random_sample
20+
random
21+
ranf
22+
sample
23+
choice
24+
bytes
2425

2526

2627
Permutations
@@ -30,8 +31,8 @@ Permutations
3031
:toctree: generated/
3132
:nosignatures:
3233

33-
dpnp.random.shuffle
34-
dpnp.random.permutation
34+
shuffle
35+
permutation
3536

3637

3738
Distributions
@@ -41,41 +42,41 @@ Distributions
4142
:toctree: generated/
4243
:nosignatures:
4344

44-
dpnp.random.beta
45-
dpnp.random.binomial
46-
dpnp.random.chisquare
47-
dpnp.random.dirichlet
48-
dpnp.random.exponential
49-
dpnp.random.f
50-
dpnp.random.gamma
51-
dpnp.random.geometric
52-
dpnp.random.gumbel
53-
dpnp.random.hypergeometric
54-
dpnp.random.laplace
55-
dpnp.random.logistic
56-
dpnp.random.lognormal
57-
dpnp.random.logseries
58-
dpnp.random.multinomial
59-
dpnp.random.multivariate_normal
60-
dpnp.random.negative_binomial
61-
dpnp.random.noncentral_chisquare
62-
dpnp.random.noncentral_f
63-
dpnp.random.normal
64-
dpnp.random.pareto
65-
dpnp.random.poisson
66-
dpnp.random.power
67-
dpnp.random.rayleigh
68-
dpnp.random.standard_cauchy
69-
dpnp.random.standard_exponential
70-
dpnp.random.standard_gamma
71-
dpnp.random.standard_normal
72-
dpnp.random.standard_t
73-
dpnp.random.triangular
74-
dpnp.random.uniform
75-
dpnp.random.vonmises
76-
dpnp.random.wald
77-
dpnp.random.weibull
78-
dpnp.random.zipf
45+
beta
46+
binomial
47+
chisquare
48+
dirichlet
49+
exponential
50+
f
51+
gamma
52+
geometric
53+
gumbel
54+
hypergeometric
55+
laplace
56+
logistic
57+
lognormal
58+
logseries
59+
multinomial
60+
multivariate_normal
61+
negative_binomial
62+
noncentral_chisquare
63+
noncentral_f
64+
normal
65+
pareto
66+
poisson
67+
power
68+
rayleigh
69+
standard_cauchy
70+
standard_exponential
71+
standard_gamma
72+
standard_normal
73+
standard_t
74+
triangular
75+
uniform
76+
vonmises
77+
wald
78+
weibull
79+
zipf
7980

8081

8182
Random generator
@@ -85,7 +86,7 @@ Random generator
8586
:toctree: generated/
8687
:nosignatures:
8788

88-
dpnp.random.RandomState
89-
dpnp.random.seed
90-
dpnp.random.get_random_state
91-
dpnp.random.set_random_state
89+
RandomState
90+
seed
91+
get_random_state
92+
set_random_state

0 commit comments

Comments
 (0)