API reference
Connectome routing
Signatures, parameters, return contracts, and source for connectome routing.
Overview
The routing modules construct procedural contact identities and delayed event delivery. ProceduralMorphologyConnectomeRouter retains morphology-conditioned branch targeting. Population IDs, local/long-range source identities, delay slots, and route topology must agree with the declared workload; procedural routing does not imply an empirical connectome.
Source revision: caef7be03abd. Public export index.
DelayBucket
axosim.connectome.DelayBucket(delay_steps: int, first_fanout_offset: int, event_count_per_source: int, local_targets: bool)
Routing metadata for contacts with one delivery delay.
Parameters
delay_stepsint- required.
first_fanout_offsetint- required.
event_count_per_sourceint- required.
local_targetsbool- required.
Attributes
Constructor fields are retained as read-only attributes.
Read-only attributes
DelayBucket.fanout_offsets: tuple[int, ...]- Source
procedural_delay_buckets
axosim.connectome.procedural_delay_buckets(*, fanout: int, local_fanout: int, minimum_delay_steps: int=1) -> tuple[DelayBucket, ...]
Partition fanout offsets into local/long-range delay classes.
Parameters
fanoutint- keyword-only, required.
local_fanoutint- keyword-only, required.
minimum_delay_stepsint- keyword-only, default=1.
Returns
tuple[DelayBucket, ...]
compact_active_sources
axosim.connectome.compact_active_sources(outputs: torch.Tensor, *, threshold: float=0.0) -> torch.Tensor
Return source-sorted int32 indices whose scalar output fires.
Parameters
outputstorch.Tensor- required. Number of readout channels.
thresholdfloat- keyword-only, default=0.0.
Returns
torch.Tensor
build_typed_tile_pools
axosim.connectome.build_typed_tile_pools(source_is_inhibitory: torch.Tensor, physical_to_logical: torch.Tensor, *, spatial_tile_neurons: int) -> tuple[torch.Tensor, torch.Tensor, torch.Tensor]
Build invertible logical E/I ranks within every spatial tile.
Parameters
source_is_inhibitorytorch.Tensor- required.
physical_to_logicaltorch.Tensor- required.
spatial_tile_neuronsint- keyword-only, required.
Returns
tuple[torch.Tensor, torch.Tensor, torch.Tensor]
build_external_count_branch_bank
axosim.connectome.build_external_count_branch_bank(*, slot_map: torch.Tensor, morphology_gain: torch.Tensor, feature_gain: torch.Tensor, synapses_per_branch: int, max_event_count: int=32, channels_per_type: int | None=None) -> torch.Tensor
Precompute exact branch currents for a consecutive event pattern.
Parameters
slot_maptorch.Tensor- keyword-only, required.
morphology_gaintorch.Tensor- keyword-only, required.
feature_gaintorch.Tensor- keyword-only, required.
synapses_per_branchint- keyword-only, required.
max_event_countint- keyword-only, default=32.
channels_per_typeint | None- keyword-only, default=None.
Returns
torch.Tensor
TrajectoryExternalBranchDrive
axosim.connectome.TrajectoryExternalBranchDrive(*, trajectories: torch.Tensor, branch_bank: torch.Tensor, logical_ids: torch.Tensor, morphology: torch.Tensor, seed: int, excitatory_gain: float, inhibitory_gain: float, slot_map: torch.Tensor | None=None, morphology_gain: torch.Tensor | None=None, feature_gain: torch.Tensor | None=None, synapses_per_branch: int | None=None, block_rows: int=8, block_branches: int=128)
Exact native-time trajectory drive at the learned branch boundary.
Parameters
trajectoriestorch.Tensor- keyword-only, required.
branch_banktorch.Tensor- keyword-only, required.
logical_idstorch.Tensor- keyword-only, required.
morphologytorch.Tensor- keyword-only, required. Enable gradients on morphology-shared adaptation rows.
seedint- keyword-only, required. Random seed for the declared operation.
excitatory_gainfloat- keyword-only, required.
inhibitory_gainfloat- keyword-only, required.
slot_maptorch.Tensor | None- keyword-only, default=None.
morphology_gaintorch.Tensor | None- keyword-only, default=None.
feature_gaintorch.Tensor | None- keyword-only, default=None.
synapses_per_branchint | None- keyword-only, default=None.
block_rowsint- keyword-only, default=8.
block_branchesint- keyword-only, default=128.
Methods
TrajectoryExternalBranchDrive.materialize
axosim.connectome.TrajectoryExternalBranchDrive.materialize(step: int, *, output: torch.Tensor | None=None, add_existing: bool=False, existing: torch.Tensor | None=None, recurrent_bits: torch.Tensor | None=None) -> torch.Tensor
Materialize exact branch currents for one native timestep.
Parameters
stepint- required.
outputtorch.Tensor | None- keyword-only, default=None.
add_existingbool- keyword-only, default=False.
existingtorch.Tensor | None- keyword-only, default=None.
recurrent_bitstorch.Tensor | None- keyword-only, default=None.
Returns
torch.Tensor
ProceduralBinaryChannelConnectomeRouter
axosim.connectome.ProceduralBinaryChannelConnectomeRouter(contract: LargePopulationSimulationContract, *, slot_map: torch.Tensor, morphology: torch.Tensor, source_is_inhibitory: torch.Tensor, morphology_gain: torch.Tensor, feature_gain: torch.Tensor, synapses_per_branch: int, physical_to_logical: torch.Tensor | None=None, logical_to_physical: torch.Tensor | None=None, route_block_size: int=512, route_num_warps: int=4, branch_block_rows: int=8, branch_block_size: int=128)
Exact delayed routing in AxoBench’s signed binary-channel space.
Parameters
contractLargePopulationSimulationContract- required.
slot_maptorch.Tensor- keyword-only, required.
morphologytorch.Tensor- keyword-only, required. Enable gradients on morphology-shared adaptation rows.
source_is_inhibitorytorch.Tensor- keyword-only, required.
morphology_gaintorch.Tensor- keyword-only, required.
feature_gaintorch.Tensor- keyword-only, required.
synapses_per_branchint- keyword-only, required.
physical_to_logicaltorch.Tensor | None- keyword-only, default=None.
logical_to_physicaltorch.Tensor | None- keyword-only, default=None.
route_block_sizeint- keyword-only, default=512.
route_num_warpsint- keyword-only, default=4.
branch_block_rowsint- keyword-only, default=8.
branch_block_sizeint- keyword-only, default=128.
Read-only attributes
ProceduralBinaryChannelConnectomeRouter.queue_bytes: int- Physical storage allocated to the delayed event queue. Source
Methods
ProceduralBinaryChannelConnectomeRouter.current_channel_bits()ProceduralBinaryChannelConnectomeRouter.current_inputs()ProceduralBinaryChannelConnectomeRouter.clear_and_route()
ProceduralBinaryChannelConnectomeRouter.current_channel_bits
axosim.connectome.ProceduralBinaryChannelConnectomeRouter.current_channel_bits(current_slot: int) -> torch.Tensor
Parameters
current_slotint- required.
Returns
torch.Tensor
ProceduralBinaryChannelConnectomeRouter.current_inputs
axosim.connectome.ProceduralBinaryChannelConnectomeRouter.current_inputs(current_slot: int, *, output: torch.Tensor | None=None) -> torch.Tensor
Convert one exact binary channel slot to learned branch currents.
Parameters
current_slotint- required.
outputtorch.Tensor | None- keyword-only, default=None.
Returns
torch.Tensor
ProceduralBinaryChannelConnectomeRouter.clear_and_route
axosim.connectome.ProceduralBinaryChannelConnectomeRouter.clear_and_route(active_sources: torch.Tensor, *, current_slot: int, clear_consumed: bool=True) -> torch.Tensor
Clear a consumed slot and OR new delayed recurrent channels.
Parameters
active_sourcestorch.Tensor- required.
current_slotint- keyword-only, required.
clear_consumedbool- keyword-only, default=True.
Returns
torch.Tensor
ProceduralExactBranchConnectomeRouter
axosim.connectome.ProceduralExactBranchConnectomeRouter(*args, external_trajectories: torch.Tensor | None=None, external_seed: int=0, external_excitatory_gain: float=1.0, external_inhibitory_gain: float=1.0, max_external_event_count: int=32, **kwargs)
Sparse exact-OR routing with ready-to-consume branch currents.
Bases: ProceduralBinaryChannelConnectomeRouter.
Parameters
argsunannotated- variadic.
external_trajectoriestorch.Tensor | None- keyword-only, default=None.
external_seedint- keyword-only, default=0.
external_excitatory_gainfloat- keyword-only, default=1.0.
external_inhibitory_gainfloat- keyword-only, default=1.0.
max_external_event_countint- keyword-only, default=32.
kwargsunannotated- variadic.
Read-only attributes
ProceduralExactBranchConnectomeRouter.queue_bytes: int- Physical storage allocated to the delayed event queue. Source
Methods
ProceduralExactBranchConnectomeRouter.current_inputs()ProceduralExactBranchConnectomeRouter.clear_and_route()
ProceduralExactBranchConnectomeRouter.current_inputs
axosim.connectome.ProceduralExactBranchConnectomeRouter.current_inputs(current_slot: int, *, output: torch.Tensor | None=None) -> torch.Tensor
Parameters
current_slotint- required.
outputtorch.Tensor | None- keyword-only, default=None.
Returns
torch.Tensor
ProceduralExactBranchConnectomeRouter.clear_and_route
axosim.connectome.ProceduralExactBranchConnectomeRouter.clear_and_route(active_sources: torch.Tensor, *, current_slot: int, current_step: int | None=None, clear_consumed: bool=True) -> torch.Tensor
Clear consumed state and route each binary channel at most once.
Parameters
active_sourcestorch.Tensor- required.
current_slotint- keyword-only, required.
current_stepint | None- keyword-only, default=None.
clear_consumedbool- keyword-only, default=True.
Returns
torch.Tensor
ProceduralMorphologyConnectomeRouter
axosim.connectome.ProceduralMorphologyConnectomeRouter(contract: LargePopulationSimulationContract, *, slot_map: torch.Tensor, morphology: torch.Tensor, source_is_inhibitory: torch.Tensor, morphology_gain: torch.Tensor, feature_gain: torch.Tensor, synapses_per_branch: int, physical_to_logical: torch.Tensor | None=None, logical_to_physical: torch.Tensor | None=None, route_block_size: int=512, route_num_warps: int=4)
Persistent delay-queue router for the scalable connectome control.
Parameters
contractLargePopulationSimulationContract- required.
slot_maptorch.Tensor- keyword-only, required.
morphologytorch.Tensor- keyword-only, required. Enable gradients on morphology-shared adaptation rows.
source_is_inhibitorytorch.Tensor- keyword-only, required.
morphology_gaintorch.Tensor- keyword-only, required.
feature_gaintorch.Tensor- keyword-only, required.
synapses_per_branchint- keyword-only, required.
physical_to_logicaltorch.Tensor | None- keyword-only, default=None.
logical_to_physicaltorch.Tensor | None- keyword-only, default=None.
route_block_sizeint- keyword-only, default=512.
route_num_warpsint- keyword-only, default=4.
Methods
ProceduralMorphologyConnectomeRouter.current_inputs()ProceduralMorphologyConnectomeRouter.clear_and_route()ProceduralMorphologyConnectomeRouter.clear_recorded_branches()
ProceduralMorphologyConnectomeRouter.current_inputs
axosim.connectome.ProceduralMorphologyConnectomeRouter.current_inputs(current_slot: int) -> torch.Tensor
Parameters
current_slotint- required.
Returns
torch.Tensor
ProceduralMorphologyConnectomeRouter.clear_and_route
axosim.connectome.ProceduralMorphologyConnectomeRouter.clear_and_route(active_sources: torch.Tensor, *, current_slot: int, clear_consumed: bool=True, touched_offsets: torch.Tensor | None=None) -> torch.Tensor
Clear a consumed queue slot and schedule new delayed events.
Parameters
active_sourcestorch.Tensor- required.
current_slotint- keyword-only, required.
clear_consumedbool- keyword-only, default=True.
touched_offsetstorch.Tensor | None- keyword-only, default=None.
Returns
torch.Tensor
ProceduralMorphologyConnectomeRouter.clear_recorded_branches
axosim.connectome.ProceduralMorphologyConnectomeRouter.clear_recorded_branches(touched_offsets: torch.Tensor) -> None
Clear branch queue destinations recorded by event delivery.
Parameters
touched_offsetstorch.Tensor- required.
Returns
resultNone- No return value.
ProceduralUniqueChannelConnectomeRouter
axosim.connectome.ProceduralUniqueChannelConnectomeRouter(*args, synaptic_efficacy_bank: QuantizedSynapticEfficacyBank | None=None, external_trajectories: torch.Tensor | None=None, external_seed: int=0, external_excitatory_gain: float=1.0, external_inhibitory_gain: float=1.0, max_external_event_count: int=32, allow_repeated_source_target_pairs: bool=False, **kwargs)
Collision-free typed fan-in with invertible event-wise routing.
Bases: ProceduralMorphologyConnectomeRouter.
Parameters
argsunannotated- variadic.
synaptic_efficacy_bankQuantizedSynapticEfficacyBank | None- keyword-only, default=None.
external_trajectoriestorch.Tensor | None- keyword-only, default=None.
external_seedint- keyword-only, default=0.
external_excitatory_gainfloat- keyword-only, default=1.0.
external_inhibitory_gainfloat- keyword-only, default=1.0.
max_external_event_countint- keyword-only, default=32.
allow_repeated_source_target_pairsbool- keyword-only, default=False.
kwargsunannotated- variadic.
Read-only attributes
ProceduralUniqueChannelConnectomeRouter.queue_bytes: int- Physical storage allocated to the delayed event queue. Source
ProceduralUniqueChannelConnectomeRouter.recorded_offsets_per_source: int- Candidate offset slots needed to record one routed source. Source
Methods
ProceduralUniqueChannelConnectomeRouter.clear_and_route
axosim.connectome.ProceduralUniqueChannelConnectomeRouter.clear_and_route(active_sources: torch.Tensor, *, current_slot: int, current_step: int | None=None, clear_consumed: bool=True, touched_offsets: torch.Tensor | None=None, unique_rows: torch.Tensor | None=None, unique_row_flags: torch.Tensor | None=None, unique_row_count: torch.Tensor | None=None) -> torch.Tensor
Route the exact selected typed channel for each active source.
Parameters
active_sourcestorch.Tensor- required.
current_slotint- keyword-only, required.
current_stepint | None- keyword-only, default=None.
clear_consumedbool- keyword-only, default=True.
touched_offsetstorch.Tensor | None- keyword-only, default=None.
unique_rowstorch.Tensor | None- keyword-only, default=None.
unique_row_flagstorch.Tensor | None- keyword-only, default=None.
unique_row_counttorch.Tensor | None- keyword-only, default=None.
Returns
torch.Tensor