framework.modular_state_objects

class ignite_framework.framework.modular_state_objects.StateBooleanConfigurationVariable(initial_value='', instance_attr__get__='', instance_attr__set__='')

Type selective configuration variable of type bool.

class ignite_framework.framework.modular_state_objects.StateBooleanVariable(initial_value='', instance_attr__get__='', instance_attr__set__='')

Type selective state variable of type bool.

class ignite_framework.framework.modular_state_objects.StateConfigurationVariable(initial_value='', instance_attr__get__='', instance_attr__set__='')

Configuration parameter with the features of a StateVariable, e.g. for state.configs.debug_mode=True/False.

Note: In contrast to the StateParameter the StateConfigurationVariable ist not referenced in state.params Normally used for configuration values that change value throughout a state run or/and also require callbacks, e.g. stat.config.debug/run_mode, state.configs.device, …

class ignite_framework.framework.modular_state_objects.StateConstant(initial_value='', instance_attr__get__='', instance_attr__set__='')

StateConstant is the basic state constant without any additional type checking which is obivious not required for a constant.

class ignite_framework.framework.modular_state_objects.StateDevice(initial_value='', instance_attr__get__='', instance_attr__set__='')

StateDevice is the device parameter defining the device the processes of the state object container should run on.

class ignite_framework.framework.modular_state_objects.StateFunction(initial_value='', instance_attr__get__='', instance_attr__set__='')

StateFunction is the a state object with as function or method as value.

Features:

• same as StateObject
• set-value types restricted to CALLABLE_TYPES

class ignite_framework.framework.modular_state_objects.StateIntCounter(initial_value='', instance_attr__get__='', instance_attr__set__='')

Type and value selective state variable only allowing type int and increasing values.

class ignite_framework.framework.modular_state_objects.StateIterationCounter(initial_value='', instance_attr__get__='', instance_attr__set__='')

Iteration counter is a state variable, only allowing ‘’int’’ with increasing values by step size ‘+`1`.

class ignite_framework.framework.modular_state_objects.StateObject(initial_value='', instance_attr__get__='', instance_attr__set__='')

StateObject is a data-descriptor that stores any value in state.

Features:

” overloaded suffix: _ref ” state shortcut auto-generation

class ignite_framework.framework.modular_state_objects.StateParameter(initial_value='', instance_attr__get__='', instance_attr__set__='')

StateParameter is the basic state parameter without any additional type checking or setting conditions. StateParameters of any kind should be made available in state.params for e.g. hyper-parameter optimization or Tensorboard tracking.

Features:

• same as StateVariable
• state.params reference auto-generation as state.params.<bso_ctr_name>_<parameter_name>

class ignite_framework.framework.modular_state_objects.StateVariable(initial_value='', instance_attr__get__='', instance_attr__set__='')

StateVariable is the basic state variable without any additional type checking or setting conditions.

Features:

• gets/sets/calls a _value and gets/sets/calls a list of callbacks which are callables triggered when _value is set

• overloaded suffixes: [‘_callbacks’, _ref’, ‘_every’, ‘_once’]

  • _ref: returns StateObjectsReference-instance of itself
  • _callbacks: returns list of callbacks (functions called when value is set)

• set-value type dependent __set__() overload:

  • CALLABLE_TYPES & tuple`([<CALLABLE_TYPES>, <dict>]): appended to its `_callbacks-list
  • any other type: sets its _value

• state shortcut auto-generation