pygrenade_vx.common.Projection

class pygrenade_vx.common.Projection

Bases: pygrenade_common.PartitionedVertex

__init__(*args, **kwargs)

Overloaded function.

__init__(self: pygrenade_common.Projection, synapse: pygrenade_common.Projection.Synapse, parameter_space: pygrenade_common.Projection.Synapse.ParameterSpace, connector: pygrenade_common.Projection.Connector, time_domain: Optional[pygrenade_common.TimeDomainOnTopology], execution_instance_on_executor: Optional[pygrenade_common.ExecutionInstanceOnExecutor] = None) -> None

Construct projection.

__init__(self: pygrenade_common.Projection, arg0: pygrenade_common.Projection) -> None

Methods

`__init__`(args, *kwargs)	Overloaded function.
`copy`(self)
`get_connector`(self)	Get connector property.
`get_input_ports`(self)	Get input ports to the projection.
`get_output_ports`(self)	Get input ports to the projection.
`get_synapse`(self)	Get synapse type property.
`get_synapse_parameter_space`(self)	Get parameter space of synapses on the projection.
`get_time_domain`(self)
`move`(self)
`set_connector`(self, connector)	Set connector property.
`set_execution_instance_on_executor`(self, value)	Set execution instance on the executor.
`set_synapse`(self, synapse)	Set synapse type property.
`set_synapse_parameter_space`(self, …)	Set parameter space of synapses on the projection.
`set_time_domain`(self, value)	Set time domain.
`size`(self)	Get the number of synapses of the projection.
`valid`(self, time_domain_runtimes)	Get whether the time domain is valid for the projection.
`valid_input_port_data`(self, …)	Get whether the data is valid for the input port on the projection.

class Connector

Bases: pybind11_builtins.pybind11_object

class Dynamics

Bases: pygrenade_common.BatchedPortData

