samna.xyloAudio3.event

Submodules

Module content

class samna.xyloAudio3.event.AfeSample

Bases: pybind11_object

The response event of AfeSample event.

property data

The AfeSample event value.

from_json(self: samna.xyloAudio3.event.AfeSample, arg0: str) → None

to_json(self: samna.xyloAudio3.event.AfeSample) → str

class samna.xyloAudio3.event.DirectOutputValue

Bases: pybind11_object

The response event of ReadDirectOutputValue

from_json(self: samna.xyloAudio3.event.DirectOutputValue, arg0: str) → None

property timestep

Timestep at which this event was generated.

to_json(self: samna.xyloAudio3.event.DirectOutputValue) → str

property value

State of direct output pins as 3-bits value.

In Direct Output Mode the value informs which output neurons fire: 0: default state (none of ON0 ~ ON6 fires) 1: at least ON0 fired 2: ON0 did not fire, at least ON1 fired 3: ON0 ~ ON1 did not fire, at least ON2 fired 4: ON0 ~ ON2 did not fire, at least ON3 fired 5: ON0 ~ ON3 did not fire, at least ON4 fired 6: ON0 ~ ON4 did not fire, at least ON5 fired 7: ON0 ~ ON5 did not fire, at least ON6 fired

class samna.xyloAudio3.event.HiddenSpikeCount

Bases: pybind11_object

The response event of ReadHiddenSpike.

property count

Generated / aliased spike count of this hidden neuron.

