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

tf.compat.v1.flags.multi_flags_validator

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

A function decorator for defining a multi-flag validator.

tf.compat.v1.flags.multi_flags_validator(
    flag_names,
    message='Flag validation failed',
    flag_values=_flagvalues.FLAGS
)

Registers the decorated function as a validator for flag_names, e.g.::

@flags.multi_flags_validator(['foo', 'bar'])
def _CheckFooBar(flags_dict):
  ...

See :func:register_multi_flags_validator for the specification of checker function.

Args
flag_names [str | FlagHolder], a list of the flag names or holders to be checked. Positional-only parameter.
message str, error text to be shown to the user if checker returns False. If checker raises flags.ValidationError, message from the raised error will be shown.
flag_values flags.FlagValues, optional FlagValues instance to validate against.
Returns
A function decorator that registers its function argument as a validator.
Raises
AttributeError Raised when a flag is not registered as a valid flag name.

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.