Doc for branch_edges

jaxleyverse · Dec 18, 2023 · 0efd2e3 · 0efd2e3
1 parent f098e77
commit 0efd2e3
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/jaxley/modules/network.py b/jaxley/modules/network.py
@@ -55,6 +55,13 @@ def __init__(
             c.synapse_type.synapse_states.keys() for c in connectivities
         ]
 
+        # Two columns: `parent_branch_index` and `child_branch_index`. One row per
+        # branch, apart from those branches which do not have a parent (i.e.
+        # -1 in parents). For every branch, tracks the global index of that branch
+        # (`child_branch_index`) and the global index of its parent 
+        # (`parent_branch_index`). Needed at `init_syns()`.
+        self.branch_edges: Optional[pd.DataFrame] = None
+
         self.initialize()
         self.init_syns(connectivities)