definition_helpers module

Full Documentation for hippynn.graphs.nodes.base.definition_helpers module. Click here for a summary page.

Tools for organizing node definitions.

Usage of these tools is optional; they support node definitions but are not required.

Note

The functions in this module are intended purely for defining new types of nodes. They are not strictly necessary; they only aid in defining more complex node behavior in a simple fashion.

exception TupleTypeMismatch

Bases: Exception

class AlwaysMatch

Bases: object

class AutoKw(*args, module='auto', module_kwargs=None, **kwargs)

Bases: object

Helper class for piping keyword arguments into an nn.module class.

Keyword Argument sources (lower precedence first):

• module_kwargs argument to init.

• kwarg-source pairs from self.auto_module_kwargs, where the value for the source is popped from the kwargs to the node.

• self.module_kwargs.

Note: If self.auto_module_kwargs is not a dict, it will then be interpreted

as a list of keys for a dictionary with the identity for key-value mapping.

After constructing the kwargs, they are saved as self.module_kwargs.

auto_module_kwargs: Tuple[str] | Dict[str, str] | None = None

class AutoNoKw(*args, module='auto', **kwargs)

Bases: object

class CompatibleIdxTypeTransformer(form)

Bases: FormTransformer

static fn(node_self, *parents, **kwargs)

Enforces that all parents have compatible index states.

add_class_doc()

class ExpandParentMeta

Bases: type

parent_expander: ParentExpander

class ExpandParents(name, parents, *args, **kwargs)

Bases: object

Keyword Argument sources (lower precedence first):

• expansion_kwargs argument to init.

• kwarg-source pairs from self.parent_expansion_kwargs, where the value for the source is popped from the kwargs to the node.

• self.module_kwargs.

If self.parent_expansion_kwargs is not a dictionary it will be interpreted as

a list of keys for an identity key-value mapping.

expand_parents(parents, *, purpose=None, **kwargs)

parent_expander: ParentExpander = <hippynn.graphs.nodes.base.definition_helpers.ParentExpander object>

parent_expansion_kwargs: Tuple[str] | Dict[str, str] | None = None

class FormAssertLength(length)

Bases: FormAssertion

add_class_doc()

class FormAssertion(form)

Bases: FormHandler

add_class_doc()

class FormHandler

Bases: object

add_class_doc()

class FormTransformer(form, fn)

Bases: FormHandler

add_class_doc()

class IndexFormTransformer(form, idxstates)

Bases: FormTransformer

add_class_doc()

fn(node_self, *parents, **kwargs)

Coerces index states for all parents

class MainOutputTransformer(form)

Bases: FormTransformer

static fn(node_self, *parents, **kwargs)

Gets main_output of nodes: casts multinodes to single nodes

add_class_doc()

class ParentExpander

Bases: object

Manager object to register and implement optional steps in building a graph node.

assertion(*form)

Assert that the parents match a given form.

Parameters:

form

Returns:

assertlen(length)

Assert that there are a given number of parents.

Parameters:

length

Returns:

Note

It is recommended only to use this function once as the final stage of expanding a node’s parents, to ensure that a node can be constructed directly from a satisfactory set of parents that doesn’t require any expansion.

get_main_outputs()

Return the main outputs for any multinodes in the parents.

Returns:

match(*form)

Decorator: the applied function will be a generic FormTransformer

matched_idx_coercion(form, needed_index_states)

Apply coercion to the needed index states if the given form is present. :param form: :param needed_index_states: :return:

matchlen(length)

Decorator: The decorated function will be applied if the number of parents matches the given length. :param length: :return:

require_compatible_idx_states()

Ensure that all parents have commensurate index states. :return:

require_idx_states(*needed_index_states)

Always coerce the nodes into a needed index state.

Parameters:

needed_index_states

Returns:

Note

It is recommended only to use this function once as the final stage of expanding a node’s parents, to ensure that a node can be constructed directly from a satisfactory set of parents that doesn’t require any expansion.

adds_to_forms(fn)

format_form_name(form)

temporary_parents(child, parents)

Context manager for temporarily connecting a node to a set of parents. This is used during parent expansion so that find_relatives and find_unique_relatives can treat the nodes as connected even though they are not fully formed.

Parameters:

• child

• parents

Returns:

None