# tf.compat.v1.flags.DEFINE_bool

<br />

Registers a boolean flag.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.flags.DEFINE_boolean`](https://www.tensorflow.org/api_docs/python/tf/compat/v1/flags/DEFINE_bool)

<br />

    tf.compat.v1.flags.DEFINE_bool(
        name,
        default,
        help,
        flag_values=_flagvalues.FLAGS,
        module_name=None,
        required=False,
        **args
    )

Such a boolean flag does not take an argument. If a user wants to
specify a false value explicitly, the long option beginning with 'no'
must be used: i.e. --noflag

This flag will have a value of None, True or False. None is possible
if default=None and the user does not specify the flag on the command
line.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `name` | str, the flag name. |
| `default` | bool\|str\|None, the default value of the flag. |
| `help` | str, the help message. |
| `flag_values` | :class:`FlagValues`, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden. |
| `module_name` | str, the name of the Python module declaring this flag. If not provided, it will be computed using the stack trace of this call. |
| `required` | bool, is this a required flag. This must be used as a keyword argument. |
| `**args` | dict, the extra keyword args that are passed to `Flag.__init__`. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| a handle to defined flag. ||

<br />