tf.compat.v1.flags.mark_flags_as_mutual_exclusive
Stay organized with collections
Save and categorize content based on your preferences.
Ensures that only one flag among flag_names is not None.
tf.compat.v1.flags.mark_flags_as_mutual_exclusive(
flag_names, required=False, flag_values=_flagvalues.FLAGS
)
Important note: This validator checks if flag values are None, and it does
not distinguish between default and explicit values. Therefore, this validator
does not make sense when applied to flags with default values other than None,
including other false values (e.g. False, 0, '', []). That
includes multi flags with a default value of [] instead of None.
Args |
|---|
flag_names
|
[str | FlagHolder], names or holders of flags.
Positional-only parameter.
|
required
|
bool. If true, exactly one of the flags must have a value other
than None. Otherwise, at most one of the flags can have a value other
than None, and it is valid for all of the flags to be None.
|
flag_values
|
flags.FlagValues, optional FlagValues instance where the flags
are defined.
|
Raises |
|---|
ValueError
|
Raised when multiple FlagValues are used in the same
invocation. This can occur when FlagHolders have different _flagvalues
or when str-type flag_names entries are present and the flag_values
argument does not match that of provided FlagHolder(s).
|
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.
[null,null,["Last updated 2024-04-26 UTC."],[],[],null,["# tf.compat.v1.flags.mark_flags_as_mutual_exclusive\n\n\u003cbr /\u003e\n\nEnsures that only one flag among flag_names is not None. \n\n tf.compat.v1.flags.mark_flags_as_mutual_exclusive(\n flag_names, required=False, flag_values=_flagvalues.FLAGS\n )\n\nImportant note: This validator checks if flag values are `None`, and it does\nnot distinguish between default and explicit values. Therefore, this validator\ndoes not make sense when applied to flags with default values other than None,\nincluding other false values (e.g. `False`, `0`, `''`, `[]`). That\nincludes multi flags with a default value of `[]` instead of None.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `flag_names` | \\[str \\| FlagHolder\\], names or holders of flags. Positional-only parameter. |\n| `required` | bool. If true, exactly one of the flags must have a value other than None. Otherwise, at most one of the flags can have a value other than None, and it is valid for all of the flags to be None. |\n| `flag_values` | flags.FlagValues, optional FlagValues instance where the flags are defined. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ValueError` | Raised when multiple FlagValues are used in the same invocation. This can occur when FlagHolders have different `_flagvalues` or when str-type flag_names entries are present and the `flag_values` argument does not match that of provided FlagHolder(s). |\n\n\u003cbr /\u003e"]]
