GeNN  4.9.0
GPU enhanced Neuronal Networks (GeNN)
pygenn.genn_groups.CustomUpdate Class Reference

Class representing a custom update. More...

Inheritance diagram for pygenn.genn_groups.CustomUpdate:
pygenn.genn_groups.Group

Public Member Functions

def __init__ (self, name, model)
 Init CustomUpdate. More...
 
def set_custom_update_model (self, model, param_space, var_space, var_ref_space, egp_ref_space)
 Set custom update model, its parameters, initial variables and variable referneces. More...
 
def add_to (self, group_name)
 Attach this CurrentSource to NeuronGroup and add it to the pygenn.genn_model.GeNNModel. More...
 
def load (self)
 
def load_init_egps (self)
 
def unload (self)
 
def reinitialise (self)
 Reinitialise custom update. More...
 
- Public Member Functions inherited from pygenn.genn_groups.Group
def __init__ (self, name, model)
 Init Group. More...
 
def set_var (self, var_name, values)
 Set values for a Variable. More...
 
def add_extra_global_param (self, param_name, param_values)
 Set extra global parameter. More...
 
def set_extra_global_param (self, param_name, param_values)
 Set extra global parameter. More...
 
def pull_state_from_device (self)
 Wrapper around GeNNModel.pull_state_from_device. More...
 
def pull_var_from_device (self, var_name)
 Wrapper around GeNNModel.pull_var_from_device. More...
 
def pull_extra_global_param_from_device (self, egp_name, size=None)
 Wrapper around GeNNModel.pull_extra_global_param_from_device. More...
 
def push_state_to_device (self)
 Wrapper around GeNNModel.push_state_to_device. More...
 
def push_var_to_device (self, var_name)
 Wrapper around GeNNModel.push_var_to_device. More...
 
def push_extra_global_param_to_device (self, egp_name, size=None)
 Wrapper around GeNNModel.push_extra_global_param_to_device. More...
 

Public Attributes

 custom_update_model
 
 var_refs
 
 egp_refs
 
 custom_wu_update
 
 var_ref_names
 
 egp_ref_names
 
 pop
 
- Public Attributes inherited from pygenn.genn_groups.Group
 name
 
 vars
 
 extra_global_params
 

Detailed Description

Class representing a custom update.

Constructor & Destructor Documentation

◆ __init__()

def pygenn.genn_groups.CustomUpdate.__init__ (   self,
  name,
  model 
)

Init CustomUpdate.

Parameters
namestring name of the custom update
modelpygenn.genn_model.GeNNModel this custom update is part of

Member Function Documentation

◆ add_to()

def pygenn.genn_groups.CustomUpdate.add_to (   self,
  group_name 
)

Attach this CurrentSource to NeuronGroup and add it to the pygenn.genn_model.GeNNModel.

Parameters
group_namename of update group this update should be performed in

◆ load()

def pygenn.genn_groups.CustomUpdate.load (   self)

◆ load_init_egps()

def pygenn.genn_groups.CustomUpdate.load_init_egps (   self)

◆ reinitialise()

def pygenn.genn_groups.CustomUpdate.reinitialise (   self)

Reinitialise custom update.

◆ set_custom_update_model()

def pygenn.genn_groups.CustomUpdate.set_custom_update_model (   self,
  model,
  param_space,
  var_space,
  var_ref_space,
  egp_ref_space 
)

Set custom update model, its parameters, initial variables and variable referneces.

Parameters
modeltype as string or instance of the model
param_spacedict with model parameters
var_spacedict with model variables
var_ref_spacedict with model variable references
egp_ref_spacedict with model extra global parameter references

◆ unload()

def pygenn.genn_groups.CustomUpdate.unload (   self)

Member Data Documentation

◆ custom_update_model

pygenn.genn_groups.CustomUpdate.custom_update_model

◆ custom_wu_update

pygenn.genn_groups.CustomUpdate.custom_wu_update

◆ egp_ref_names

pygenn.genn_groups.CustomUpdate.egp_ref_names

◆ egp_refs

pygenn.genn_groups.CustomUpdate.egp_refs

◆ pop

pygenn.genn_groups.CustomUpdate.pop

◆ var_ref_names

pygenn.genn_groups.CustomUpdate.var_ref_names

◆ var_refs

pygenn.genn_groups.CustomUpdate.var_refs

The documentation for this class was generated from the following file: