Method __init__

masfactory/components/graphs/loop.py:34–313

Create a Loop. Args: name: Loop name. max_iterations: Maximum iterations before forced termination. model: Optional model used by controller termination prompt. terminate_condition_prompt: Optional natural-language terminate condition.

(self,
            name:str,
            max_iterations:int=10,
            model:Model|None=None,
            terminate_condition_prompt:str|None=None,
            terminate_condition_function:Callable|None=None,
            pull_keys:dict[str,dict|str]|None=None,
            push_keys:dict[str,dict|str]|None=None,
            attributes:dict[str,object] | None = None,
            initial_messages:dict[str,object] | None = None,
            edges: list[tuple[str, str] | tuple[str, str, dict[str, dict|str] ]]|None=None,
            nodes:list[tuple]|None=None,    
            build_func:Callable|None = None,
            )

    internal nodes should feed back by `edge_to_controller`, not by direct inner cycles.
    """
    def __init__(self,
            name:str,
            max_iterations:int=10,
            model:Model|None=None,
            terminate_condition_prompt:str|None=None,
            terminate_condition_function:Callable|None=None,
            pull_keys:dict[str,dict|str]|None=None,
            push_keys:dict[str,dict|str]|None=None,
            attributes:dict[str,object] | None = None,
            initial_messages:dict[str,object] | None = None,
            edges: list[tuple[str, str] | tuple[str, str, dict[str, dict|str] ]]|None=None,
            nodes:list[tuple]|None=None,    
            build_func:Callable|None = None,
            ):
        """Create a Loop.

        Args:
            name: Loop name.
            max_iterations: Maximum iterations before forced termination.
            model: Optional model used by controller termination prompt.
            terminate_condition_prompt: Optional natural-language terminate condition.
            terminate_condition_function: Optional callable terminate condition. Supported signatures are:
                - `(input) -> terminate`
                - `(input, attributes) -> terminate`
                - `(input, attributes, controller) -> terminate`
                - `(input, attributes, controller, memories) -> terminate`
                - `(input, attributes, controller, memories, tools) -> terminate`
                - `(input, attributes, controller, memories, tools, retrievers) -> terminate`

                Where:
                - `input`: `dict[str, object]`
                - `attributes`: `dict[str, object]` (loop-local attribute store)
                - `controller`: internal controller node instance
                - `memories`: list of memories attached to the controller (may be empty)
                - `tools`: list of tools attached to the controller (may be empty)
                - `retrievers`: list of retrievers attached to the controller (may be empty)
                - `terminate`: `bool`
            pull_keys: Keys pulled from outer attributes.
            push_keys: Keys pushed to outer attributes.
            attributes: Initial loop attributes.
            initial_messages: Initial cached controller messages.
            edges: Optional declarative edge definitions for inner nodes.
            nodes: Optional declarative node definitions for inner nodes as `(name, NodeTemplate)` entries.
            build_func: Optional custom build function.
        """
        self._init_nodes = nodes
        self._init_edges = edges
        attributes = {} if attributes is None else dict(attributes)
        # Copy to avoid sharing mutable defaults and to avoid mutating caller-provided dicts.
        initial_messages = {} if initial_messages is None else dict(initial_messages)
        initial_messages_template = initial_messages.copy()

        # By default, expose loop iteration counters to the outer environment.
        if push_keys is None:
            push_keys = {
                'current_iteration': 'Current iteration of the loop.',
                'max_iterations': 'Maximum iterations of the loop.',
            }