from_json(self: samna.xyloAudio3.event.HiddenSpikeCount, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0.

to_json(self: samna.xyloAudio3.event.HiddenSpikeCount) → str

class samna.xyloAudio3.event.HiddenSynapticCurrent2

Bases: pybind11_object

The response event of ReadHiddenSynapticCurrent2.

from_json(self: samna.xyloAudio3.event.HiddenSynapticCurrent2, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0.

to_json(self: samna.xyloAudio3.event.HiddenSynapticCurrent2) → str

property value

The second synaptic current of this neuron.

class samna.xyloAudio3.event.MembranePotential

Bases: pybind11_object

The response event of ReadMembranePotential.

from_json(self: samna.xyloAudio3.event.MembranePotential, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0.

to_json(self: samna.xyloAudio3.event.MembranePotential) → str

property value

The membrane potential of this neuron.

class samna.xyloAudio3.event.MemoryValue

Bases: pybind11_object

The response event of ReadMemoryValue.

property address

The reading memory address which equals to the address in corresponding ReadMemoryValue.

property data

The memory value that we read.

from_json(self: samna.xyloAudio3.event.MemoryValue, arg0: str) → None

to_json(self: samna.xyloAudio3.event.MemoryValue) → str

class samna.xyloAudio3.event.ReadDirectOutputValue

Bases: pybind11_object

Read state of direct output pins OUT0-2.

class samna.xyloAudio3.event.ReadHiddenSpikeCount

Bases: pybind11_object

Read spike count of a hidden neuron.

from_json(self: samna.xyloAudio3.event.ReadHiddenSpikeCount, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0.

to_json(self: samna.xyloAudio3.event.ReadHiddenSpikeCount) → str

class samna.xyloAudio3.event.ReadHiddenSynapticCurrent2

Bases: pybind11_object

Read second synaptic current of a hidden neuron neuron.

from_json(self: samna.xyloAudio3.event.ReadHiddenSynapticCurrent2, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0.

to_json(self: samna.xyloAudio3.event.ReadHiddenSynapticCurrent2) → str

class samna.xyloAudio3.event.ReadMembranePotential

Bases: pybind11_object

Read membrane potential of a hidden neuron or output neuron

from_json(self: samna.xyloAudio3.event.ReadMembranePotential, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0. Output neurons locate right after hidden neurons.

to_json(self: samna.xyloAudio3.event.ReadMembranePotential) → str

class samna.xyloAudio3.event.ReadMemoryValue

Bases: pybind11_object

Read memory value from XyloAudio3.

property address

The memory address to read from.

from_json(self: samna.xyloAudio3.event.ReadMemoryValue, arg0: str) → None

to_json(self: samna.xyloAudio3.event.ReadMemoryValue) → str

class samna.xyloAudio3.event.ReadRegisterValue

Bases: pybind11_object

Read register value of XyloAudio3.

property address

The register address to read from.

from_json(self: samna.xyloAudio3.event.ReadRegisterValue, arg0: str) → None

to_json(self: samna.xyloAudio3.event.ReadRegisterValue) → str

class samna.xyloAudio3.event.ReadSynapticCurrent

Bases: pybind11_object

Read synaptic current of a hidden neuron or output neuron

from_json(self: samna.xyloAudio3.event.ReadSynapticCurrent, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0. Output neurons locate right after hidden neurons.

to_json(self: samna.xyloAudio3.event.ReadSynapticCurrent) → str

class samna.xyloAudio3.event.ReadVersion

Bases: pybind11_object

Read the fixed version of Xylo-Audio3.

class samna.xyloAudio3.event.Readout

Bases: pybind11_object

State of all neurons in the network after processing a timestep.

This event is automatically sent after processing a timestep in Real-Time and Accelerated-Time. It can also be requested explicitly with a samna.xyloAudio3.event.TriggerReadout event. The exact neurons which states are available in this event is influenced by the configuration.

from_json(self: samna.xyloAudio3.event.Readout, arg0: str) → None

property hidden_spikes

Spike count values of monitored hidden neurons,

This is only available in Accelerated-Time mode and for neurons configured by samna.xyloAudio3.configuration.DebugConfig.monitor_neuron_spike.

property input_spikes

Spike count for all input neurons.

This is only available when samna.xyloAudio3.configuration.DebugConfig.monitor_input_neurons_enable is enabled. Note: these are the spikes received in the current timestep, to be processed in the next.

property neuron_i_syns

Synaptic current values of monitored hidden neurons and output neurons,

This is only available in Accelerated-Time mode and for neurons configured by samna.xyloAudio3.configuration.DebugConfig.monitor_neuron_i_syn.

property neuron_v_mems

Membrane potential values of monitored hidden neurons and output neurons,

This is only available in Accelerated-Time mode and for neurons configured by samna.xyloAudio3.configuration.DebugConfig.monitor_neuron_v_mem.

property output_spikes

Spike count values of all output neurons.

property output_v_mems

Membrane potential values of all output neurons.

property timestep

Timestep that was last processed.

to_json(self: samna.xyloAudio3.event.Readout) → str

class samna.xyloAudio3.event.RegisterValue

Bases: pybind11_object

The response event of ReadRegisterValue event.

property address

The reading address, it equals to the address in corresponding ReadRegisterValue.

property data

The register value that read.

from_json(self: samna.xyloAudio3.event.RegisterValue, arg0: str) → None

to_json(self: samna.xyloAudio3.event.RegisterValue) → str

class samna.xyloAudio3.event.Spike

Bases: pybind11_object

Spikes are events that can be consumed and produced by Xylo-Audio3.

from_json(self: samna.xyloAudio3.event.Spike, arg0: str) → None

property neuron_id

The target neuron id of the spike event.

property timestep

When receiving a Spike event from a chip the timestamp will be populated with the time at which the event leave the chip in microseconds.

When sending a Spike event to a chip the timestamp will be used to control which timestep the event will be applied to the chip.

to_json(self: samna.xyloAudio3.event.Spike) → str

class samna.xyloAudio3.event.SynapticCurrent

Bases: pybind11_object

The response event of ReadSynapticCurrent.

from_json(self: samna.xyloAudio3.event.SynapticCurrent, arg0: str) → None

property neuron_id

Corresponding neuron id, start from 0.

to_json(self: samna.xyloAudio3.event.SynapticCurrent) → str

property value

The synaptic current of this neuron.

class samna.xyloAudio3.event.TriggerProcessing

Bases: pybind11_object

Trigger specific times until target timestep reaches in accelerated mode or realtime mode, and trigger once in manual mode.

from_json(self: samna.xyloAudio3.event.TriggerProcessing, arg0: str) → None

property target_timestep

Target timestep to reach after processing, only available in accelerated mode or realtime mode.

The target timestep itself won’t be processed. e.g. If you set target timestep to 10, then after all processing complete, the result of samna.xyloAudio3.event.TriggerReadout event will give you samna.xyloAudio3.event.Readout event with timestep=9.

If a value smaller than current timestep is set for target timestep, nothing happens.

Default no effect if this value is not set in accelerated mode, default triggering infinitely if this value is not set in realtime mode.

to_json(self: samna.xyloAudio3.event.TriggerProcessing) → str

class samna.xyloAudio3.event.TriggerReadout

Bases: pybind11_object

Request the current network state as a samna.xyloAudio3.event.Readout event.

class samna.xyloAudio3.event.Version

Bases: pybind11_object

The response event of ReadVersion.

from_json(self: samna.xyloAudio3.event.Version, arg0: str) → None

property major

Major part of Xylo version which is fixed at 1.

property minor

Minor part of Xylo version which is fixed at 1.

to_json(self: samna.xyloAudio3.event.Version) → str

class samna.xyloAudio3.event.WriteMemoryValue

Bases: pybind11_object

Write a memory value to XyloAudio3.

property address

The memory address to write to.

property data

The data writing to the address.

from_json(self: samna.xyloAudio3.event.WriteMemoryValue, arg0: str) → None

to_json(self: samna.xyloAudio3.event.WriteMemoryValue) → str

class samna.xyloAudio3.event.WriteRegisterValue

Bases: pybind11_object

Write register value of XyloAudio3.

property address

Target register address.

property data

The new register value to write.

from_json(self: samna.xyloAudio3.event.WriteRegisterValue, arg0: str) → None

to_json(self: samna.xyloAudio3.event.WriteRegisterValue) → str