Skip to content
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

Removed random decorators #227

Merged
merged 2 commits into from
Nov 17, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
corrected some documentation
  • Loading branch information
nwlandry committed Nov 16, 2022
commit 4459acfd1bfc8714772c009d6a6e4c283ab92cfa
2 changes: 2 additions & 0 deletions xgi/generators/classic.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ def flag_complex(G, max_order=2, ps=None, seed=None):
hyperedge from a clique, at each order d. For example,
ps[0] is the probability of promoting any 3-node clique (triangle) to
a 3-hyperedge.
seed: int or None (default)
The seed for the random number generator

Returns
-------
Expand Down
19 changes: 12 additions & 7 deletions xgi/generators/nonuniform.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ def chung_lu_hypergraph(k1, k2, seed=None):
k2 : dictionary
Dictionary where the keys are edge ids
and the values are edge sizes.
seed : integer, random_state, or None (default)
Indicator of random number generation state.
seed : integer or None (default)
The seed for the random number generator.

Returns
-------
Expand Down Expand Up @@ -137,8 +137,8 @@ def dcsbm_hypergraph(k1, k2, g1, g2, omega, seed=None):
The number of rows must match the number of node communities
and the number of columns must match the number of edge
communities.
seed : int, random_state, or None (default)
Indicator of random number generation state.
seed : int or None (default)
Seed for the random number generator.

Returns
-------
Expand Down Expand Up @@ -265,8 +265,8 @@ def random_hypergraph(N, ps, seed=None):
hyperedge at each order d between any d+1 nodes. For example,
ps[0] is the wiring probability of any edge (2 nodes), ps[1]
of any triangles (3 nodes).
seed : integer, random_state, or None (default)
Indicator of random number generation state.
seed : integer or None (default)
Seed for the random number generator.

Returns
-------
Expand Down Expand Up @@ -324,6 +324,8 @@ def random_simplicial_complex(N, ps, seed=None):
hyperedge at each order d between any d+1 nodes. For example,
ps[0] is the wiring probability of any edge (2 nodes), ps[1]
of any triangles (3 nodes).
seed : int or None (default)
The seed for the random number generator

Returns
-------
Expand Down Expand Up @@ -377,6 +379,8 @@ def random_flag_complex_d2(N, p, seed=None):
p : float
Probabilities (between 0 and 1) to create an edge
between any 2 nodes
seed : int or None (default)
The seed for the random number generator

Returns
-------
Expand Down Expand Up @@ -421,9 +425,10 @@ def random_flag_complex(N, p, max_order=2, seed=None):
p : float
Probabilities (between 0 and 1) to create an edge
between any 2 nodes

max_order : int
maximal dimension of simplices to add to the output simplicial complex
seed : int or None (default)
The seed for the random number generator

Returns
-------
Expand Down
4 changes: 2 additions & 2 deletions xgi/generators/uniform.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ def uniform_hypergraph_configuration_model(k, m, seed=None):
and the values are node degrees.
m : int
specifies the hyperedge size
seed : integer, random_state, or None (default)
Indicator of random number generation state.
seed : integer or None (default)
The seed for the random number generator

Returns
-------
Expand Down