Skip to content

Commit

Permalink
Add Random Number Generator Docstrings (pytorch#506)
Browse files Browse the repository at this point in the history
  • Loading branch information
ronrest authored and soumith committed Jan 19, 2017
1 parent 1335b7c commit a0a95c9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions torch/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,33 @@ def set_default_tensor_type(t):


def set_rng_state(new_state):
r"""Sets the random number generator state.
Args:
new_state (torch.ByteTensor): The desired state
"""
default_generator.set_state(new_state)


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


def manual_seed(seed):
r"""Sets the seed for generating random numbers. And returns a
`torch._C.Generator` object.
Args:
seed (int or long): The desired seed.
"""
return default_generator.manual_seed(seed)


def initial_seed():
r"""Returns the initial seed for generating random numbers as a
python `long`.
"""
return default_generator.initial_seed()


Expand Down

0 comments on commit a0a95c9

Please sign in to comment.