tf.compat.v1.flags.register_validator
Stay organized with collections
Save and categorize content based on your preferences.
Adds a constraint, which will be enforced during program execution.
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 | FlagHolder, name or holder of the flag to be checked.
Positional-only parameter.
|
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.
|
ValueError
|
Raised when flag_values is non-default and does not match the
FlagValues of the provided FlagHolder instance.
|
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 2023-10-06 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 2023-10-06 UTC."],[],[]]