Function get_flags

python/paddle/base/framework.py:163–206

This function gets the GFlags value in Paddle. For FLAGS please refer to :ref:`en_guides_flags_flags` Args: flags(list|tuple|str): A list/tuple of string or a string which is the flag's name. Returns: flag's value in Paddle. Examples: .. code-block:: p

(flags: str | Sequence[str])

def get_flags(flags: str | Sequence[str]) -> dict[str, bool | str | float]:
    """
    This function gets the GFlags value in Paddle.
    For FLAGS please refer to :ref:`en_guides_flags_flags`

    Args:
        flags(list|tuple|str): A list/tuple of string or a string which is the flag's name.

    Returns:
        flag's value in Paddle.

    Examples:
        .. code-block:: pycon

            >>> import paddle

            >>> flags = ['FLAGS_eager_delete_tensor_gb', 'FLAGS_check_nan_inf']
            >>> res = paddle.get_flags(flags)
            >>> print(res)
            {'FLAGS_eager_delete_tensor_gb': 0.0, 'FLAGS_check_nan_inf': False}
    """
    flags_value = {}
    if isinstance(flags, (list, tuple)):
        for key in flags:
            if _global_flags().is_public(key):
                value = _global_flags()[key]
                temp = {key: value}
                flags_value.update(temp)
            else:
                raise ValueError(
                    f"Flag {key} cannot get its value through this function."
                )
    elif isinstance(flags, str):
        if _global_flags().is_public(flags):
            value = _global_flags()[flags]
            temp = {flags: value}
            flags_value.update(temp)
        else:
            raise ValueError(
                f"Flag {flags} cannot get its value through this function."
            )
    else:
        raise TypeError("Flags in get_flags should be a list, tuple or string.")
    return flags_value


@contextmanager