tf.compat.v1.flags.DEFINE_bool
Stay organized with collections
Save and categorize content based on your preferences.
Registers a boolean flag.
tf.compat.v1.flags.DEFINE_bool(
name, default, help, flag_values=_flagvalues.FLAGS, module_name=None, **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.
Args |
|---|
name
|
str, the flag name.
|
default
|
bool|str|None, the default value of the flag.
|
help
|
str, the help message.
|
flag_values
|
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.
|
**args
|
dict, the extra keyword args that are passed to Flag init.
|
Returns |
|---|
|
a handle to defined flag.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.compat.v1.flags.DEFINE_bool\n\n\u003cbr /\u003e\n\nRegisters a boolean flag.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.app.flags.DEFINE_bool`](/api_docs/python/tf/compat/v1/flags/DEFINE_bool), [`tf.compat.v1.app.flags.DEFINE_boolean`](/api_docs/python/tf/compat/v1/flags/DEFINE_bool), [`tf.compat.v1.flags.DEFINE_boolean`](/api_docs/python/tf/compat/v1/flags/DEFINE_bool)\n\n\u003cbr /\u003e\n\n tf.compat.v1.flags.DEFINE_bool(\n name, default, help, flag_values=_flagvalues.FLAGS, module_name=None, **args\n )\n\nSuch a boolean flag does not take an argument. If a user wants to\nspecify a false value explicitly, the long option beginning with 'no'\nmust be used: i.e. --noflag\n\nThis flag will have a value of None, True or False. None is possible\nif default=None and the user does not specify the flag on the command\nline.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `name` | str, the flag name. |\n| `default` | bool\\|str\\|None, the default value of the flag. |\n| `help` | str, the help message. |\n| `flag_values` | FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden. |\n| `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. |\n| `**args` | dict, the extra keyword args that are passed to Flag **init**. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| a handle to defined flag. ||\n\n\u003cbr /\u003e"]]
