Skip to content

Commit

Permalink
fix last errors for autodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jcrozum committed Mar 1, 2024
1 parent 70431e7 commit b617471
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
19 changes: 11 additions & 8 deletions balm/motif_avoidant.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
A module responsible for detecting motif-avoidant attractors within terminal restriction space.
A module responsible for detecting motif-avoidant attractors within terminal restriction space.
"""

from __future__ import annotations
Expand Down Expand Up @@ -103,13 +103,16 @@ def detect_motif_avoidant_attractors(
"""
Compute a sub-list of `candidates` which correspond to motif-avoidant
attractors. Other method inputs:
- `graph` and `petri_net` represent the model in which the property
should be checked.
- `terminal_restriction_space` is a symbolic set of states which contains
all motif avoidant attractors (i.e. if a candidate state can leave this
set, the candidate cannot be an attractor).
- `max_iterations` specifies how much time should be spent on the "simpler"
preprocessing before applying a more complete method.
`graph` and `petri_net` represent the model in which the property
should be checked.
`terminal_restriction_space` is a symbolic set of states which contains
all motif avoidant attractors (i.e. if a candidate state can leave this
set, the candidate cannot be an attractor).
`max_iterations` specifies how much time should be spent on the "simpler"
preprocessing before applying a more complete method.
"""
if ensure_subspace is None:
ensure_subspace = {}
Expand Down
15 changes: 8 additions & 7 deletions balm/succession_diagram.py
Original file line number Diff line number Diff line change
Expand Up @@ -677,13 +677,14 @@ def expand_bfs(
) -> bool:
"""
Explore the succession diagram in a BFS manner.
- If `node_id` is given, initiate BFS from this node. Otherwise use
root.
- If `bfs_level_limit` is given, this is the last "level" (distance
from the initial node)
of nodes that should be expanded (any subsequent child nodes are
left unexplored). - If `size_limit` is given, the procedure stops
once `SuccessionDiagram` exceeds the given size.
If `node_id` is given, initiate BFS from this node. Otherwise use root.
If `bfs_level_limit` is given, this is the last "level" (distance from
the initial node) of nodes that should be expanded (any subsequent child
nodes are left unexplored).
If `size_limit` is given, the procedure stops once `SuccessionDiagram`
exceeds the given size.
With default settings, the method will explore the whole succession
diagram without any restrictions.
Expand Down

1 comment on commit b617471

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
balm
   control.py1141488%102, 114, 120, 124, 129, 138–154, 472, 475, 488
   interaction_graph_utils.py30487%6–8, 145–146
   motif_avoidant.py152299%25, 124
   petri_net_translation.py1481193%18–22, 58, 94, 207–208, 232–233, 242, 346
   space_utils.py129497%25–27, 252, 278
   succession_diagram.py2571694%6, 184–189, 197, 257–258, 268, 274, 390, 601, 805, 843, 880
   symbolic_utils.py26388%10–12, 44
   trappist_core.py1833084%11–15, 45, 47, 82, 129, 195, 197, 199, 227–230, 234–236, 256–262, 320, 322, 352, 392, 394, 425, 454
balm/_sd_algorithms
   compute_attractor_seeds.py30197%8
   expand_attractor_seeds.py51590%6, 42, 97–102
   expand_bfs.py28196%6
   expand_dfs.py30197%6
   expand_minimal_spaces.py37295%6, 31
   expand_source_SCCs.py164696%19–21, 91, 101, 143, 287
   expand_to_target.py31390%6, 38, 43
TOTAL147110393% 

Tests Skipped Failures Errors Time
361 0 💤 0 ❌ 0 🔥 53.614s ⏱️

Please sign in to comment.