Function config_for_function

axlearn/common/config.py:1082–1098

Returns an instance of FunctionConfigBase, which invokes `fn` upon instantiation. Example: ``` cfg = config_for_function(pow).set(exp=2) assert cfg.set(base=3).instantiate() == 9 ``` Args: fn: The function to wrap. Returns: A Config that

(fn: Callable[..., T])

def config_for_function(fn: Callable[..., T]) -> Union[Any, FunctionConfigBase[T]]:
    """Returns an instance of FunctionConfigBase, which invokes `fn` upon instantiation.

    Example:
        ```
        cfg = config_for_function(pow).set(exp=2)
        assert cfg.set(base=3).instantiate() == 9
        ```

    Args:
        fn: The function to wrap.

    Returns:
        A Config that when instantiated, invokes `fn` based on any config fields that have been set.
    """
    config_cls = _config_class_for_function(fn)
    return config_cls(fn=fn)


@config_class