tf.compat.v1.flags.declare_key_flag | TensorFlow v2.16.1 (original) (raw)

tf.compat.v1.flags.declare_key_flag

Stay organized with collections Save and categorize content based on your preferences.

Declares one flag as key to the current module.

tf.compat.v1.flags.declare_key_flag(
    flag_name: Union[Text, tf.compat.v1.flags.FlagHolder],
    flag_values: tf.compat.v1.flags.FlagValues = _flagvalues.FLAGS
) -> None

Key flags are flags that are deemed really important for a module. They are important when listing help messages; e.g., if the --helpshort command-line flag is used, then only the key flags of the main module are listed (instead of all flags, as in the case of --helpfull).

Sample usage::

flags.declare_key_flag('flag_1')

Args
flag_name	str \| :class:FlagHolder, the name or holder of an already declared flag. (Redeclaring flags as key, including flags implicitly key because they were declared in this module, is a no-op.) Positional-only parameter.
flag_values	:class:FlagValues, the FlagValues instance in which the flag will be declared as a key flag. This should almost never need to be overridden.

Raises
ValueError	Raised if flag_name not defined as a Python 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. Some content is licensed under the numpy license.

Last updated 2024-04-26 UTC.