Skip to content

Commit a0a95c9

Browse files
ronrestsoumith
authored andcommitted
Add Random Number Generator Docstrings (pytorch#506)
1 parent 1335b7c commit a0a95c9

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

torch/__init__.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,33 @@ def set_default_tensor_type(t):
9090

9191

9292
def set_rng_state(new_state):
93+
r"""Sets the random number generator state.
94+
95+
Args:
96+
new_state (torch.ByteTensor): The desired state
97+
"""
9398
default_generator.set_state(new_state)
9499

95100

96101
def get_rng_state():
102+
r"""Returns the random number generator state as a ByteTensor."""
97103
return default_generator.get_state()
98104

99105

100106
def manual_seed(seed):
107+
r"""Sets the seed for generating random numbers. And returns a
108+
`torch._C.Generator` object.
109+
110+
Args:
111+
seed (int or long): The desired seed.
112+
"""
101113
return default_generator.manual_seed(seed)
102114

103115

104116
def initial_seed():
117+
r"""Returns the initial seed for generating random numbers as a
118+
python `long`.
119+
"""
105120
return default_generator.initial_seed()
106121

107122

0 commit comments

Comments
 (0)