API reference
Population simulation contracts
Signatures, parameters, return contracts, and source for population simulation contracts.
Overview
The immutable simulation contract specifies the connected workload and timing boundary. PopulationInferenceProfile specifies a deployment recipe. These values are declarations, not measured speed results. Check the technical report’s measured throughput at the contact count and population scale relevant to your application.
Source revision: caef7be03abd. Public export index.
LargePopulationSimulationContract
axosim.simulation_contract.LargePopulationSimulationContract(name: str, population_size: int, step_ms: float, input_step_ms: float, output_step_ms: float, target_latency_ms: float, model_family: str, patch_size: int, temporal_execution_mode: str, patch_phase_mode: str, patch_phase_assignment: str, patch_phase_storage_layout: str, lossless_ordered_temporal_io: bool, causal_block_feedback_required: bool, minimum_routing_delay_steps: int, synaptic_efficacy_values_per_neuron: int, adaptation_storage_bits: int, activation_storage_bits: int, recurrent_state_storage_bits: int, external_drive_storage_bits: int, morphology_classes: int, firing_rate: float, fanout: int, recurrent_contact_fraction: float, excitatory_fraction: float, local_connection_fraction: float, spatial_tile_neurons: int, delay_slots: int, branch_count: int, local_source_identity_required: bool, long_range_source_identity_required: bool, local_branch_input_mode: str, input_channel_collision_mode: str, local_source_summary_is_lossless_for_declared_router: bool, posthoc_source_projection_allowed: bool, morphology_assignment_independent: bool, activity_must_be_model_generated: bool, quota_activity_forcing_allowed: bool, activity_selection_mode: str, adaptation_reference_envelope_validation_required: bool, morphology_aware_branch_targeting: bool = True, source_type_aware_branch_targeting: bool = True, source_discovery_included: bool = True, event_delivery_included: bool = True, delay_queue_included: bool = True, every_neuron_has_custom_adaptation: bool = True, empirical_connectome: bool = False)
Fully specified model and network workload for a population step.
Parameters
namestr- required. Name of the optional shard array or declared record.
population_sizeint- required. Number of persistent neurons.
step_msfloat- required.
input_step_msfloat- required.
output_step_msfloat- required.
target_latency_msfloat- required.
model_familystr- required.
patch_sizeint- required. Native timesteps represented by one block.
temporal_execution_modestr- required.
patch_phase_modestr- required.
patch_phase_assignmentstr- required.
patch_phase_storage_layoutstr- required.
lossless_ordered_temporal_iobool- required.
causal_block_feedback_requiredbool- required.
minimum_routing_delay_stepsint- required.
synaptic_efficacy_values_per_neuronint- required.
adaptation_storage_bitsint- required.
activation_storage_bitsint- required.
recurrent_state_storage_bitsint- required.
external_drive_storage_bitsint- required.
morphology_classesint- required.
firing_ratefloat- required.
fanoutint- required.
recurrent_contact_fractionfloat- required.
excitatory_fractionfloat- required.
local_connection_fractionfloat- required.
spatial_tile_neuronsint- required.
delay_slotsint- required.
branch_countint- required.
local_source_identity_requiredbool- required.
long_range_source_identity_requiredbool- required.
local_branch_input_modestr- required.
input_channel_collision_modestr- required.
local_source_summary_is_lossless_for_declared_routerbool- required.
posthoc_source_projection_allowedbool- required.
morphology_assignment_independentbool- required.
activity_must_be_model_generatedbool- required.
quota_activity_forcing_allowedbool- required.
activity_selection_modestr- required.
adaptation_reference_envelope_validation_requiredbool- required.
morphology_aware_branch_targetingbool- default=True.
source_type_aware_branch_targetingbool- default=True.
source_discovery_includedbool- default=True.
event_delivery_includedbool- default=True.
delay_queue_includedbool- default=True.
every_neuron_has_custom_adaptationbool- default=True.
empirical_connectomebool- default=False.
Attributes
Constructor fields are retained as read-only attributes.
Read-only attributes
LargePopulationSimulationContract.steps_per_second: float- Source
LargePopulationSimulationContract.target_neuron_steps_per_second: float- Source
LargePopulationSimulationContract.largest_patch_phase_population: int- Source
LargePopulationSimulationContract.active_sources_per_step: int- Source
LargePopulationSimulationContract.events_per_step: int- Source
LargePopulationSimulationContract.synaptic_efficacy_bank_bytes: int- Source
LargePopulationSimulationContract.delay_queue_bytes: int- Source
LargePopulationSimulationContract.external_drive_block_bytes: int- Source
Methods
LargePopulationSimulationContract.bytes_to_gib
@staticmethod
axosim.simulation_contract.LargePopulationSimulationContract.bytes_to_gib(byte_count: int) -> float
Convert a byte count to gibibytes using 1024 cubed bytes per GiB.
Parameters
byte_countint- required. Storage count in bytes.
Returns
float
PopulationInferenceProfile
axosim.simulation_contract.PopulationInferenceProfile(name: str, support_model_id: str, support_token_width: int, support_state_width: int, support_block_rows: int, support_block_token: int, support_block_state: int, external_block_width: int, project_block_width: int, compiled_adaptation_values_per_neuron: int, morphology_adapter_values_per_class: int, synaptic_efficacy_values_per_neuron: int, output_export_fraction: float, primary_metric: str, minimum_neuron_steps_per_second: float, measured_median_neuron_steps_per_second: float, measured_p90_neuron_steps_per_second: float, measured_voltage_sera_mv2: float, measured_voltage_root_sera_mv: float, measured_spike_mean_f1: float, measured_population_firing_rate_hz: float, population_adaptation_initialization: str, population_adaptation_individually_fitted: bool, individual_behavior_adaptation_supported: bool, individual_synaptic_adaptation_supported: bool)
Named operating point within the million-neuron contract.
Parameters
namestr- required. Name of the optional shard array or declared record.
support_model_idstr- required.
support_token_widthint- required.
support_state_widthint- required.
support_block_rowsint- required.
support_block_tokenint- required.
support_block_stateint- required.
external_block_widthint- required.
project_block_widthint- required.
compiled_adaptation_values_per_neuronint- required.
morphology_adapter_values_per_classint- required.
synaptic_efficacy_values_per_neuronint- required.
output_export_fractionfloat- required.
primary_metricstr- required.
minimum_neuron_steps_per_secondfloat- required.
measured_median_neuron_steps_per_secondfloat- required.
measured_p90_neuron_steps_per_secondfloat- required.
measured_voltage_sera_mv2float- required.
measured_voltage_root_sera_mvfloat- required.
measured_spike_mean_f1float- required.
measured_population_firing_rate_hzfloat- required.
population_adaptation_initializationstr- required.
population_adaptation_individually_fittedbool- required.
individual_behavior_adaptation_supportedbool- required.
individual_synaptic_adaptation_supportedbool- required.
Attributes
Constructor fields are retained as read-only attributes.
MILLION_NEURON_REALTIME_CONTRACT
axosim.simulation_contract.MILLION_NEURON_REALTIME_CONTRACT: LargePopulationSimulationContract
Named workload contract for the connected population benchmark. Its attributes specify the population, cadence, contact topology, precision, and timing boundary.
AXOSIM_POPULATION_PROFILE
axosim.simulation_contract.AXOSIM_POPULATION_PROFILE: PopulationInferenceProfile
Named compact population deployment recipe, including its behavior storage and model dimensions.