tf.compat.v1.flags.FlagHolder
Stay organized with collections
Save and categorize content based on your preferences.
Holds a defined flag.
tf.compat.v1.flags.FlagHolder(
flag_values, flag, ensure_non_none_value=False
)
This facilitates a cleaner api around global state. Instead of
flags.DEFINE_integer('foo', ...)
flags.DEFINE_integer('bar', ...)
...
def method():
# prints parsed value of 'bar' flag
print(flags.FLAGS.foo)
# runtime error due to typo or possibly bad coding style.
print(flags.FLAGS.baz)
it encourages code like
FOO_FLAG = flags.DEFINE_integer('foo', ...)
BAR_FLAG = flags.DEFINE_integer('bar', ...)
...
def method():
print(FOO_FLAG.value)
print(BAR_FLAG.value)
since the name of the flag appears only once in the source code.
Args |
|---|
flag_values
|
The container the flag is registered to.
|
flag
|
The flag object for this flag.
|
ensure_non_none_value
|
Is the value of the flag allowed to be None.
|
Attributes |
|---|
default
|
Returns the default value of the flag.
|
name
|
|
value
|
Returns the value of the flag.
If _ensure_non_none_value is True, then return value is not None.
|
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.FlagHolder\n\n\u003cbr /\u003e\n\nHolds a defined 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.FlagHolder`](/api_docs/python/tf/compat/v1/flags/FlagHolder)\n\n\u003cbr /\u003e\n\n tf.compat.v1.flags.FlagHolder(\n flag_values, flag, ensure_non_none_value=False\n )\n\nThis facilitates a cleaner api around global state. Instead of \n\n flags.DEFINE_integer('foo', ...)\n flags.DEFINE_integer('bar', ...)\n ...\n def method():\n # prints parsed value of 'bar' flag\n print(flags.FLAGS.foo)\n # runtime error due to typo or possibly bad coding style.\n print(flags.FLAGS.baz)\n\nit encourages code like \n\n FOO_FLAG = flags.DEFINE_integer('foo', ...)\n BAR_FLAG = flags.DEFINE_integer('bar', ...)\n ...\n def method():\n print(FOO_FLAG.value)\n print(BAR_FLAG.value)\n\nsince the name of the flag appears only once in the source code.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|-------------------------|----------------------------------------------|\n| `flag_values` | The container the flag is registered to. |\n| `flag` | The flag object for this flag. |\n| `ensure_non_none_value` | Is the value of the flag allowed to be None. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Attributes ---------- ||\n|-----------|---------------------------------------------------------------------------------------------------------|\n| `default` | Returns the default value of the flag. |\n| `name` | \u003cbr /\u003e \u003cbr /\u003e |\n| `value` | Returns the value of the flag. \u003cbr /\u003e If _ensure_non_none_value is True, then return value is not None. |\n\n\u003cbr /\u003e"]]
