States

Default state

The default state is the minimum setup of state required for the basic framework to run.

State Plugins

The default state can be customized by the user with plugins.

Default Configs

The default configs are assigned to state.configs.default_configs.

class ignite_framework.states.state_plugins.default_configs.DefaultConfigurations(name)

add_new_bso(name, value)

add_new_state_function(func)

debug_mode

Type selective configuration variable of type bool.

device

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

device_for_dataloaders

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

device_for_metrics

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

device_for_modules

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

get(*name_or_parts)

Get method for parameterized attribute names, especially for state object containers, but not only.

Main reason is to simply avoid unhandy commands, e.g. getattr(state.transitions, ‘{}_{}’.format(name, suffix) commands and simply write state.transitions.get(name, suffix).

get_bso_names()

name = 'DefaultConfigurations'

set(*name_or_parts_and_value)

tensorboard_log_dir

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

Features:

” overloaded suffix: _ref ” state shortcut auto-generation

Constants

The constants are assigned to state.params.constants.

class ignite_framework.states.state_plugins.constants.Constants(name)

Container wither constant parameters with wherease the user can add user-defined constants.

add_new_bso(name, value)

add_new_state_function(func)

false

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

get(*name_or_parts)

Get method for parameterized attribute names, especially for state object containers, but not only.

Main reason is to simply avoid unhandy commands, e.g. getattr(state.transitions, ‘{}_{}’.format(name, suffix) commands and simply write state.transitions.get(name, suffix).

get_bso_names()

name = 'Constants'

none

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

set(*name_or_parts_and_value)

true

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

Data Flow Graph Analysis

The data flow tools` are assigned to ``state.maintenance.dataflow.

class ignite_framework.states.state_plugins.dataflow.DataFlow(name)

The state data flow graph analysis plugin is assigned to the default ignite_framework.states.state as state.maintenance.dataflow.

All analysis functions are shortcutted, e.g. state.get_all_paths_in_state().

add_new_bso(name, value)

add_new_state_function(func)

get(*name_or_parts)

Get method for parameterized attribute names, especially for state object containers, but not only.

Main reason is to simply avoid unhandy commands, e.g. getattr(state.transitions, ‘{}_{}’.format(name, suffix) commands and simply write state.transitions.get(name, suffix).

get_bso_ctr_instances_in_paths

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

Features:

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

get_bso_ctr_names_in_paths_formatted_as_graph

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

Features:

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

get_bso_ctr_names_of_type_in_paths

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

Features:

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

get_bso_ctr_names_of_type_in_paths_including_bso_ctr

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

Features:

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

get_bso_ctr_types_in_paths

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

Features:

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

get_bso_ctr_types_in_preceding_paths

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

Features:

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

get_bso_names()

get_engine_names_in_paths

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

Features:

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

get_engine_names_in_paths_including_bso_ctr

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

Features:

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

get_engine_names_in_state

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

Features:

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

get_graphs_in_state

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

Features:

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

get_graphs_including_bso_ctr

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

Features:

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

get_metric_names_in_paths

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

Features:

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

get_metric_names_in_paths_including_bso_ctr

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

Features:

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

get_metric_names_of_engine

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

Features:

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

get_paths_in_graph

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

Features:

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

get_paths_in_state

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

Features:

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

get_paths_in_state_formatted_as_graphs

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

Features:

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

get_paths_including_bso_ctr

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

Features:

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

get_preceding_paths_of_bso_ctr

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

Features:

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

get_predecessors_of_bso_ctr

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

Features:

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

get_successive_graph_of_bso_ctr

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

Features:

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

get_successive_paths_of_bso_ctr

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

Features:

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

get_successors_of_bso_ctr

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

Features:

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

name = 'DataFlow'

set(*name_or_parts_and_value)

State Timer

class ignite_framework.states.state_plugins.state_timer.StateTimer(name='state_timer')

get(*name_or_parts)

Get method for parameterized attribute names, especially for state object containers, but not only.

Main reason is to simply avoid unhandy commands, e.g. getattr(state.transitions, ‘{}_{}’.format(name, suffix) commands and simply write state.transitions.get(name, suffix).

get_bso_names()

name = 'StateTimer'

set(*name_or_parts_and_value)

start_timer(timer_name)

state_init_completed_time_in_h

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

state_init_completed_time_in_min

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

state_init_completed_time_in_sec

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

state_init_started_time_in_h

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

state_init_started_time_in_min

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

state_init_started_time_in_sec

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

state_run_completed_time_in_h

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

state_run_completed_time_in_min

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

state_run_completed_time_in_sec

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

state_run_started_time_in_h

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

state_run_started_time_in_min

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

state_run_started_time_in_sec

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