Method debug_string

axlearn/common/config.py:588–614

Returns a debug string for the config. Args: kv_separator: The key-value separator. field_separator: The field separator. omit_default_values: A set of default values to omit in debug string. See comments on `to_flat_dict`. Return

(
        self,
        *,
        kv_separator: str = ": ",
        field_separator: str = "\n",
        omit_default_values: Collection[Any] = (None, REQUIRED),
    )

        return attr.evolve(self).set(**kwargs)

    def debug_string(
        self,
        *,
        kv_separator: str = ": ",
        field_separator: str = "\n",
        omit_default_values: Collection[Any] = (None, REQUIRED),
    ) -> str:
        """Returns a debug string for the config.

        Args:
            kv_separator: The key-value separator.
            field_separator: The field separator.
            omit_default_values: A set of default values to omit in debug string.
                See comments on `to_flat_dict`.

        Returns:
            A str separated by `field_separator` where each entry is of form
            f"{path}{kv_separator}{val}", representing path and value of a leaf config field.
        """
        flat_dict = self.to_flat_dict(omit_default_values=omit_default_values)

        def fmt(key: str, val: Any) -> Union[str, tuple[str, str]]:
            if isinstance(val, (type, types.FunctionType)):
                val = f"{val.__module__}.{val.__name__}"
            return f"{key}{kv_separator}{repr(val)}"

        return field_separator.join([fmt(k, v) for k, v in flat_dict.items()])

    def to_flat_dict(self, *, omit_default_values: Collection[Any]) -> dict[str, Any]:
        """Returns a flattened dict with path -> value mappings.