API reference

Connectivity builders

Signatures, parameters, return contracts, and source for connectivity builders.

Overview

PyNN-style builders wire one population of n neurons, optionally restricted to pre source and post target IDs, and return an ordinary validated ExplicitConnectome for create_population. Each edge takes its source neuron’s role (neuron_roles, +1 or -1; None makes every neuron excitatory) and a destination channel drawn uniformly from the checkpoint channels with that role (channel_roles), unless explicit channels are given. Efficacies and delays are constants, one value per edge, or callables fn(sources, targets, generator); delays are integer native milliseconds of at least MIN_DELAY_MS = 4, the Lite P4 recurrent minimum. One seeded generator is drawn in a fixed order (topology, channels, efficacies, delays), so a seed reproduces the exact graph, and edge IDs follow the returned edge order. Shared keyword arguments are neuron_roles, channel_roles, channels, efficacies, and delays. The builders are exported from axosim; MIN_DELAY_MS is imported from axosim.connectors.

Source revision: caef7be03abd. Public export index.

all_to_all

axosim.connectors.all_to_all(n: int, *, seed: int=0, allow_self: bool=False, pre=None, post=None, **kwargs) -> ExplicitConnectome

Source

Connect every pre neuron to every post neuron once (source-major).

Parameters

n int
required. Positive population size; neuron IDs are 0..n-1.
seed int
keyword-only, default=0. Integer seed of the one generator drawn for topology, channels, efficacies, and delays, in that order; equal seeds give identical graphs.
allow_self bool
keyword-only, default=False. Keep edges from a neuron to itself.
pre unannotated
keyword-only, default=None. Source neuron IDs; None uses all n neurons.
post unannotated
keyword-only, default=None. Target neuron IDs; None uses all n neurons.
kwargs unannotated
variadic. Shared edge options: neuron_roles ((n,) +1/-1, default all excitatory), channel_roles (the checkpoint's (input_dim,) +1/-1 vector, required unless channels is given), channels, efficacies (default 1.0), and delays (default 4 ms). Values are a constant, one per edge, or a callable fn(sources, targets, generator).

Returns

connectome ExplicitConnectome
One edge per (pre, post) pair, source-major, without self-edges unless allow_self.

one_to_one

axosim.connectors.one_to_one(n: int, *, seed: int=0, pre=None, post=None, **kwargs) -> ExplicitConnectome

Source

Connect pre[i] to post[i]; the default pre == post gives autapses.

Parameters

n int
required. Positive population size; neuron IDs are 0..n-1.
seed int
keyword-only, default=0. Integer seed of the one generator drawn for topology, channels, efficacies, and delays, in that order; equal seeds give identical graphs.
pre unannotated
keyword-only, default=None. Source neuron IDs; None uses all n neurons.
post unannotated
keyword-only, default=None. Target neuron IDs; None uses all n neurons.
kwargs unannotated
variadic. Shared edge options: neuron_roles ((n,) +1/-1, default all excitatory), channel_roles (the checkpoint's (input_dim,) +1/-1 vector, required unless channels is given), channels, efficacies (default 1.0), and delays (default 4 ms). Values are a constant, one per edge, or a callable fn(sources, targets, generator).

Returns

connectome ExplicitConnectome
Edges pre[i] -> post[i]; pre and post must have equal length.

fixed_probability

axosim.connectors.fixed_probability(n: int, p: float | Callable[[torch.Tensor, torch.Tensor], torch.Tensor], *, seed: int=0, allow_self: bool=False, pre=None, post=None, **kwargs) -> ExplicitConnectome

Source

Keep each pre -> post pair independently with probability p.

Parameters

n int
required. Positive population size; neuron IDs are 0..n-1.
p float | Callable[[torch.Tensor, torch.Tensor], torch.Tensor]
required. Connection probability in [0, 1], or a callable p(sources, targets) returning one probability per candidate pair, evaluated in chunks; for example a distance-dependent kernel over neuron positions.
seed int
keyword-only, default=0. Integer seed of the one generator drawn for topology, channels, efficacies, and delays, in that order; equal seeds give identical graphs.
allow_self bool
keyword-only, default=False. Keep edges from a neuron to itself.
pre unannotated
keyword-only, default=None. Source neuron IDs; None uses all n neurons.
post unannotated
keyword-only, default=None. Target neuron IDs; None uses all n neurons.
kwargs unannotated
variadic. Shared edge options: neuron_roles ((n,) +1/-1, default all excitatory), channel_roles (the checkpoint's (input_dim,) +1/-1 vector, required unless channels is given), channels, efficacies (default 1.0), and delays (default 4 ms). Values are a constant, one per edge, or a callable fn(sources, targets, generator).

Returns

connectome ExplicitConnectome
Independently kept pairs in source-major order, without parallel edges.

fixed_indegree

axosim.connectors.fixed_indegree(n: int, k: int, *, seed: int=0, allow_self: bool=False, with_replacement: bool=False, pre=None, post=None, **kwargs) -> ExplicitConnectome

Source

Give every post neuron exactly k sources drawn uniformly from pre.

Parameters

n int
required. Positive population size; neuron IDs are 0..n-1.
k int
required. Nonnegative number of sources per post neuron.
seed int
keyword-only, default=0. Integer seed of the one generator drawn for topology, channels, efficacies, and delays, in that order; equal seeds give identical graphs.
allow_self bool
keyword-only, default=False. Keep edges from a neuron to itself.
with_replacement bool
keyword-only, default=False. Draw sources with replacement; repeated draws become parallel edges. Without replacement the k sources of a target are distinct.
pre unannotated
keyword-only, default=None. Source neuron IDs; None uses all n neurons.
post unannotated
keyword-only, default=None. Target neuron IDs; None uses all n neurons.
kwargs unannotated
variadic. Shared edge options: neuron_roles ((n,) +1/-1, default all excitatory), channel_roles (the checkpoint's (input_dim,) +1/-1 vector, required unless channels is given), channels, efficacies (default 1.0), and delays (default 4 ms). Values are a constant, one per edge, or a callable fn(sources, targets, generator).

Returns

connectome ExplicitConnectome
Exactly k edges into every post neuron, ordered by target, then source.

from_list

axosim.connectors.from_list(n: int, edges, *, efficacies: EdgeValues | None=None, delays: EdgeValues | None=None, seed: int=0, **kwargs) -> ExplicitConnectome

Source

Build from rows (source, target[, efficacy[, delay]]) in the given order.

Parameters

n int
required. Positive population size; neuron IDs are 0..n-1.
edges unannotated
required. Rows (source, target[, efficacy[, delay]]) in edge order; integer neuron IDs in [0, n).
efficacies EdgeValues | None
keyword-only, default=None. Nonnegative edge magnitudes: a constant, one value per edge, or a callable; exclusive with an efficacy column. None means 1.0.
delays EdgeValues | None
keyword-only, default=None. Integer native delays of at least 4 ms: a constant, one value per edge, or a callable; exclusive with a delay column. None means 4 ms.
seed int
keyword-only, default=0. Integer seed of the one generator drawn for topology, channels, efficacies, and delays, in that order; equal seeds give identical graphs.
kwargs unannotated
variadic. Shared edge options: neuron_roles ((n,) +1/-1, default all excitatory), channel_roles (the checkpoint's (input_dim,) +1/-1 vector, required unless channels is given), channels, efficacies (default 1.0), and delays (default 4 ms). Values are a constant, one per edge, or a callable fn(sources, targets, generator).

Returns

connectome ExplicitConnectome
The listed edges in the given order.

concatenate

axosim.connectors.concatenate(*connectomes: ExplicitConnectome) -> ExplicitConnectome

Source

Join graphs edge-wise; part i’s edge IDs follow those of parts < i.

Parameters

connectomes ExplicitConnectome
variadic. ExplicitConnectome parts; the outgoing edges of each neuron must share one role across parts.

Returns

connectome ExplicitConnectome
All edges joined; the edge IDs of part i follow those of the parts before it.

Search guides, examples, and API signatures.