tf.compat.v1.flags.register_validator
bookmark_borderbookmark
Stay organized with collections
Save and categorize content based on your preferences.
Adds a constraint, which will be enforced during program execution.
View aliases
Compat aliases for migration
See
Migration guide for
more details.
tf.compat.v1.app.flags.register_validator
tf.compat.v1.flags.register_validator(
flag_name, checker, message='Flag validation failed',
flag_values=_flagvalues.FLAGS
)
The constraint is validated when flags are initially parsed, and after each
change of the corresponding flag's value.
Args:
flag_name: str, name of the flag to be checked.
checker: callable, a function to validate the flag.
input - A single positional argument: The value of the corresponding
flag (string, boolean, etc. This value will be passed to checker
by the library).
output - bool, True if validator constraint is satisfied.
If constraint is not satisfied, it should either return False or
raise flags.ValidationError(desired_error_message).
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2020-10-01 UTC."],[],[],null,["# tf.compat.v1.flags.register_validator\n\n\u003cbr /\u003e\n\nAdds a constraint, which will be enforced during program execution.\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.register_validator`](/api_docs/python/tf/compat/v1/flags/register_validator)\n\n\u003cbr /\u003e\n\n tf.compat.v1.flags.register_validator(\n flag_name, checker, message='Flag validation failed',\n flag_values=_flagvalues.FLAGS\n )\n\nThe constraint is validated when flags are initially parsed, and after each\nchange of the corresponding flag's value.\nArgs:\nflag_name: str, name of the flag to be checked.\nchecker: callable, a function to validate the flag.\ninput - A single positional argument: The value of the corresponding\nflag (string, boolean, etc. This value will be passed to checker\nby the library).\noutput - bool, True if validator constraint is satisfied.\nIf constraint is not satisfied, it should either return False or\nraise flags.ValidationError(desired_error_message).\nmessage: str, error text to be shown to the user if checker returns False.\nIf checker raises flags.ValidationError, message from the raised\nerror will be shown.\nflag_values: flags.FlagValues, optional FlagValues instance to validate\nagainst.\nRaises:\nAttributeError: Raised when flag_name is not registered as a valid flag\nname."]]
