Skip to content

Commit 349727f

Browse files
committed
Added documentation for setSeed.
1 parent cf3c647 commit 349727f

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ the sampled values for all the global parameters and objects in the scene from t
4040

4141
ego has foo = 2.083099362726706
4242

43+
Utilities
44+
---------
45+
46+
Scenic provides top level utility functions for functions like setting Scenic's random seed.
47+
48+
.. autofunction:: scenic.setSeed
49+
4350
Running Dynamic Simulations
4451
---------------------------
4552

src/scenic/core/utils.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,5 +399,6 @@ def get_type_hints(obj, globalns=None, localns=None):
399399

400400

401401
def setSeed(seed):
402+
"""Set the random seed used by Scenic"""
402403
random.seed(seed)
403404
numpy.random.seed(seed)

0 commit comments

Comments
 (0)