A function decorator for defining a flag validator.
tf.compat.v1.flags.validator(
flag_name,
message='Flag validation failed',
flag_values=_flagvalues.FLAGS
)
Registers the decorated function as a validator for flag_name, e.g.::
@flags.validator('foo')
def _CheckFoo(foo):
...
See :func:register_validator for the specification of checker function.
| Args | |
|---|---|
flag_name | str | FlagHolder, name or holder of the flag 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 flag_name is not registered as a valid flag name. |
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/compat/v1/flags/validator