ngclearn.components package

Subpackages

• ngclearn.components.input_encoders package
  • Submodules
  • ngclearn.components.input_encoders.bernoulliCell module
    • BernoulliCell
      • BernoulliCell.advance_state()
      • BernoulliCell.inputCompartment
      • BernoulliCell.inputCompartmentName()
      • BernoulliCell.outputCompartment
      • BernoulliCell.outputCompartmentName()
      • BernoulliCell.reset()
      • BernoulliCell.save()
      • BernoulliCell.timeOfLastSpike
      • BernoulliCell.timeOfLastSpikeCompartmentName()
      • BernoulliCell.verify_connections()
    • sample_bernoulli()
    • update_times()
  • ngclearn.components.input_encoders.latencyCell module
    • LatencyCell
      • LatencyCell.advance_state()
      • LatencyCell.inputCompartment
      • LatencyCell.inputCompartmentName()
      • LatencyCell.outputCompartment
      • LatencyCell.outputCompartmentName()
      • LatencyCell.reset()
      • LatencyCell.save()
      • LatencyCell.timeOfLastSpike
      • LatencyCell.timeOfLastSpikeCompartmentName()
      • LatencyCell.verify_connections()
    • calc_spike_times_linear()
    • calc_spike_times_nonlinear()
    • extract_spike()
    • update_times()
  • ngclearn.components.input_encoders.poissonCell module
    • PoissonCell
      • PoissonCell.advance_state()
      • PoissonCell.inputCompartment
      • PoissonCell.inputCompartmentName()
      • PoissonCell.outputCompartment
      • PoissonCell.outputCompartmentName()
      • PoissonCell.reset()
      • PoissonCell.save()
      • PoissonCell.timeOfLastSpike
      • PoissonCell.timeOfLastSpikeCompartmentName()
      • PoissonCell.verify_connections()
    • sample_poisson()
    • update_times()
  • Module contents
• ngclearn.components.neurons package
  • Subpackages
    • ngclearn.components.neurons.graded package
      • Submodules
      • ngclearn.components.neurons.graded.gaussianErrorCell module
      • ngclearn.components.neurons.graded.laplacianErrorCell module
      • ngclearn.components.neurons.graded.rateCell module
      • Module contents
    • ngclearn.components.neurons.spiking package
      • Submodules
      • ngclearn.components.neurons.spiking.LIFCell module
      • ngclearn.components.neurons.spiking.fitzhughNagumoCell module
      • ngclearn.components.neurons.spiking.izhikevichCell module
      • ngclearn.components.neurons.spiking.quadLIFCell module
      • ngclearn.components.neurons.spiking.sLIFCell module
      • Module contents
  • Module contents
• ngclearn.components.other package
  • Submodules
  • ngclearn.components.other.expKernel module
    • ExpKernel
      • ExpKernel.advance_state()
      • ExpKernel.epsp
      • ExpKernel.inputCompartment
      • ExpKernel.inputCompartmentName()
      • ExpKernel.outputCompartmentName()
      • ExpKernel.reset()
      • ExpKernel.save()
      • ExpKernel.verify_connections()
    • apply_kernel()
  • ngclearn.components.other.varTrace module
    • VarTrace
      • VarTrace.advance_state()
      • VarTrace.inputCompartment
      • VarTrace.inputCompartmentName()
      • VarTrace.outputCompartmentName()
      • VarTrace.reset()
      • VarTrace.save()
      • VarTrace.trace
      • VarTrace.traceName()
      • VarTrace.verify_connections()
    • run_varfilter()
  • Module contents
• ngclearn.components.synapses package
  • Subpackages
    • ngclearn.components.synapses.hebbian package
      • Submodules
      • ngclearn.components.synapses.hebbian.expSTDPSynapse module
      • ngclearn.components.synapses.hebbian.hebbianSynapse module
      • ngclearn.components.synapses.hebbian.traceSTDPSynapse module
      • Module contents
  • Module contents

Submodules

ngclearn.components.baseComponentTemplate module

class ngclearn.components.baseComponentTemplate.COMPONENT_TEMPLATE(name, key=None, useVerboseDict=False, **kwargs)

Bases: Component

property DEFAULTCompartment

classmethod DEFAULTCompartmentName()

advance_state(**kwargs)

An abstract method to advance the state of the component to the next one (a component transitions from its current state at time t to a new one at time t + dt)

reset(**kwargs)

An abstract method that should be implemented to models can be returned to their original state.

save(directory, **kwargs)

An abstract method to save component specific state to the provided directory

Parameters:

directory – the directory to save the state to

verify_connections()

An abstract method that generally uses component metadata to verify that there are the correct number of connections. This should error if it fails the verification.

ngclearn.components.wrappers module

ngclearn.components.wrappers.LIFWrapper(name, n_units, tau_m, R_m)

ngclearn.components.wrappers.sLIFWrapper(name, n_units, tau_m, R_m)

Module contents