tf.compat.v1.flags.validator
Stay organized with collections
Save and categorize content based on your preferences.
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 register_validator() for the specification of checker function.
Args |
|---|
flag_name
|
str, name of the flag to be checked.
|
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.
|
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.validator\n\n\u003cbr /\u003e\n\nA function decorator for defining a flag validator.\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.validator`](/api_docs/python/tf/compat/v1/flags/validator)\n\n\u003cbr /\u003e\n\n tf.compat.v1.flags.validator(\n flag_name, message='Flag validation failed', flag_values=_flagvalues.FLAGS\n )\n\nRegisters the decorated function as a validator for flag_name, e.g.\n\n@flags.validator('foo')\ndef _CheckFoo(foo):\n...\n\nSee register_validator() for the specification of checker function.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `flag_name` | str, name of the flag to be checked. |\n| `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. |\n| `flag_values` | flags.FlagValues, optional FlagValues instance to validate against. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A function decorator that registers its function argument as a validator. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|------------------|---------------------------------------------------------------|\n| `AttributeError` | Raised when flag_name is not registered as a valid flag name. |\n\n\u003cbr /\u003e"]]
