calix.hagen

Modules

calix.hagen.multiplication	Provides a class which handles multiplication of vectors with matrices on the synaptic input line.
calix.hagen.neuron	Calibrate neurons for integrating synaptic inputs, as it is desired using the hagen mode.
calix.hagen.neuron_dataclasses	Dataclasses for hagen neuron calib target and result.
calix.hagen.neuron_evaluation	Functions to print statistics of the neuron membrane potentials per quadrant.
calix.hagen.neuron_helpers	Provides functions for reading neuron membrane potentials and configuring them for integration.
calix.hagen.neuron_leak_bias	Provides functions to set the neurons’ leak OTA bias currents for different purposes.
calix.hagen.neuron_potentials	Provides functions to calibrate leak and reset potential.
calix.hagen.neuron_synin	Provides functions to calibrate the neurons’ synaptic input reference potentials and synaptic input OTA bias currents.
calix.hagen.neuron_synin_coba	Provides calibration classes for conductance-based (COBA) synaptic input parameters.
calix.hagen.synapse_driver	Provides a function to calibrate the synapse drivers for hagen-mode input activation encoding.

Module for calibrating the HICANN-X chips for usage in hagen mode, i.e. for multiply-accumulate operation.

Classes

HagenCalibOptions(cadc_options, …)	Dataclass collecting further options for Hagen-mode calibrations with integration on membranes.
HagenCalibResult(target, options, …)	Data class containing results of cadc, neuron and synapse driver calibration, all what is necessary for operation in hagen mode when using integration on the neurons’ membranes.
HagenCalibTarget(cadc_target, neuron_target)	Dataclass collecting target parameters for Hagen-mode calibrations with integration on membranes.
HagenSyninCalibOptions(cadc_options, …)	Dataclass collecting further options for Hagen-mode calibrations with integration on synaptic input lines.
HagenSyninCalibResult(target, options, …)	Calib results needed for hagen mode integration on the synaptic inputs.
HagenSyninCalibTarget(cadc_target, …)	Dataclass collecting target parameters for Hagen-mode calibrations.

Functions

calix.hagen.calibrate(connection: pyhxcomm_vx.ConnectionHandle, target: Optional[calix.hagen.HagenCalibTarget] = None, options: Optional[calix.hagen.HagenCalibOptions] = None) → calix.hagen.HagenCalibResult

Execute a full calibration for hagen mode: Calibrate CADCs to a suitable dynamic range. Calibrate neurons, calibrate synapse drivers.

The chip has to be initialized first, which can be done using the stadls ExperimentInit().

The individual calibrations’ default parameters can be overwritten by providing the appropriate arguments.

Parameters

• connection – Connection to the chip to calibrate.

• target – Target parameters for calibration, given as an instance of HagenCalibTarget.

• options – Further options for calibration, given as an instance of HagenCalibOptions.

Returns

HagenCalibResult, containing cadc, neuron and synapse driver results.

calix.hagen.calibrate_for_synin_integration(connection: pyhxcomm_vx.ConnectionHandle, target: Optional[calix.hagen.HagenSyninCalibTarget] = None, options: Optional[calix.hagen.HagenSyninCalibOptions] = None) → calix.hagen.HagenSyninCalibResult

Calibrate the chip for integration on synaptic input lines.

Calibrate CADC, synapse drivers, and synapse DAC bias.

Parameters

• connection – Connection to the chip to calibrate.

• target – Calib target parameters.

• options – Further options for calibration.

Returns

Calib result for integration on the synaptic input lines.

calix.hagen.dataclass(cls=None, /, *, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False)

Returns the same class as was passed in, with dunder methods added based on the fields defined in the class.

Examines PEP 526 __annotations__ to determine fields.

If init is true, an __init__() method is added to the class. If repr is true, a __repr__() method is added. If order is true, rich comparison dunder methods are added. If unsafe_hash is true, a __hash__() method function is added. If frozen is true, fields may not be assigned to after instance creation.

calix.hagen.field(*, default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, init=True, repr=True, hash=None, compare=True, metadata=None)

Return an object to identify dataclass fields.

default is the default value of the field. default_factory is a 0-argument function called to initialize a field’s value. If init is True, the field will be a parameter to the class’s __init__() function. If repr is True, the field will be included in the object’s repr(). If hash is True, the field will be included in the object’s hash(). If compare is True, the field will be used in comparison functions. metadata, if specified, must be a mapping which is stored but not otherwise examined by dataclass.

It is an error to specify both default and default_factory.

calix.hagen.warn(message, category=None, stacklevel=1, source=None)

Issue a warning, or maybe ignore it or raise an exception.