get_section(self: pygrenade_common.Projection.Connector.Dynamics, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Projection.Connector.Dynamics: Get section of dynamics. The sequence is required to be included in the connector shape (input_sequence x output_sequence).

class Parameterization

Bases: pygrenade_common.PortData

get_section(self: pygrenade_common.Projection.Connector.Parameterization, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Projection.Connector.Parameterization: Get section of parameterization. The sequence is required to be included in the connector shape (input_sequence x output_sequence).

get_input_ports(self: pygrenade_common.Projection.Connector) → list[pygrenade_common.Vertex.Port]: Input ports this connector exposes at the projection.

get_input_sequence(self: pygrenade_common.Projection.Connector) → pygrenade_common.MultiIndexSequence: Get sequence of (pre-synaptic) inputs generated by connector.

get_num_synapse_parameterizations(self: pygrenade_common.Projection.Connector, sequence: pygrenade_common.MultiIndexSequence) → int: Get number of synapse parameterizations required by connector.

get_num_synapses(self: pygrenade_common.Projection.Connector, sequence: pygrenade_common.MultiIndexSequence) → int: Get number of synapses generated by connector.

get_output_ports(self: pygrenade_common.Projection.Connector) → list[pygrenade_common.Vertex.Port]: Output ports this connector exposes at the projection.

get_output_sequence(self: pygrenade_common.Projection.Connector) → pygrenade_common.MultiIndexSequence: Get sequence of (post-synaptic) outputs generated by connector.

get_section(self: pygrenade_common.Projection.Connector, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Projection.Connector: Get section of connector. The sequence is required to be included in the connector shape (input_sequence x output_sequence).

get_synapse_parameterization_indices(self: pygrenade_common.Projection.Connector, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.MultiIndexSequence: Get sequence of indices of synapse parameterizations required by connector. This sequence describes the indices in the 1d space of synapse parameterizations. There might be cases, where multiple synapses share the same parameterization (e.g. for convolutions).

valid(*args, **kwargs)

Overloaded function.

valid(self: pygrenade_common.Projection.Connector, input_port_on_connector: int, parameterization: pygrenade_common.Projection.Connector.Parameterization) -> bool
valid(self: pygrenade_common.Projection.Connector, input_port_on_connector: int, dynamics: pygrenade_common.Projection.Connector.Dynamics) -> bool

class Synapse

Bases: pybind11_builtins.pybind11_object

class Dynamics

Bases: pygrenade_common.BatchedPortData

batch_size(self: pygrenade_common.Projection.Synapse.Dynamics) → int

get_section(self: pygrenade_common.Projection.Synapse.Dynamics, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Projection.Synapse.Dynamics: Get section of dynamics. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Projection.Synapse.Dynamics) → int

class ParameterSpace

Bases: pybind11_builtins.pybind11_object

class Parameterization

Bases: pygrenade_common.PortData

get_section(self: pygrenade_common.Projection.Synapse.ParameterSpace.Parameterization, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Projection.Synapse.ParameterSpace.Parameterization: Get section of parameterization. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Projection.Synapse.ParameterSpace.Parameterization) → int

get_section(self: pygrenade_common.Projection.Synapse.ParameterSpace, sequence: pygrenade_common.MultiIndexSequence) → pygrenade_common.Projection.Synapse.ParameterSpace: Get section of parameter space. The sequence is required to be included in the interval [0, size()).

size(self: pygrenade_common.Projection.Synapse.ParameterSpace) → int

valid(self: pygrenade_common.Projection.Synapse.ParameterSpace, input_port_on_synapse: int, parameterization: pygrenade_common.Projection.Synapse.ParameterSpace.Parameterization) → bool

class Ports

Bases: pybind11_builtins.pybind11_object

property projection

property synapse

property synapse_parameterization

get_input_ports(self: pygrenade_common.Projection.Synapse) → pygrenade_common.Projection.Synapse.Ports: Input ports this synapse exposes at the projection.

get_output_ports(self: pygrenade_common.Projection.Synapse) → pygrenade_common.Projection.Synapse.Ports: Output ports this synapse exposes at the projection.

is_partitionable(self: pygrenade_common.Projection.Synapse) → bool

requires_time_domain(self: pygrenade_common.Projection.Synapse) → bool

valid(*args, **kwargs)

Overloaded function.

valid(self: pygrenade_common.Projection.Synapse, parameter_space: pygrenade_common.Projection.Synapse.ParameterSpace) -> bool
valid(self: pygrenade_common.Projection.Synapse, input_port_on_synapse: int, dynamics: pygrenade_common.Projection.Synapse.Dynamics) -> bool
valid(self: pygrenade_common.Projection.Synapse, time_domain_runtimes: pygrenade_common.TimeDomainRuntimes) -> bool

copy(self: pygrenade_common.Projection) → pygrenade_common.Vertex

get_connector(self: pygrenade_common.Projection) → pygrenade_common.Projection.Connector: Get connector property.

get_input_ports(self: pygrenade_common.Projection) → list[pygrenade_common.Vertex.Port]: Get input ports to the projection. Ports are constructed in the order [Synapse::input_ports(), Connector::input_ports()].

get_output_ports(self: pygrenade_common.Projection) → list[pygrenade_common.Vertex.Port]: Get input ports to the projection. Ports are constructed in the order [Synapse::output_ports(), Connector::output_ports()].

get_synapse(self: pygrenade_common.Projection) → pygrenade_common.Projection.Synapse: Get synapse type property.

get_synapse_parameter_space(self: pygrenade_common.Projection) → pygrenade_common.Projection.Synapse.ParameterSpace: Get parameter space of synapses on the projection.

get_time_domain(self: pygrenade_common.Projection) → Optional[pygrenade_common.TimeDomainOnTopology]

move(self: pygrenade_common.Projection) → pygrenade_common.Vertex

set_connector(self: pygrenade_common.Projection, connector: pygrenade_common.Projection.Connector) → None: Set connector property.

set_execution_instance_on_executor(self: pygrenade_common.Projection, value: Optional[pygrenade_common.ExecutionInstanceOnExecutor]) → None: Set execution instance on the executor.

set_synapse(self: pygrenade_common.Projection, synapse: pygrenade_common.Projection.Synapse) → None: Set synapse type property.

set_synapse_parameter_space(self: pygrenade_common.Projection, parameter_space: pygrenade_common.Projection.Synapse.ParameterSpace) → None: Set parameter space of synapses on the projection.

set_time_domain(self: pygrenade_common.Projection, value: Optional[pygrenade_common.TimeDomainOnTopology]) → None: Set time domain.

size(self: pygrenade_common.Projection) → int: Get the number of synapses of the projection.

valid(self: pygrenade_common.Projection, time_domain_runtimes: pygrenade_common.TimeDomainRuntimes) → bool: Get whether the time domain is valid for the projection. This matches the check defined for the synapse.

valid_input_port_data(self: pygrenade_common.Projection, input_port_on_vertex: int, dynamics: pygrenade_common.PortData) → bool: Get whether the data is valid for the input port on the projection.