neulab/docprompting-conala huggingface dataset:
tf.compat.v1.flags.DEFINE_list Registers a flag whose value is a comma-separated list of strings.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_list  
tf.compat.v1.flags.DEFINE_list(
    name, default, help, flag_values=_flagvalues.FLAGS, **args
)
 The flag value is parsed with a CSV parser.
 


 Args
  name   str, the flag name.  
  default   list|str|None, the default value of the flag.  
  help   str, the help message.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_multi Registers a generic MultiFlag that parses its args with a given parser.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_multi  
tf.compat.v1.flags.DEFINE_multi(
    parser, serializer, name, default, help, flag_values=_flagvalues.FLAGS,
    module_name=None, **args
)
 Auxiliary function. Normal users should NOT use it directly. Developers who need to create their own 'Parser' classes for options which can appear multiple times can call this module function to register their flags.
 


 Args
  parser   ArgumentParser, used to parse the flag arguments.  
  serializer   ArgumentSerializer, the flag serializer instance.  
  name   str, the flag name.  
  default   Union[Iterable[T], Text, None], the default value of the flag. If the value is text, it will be parsed as if it was provided from the command line. If the value is a non-string iterable, it will be iterated over to create a shallow copy of the values. If it is None, it is left as-is.  
  help   str, the help message.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  module_name   A string, the name of the Python module declaring this flag. If not provided, it will be computed using the stack trace of this call.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_multi_enum Registers a flag whose value can be a list strings from enum_values.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_multi_enum  
tf.compat.v1.flags.DEFINE_multi_enum(
    name, default, enum_values, help, flag_values=_flagvalues.FLAGS,
    case_sensitive=True, **args
)
 Use the flag on the command line multiple times to place multiple enum values into the list. The 'default' may be a single string (which will be converted into a single-element list) or a list of strings.
 


 Args
  name   str, the flag name.  
  default   Union[Iterable[Text], Text, None], the default value of the flag; see DEFINE_multi.  
  enum_values   [str], a non-empty list of strings with the possible values for the flag.  
  help   str, the help message.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  case_sensitive   Whether or not the enum is to be case-sensitive.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_multi_enum_class Registers a flag whose value can be a list of enum members.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_multi_enum_class  
tf.compat.v1.flags.DEFINE_multi_enum_class(
    name, default, enum_class, help, flag_values=_flagvalues.FLAGS,
    module_name=None, case_sensitive=False, **args
)
 Use the flag on the command line multiple times to place multiple enum values into the list.
 


 Args
  name   str, the flag name.  
  default   Union[Iterable[Enum], Iterable[Text], Enum, Text, None], the default value of the flag; see DEFINE_multi; only differences are documented here. If the value is a single Enum, it is treated as a single-item list of that Enum value. If it is an iterable, text values within the iterable will be converted to the equivalent Enum objects.  
  enum_class   class, the Enum class with all the possible values for the flag. help: str, the help message.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  module_name   A string, the name of the Python module declaring this flag. If not provided, it will be computed using the stack trace of this call.  
  case_sensitive   bool, whether to map strings to members of the enum_class without considering case.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_multi_float Registers a flag whose value can be a list of arbitrary floats.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_multi_float  
tf.compat.v1.flags.DEFINE_multi_float(
    name, default, help, lower_bound=None, upper_bound=None,
    flag_values=_flagvalues.FLAGS, **args
)
 Use the flag on the command line multiple times to place multiple float values into the list. The 'default' may be a single float (which will be converted into a single-element list) or a list of floats.
 


 Args
  name   str, the flag name.  
  default   Union[Iterable[float], Text, None], the default value of the flag; see DEFINE_multi.  
  help   str, the help message.  
  lower_bound   float, min values of the flag.  
  upper_bound   float, max values of the flag.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_multi_integer Registers a flag whose value can be a list of arbitrary integers.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_multi_integer  
tf.compat.v1.flags.DEFINE_multi_integer(
    name, default, help, lower_bound=None, upper_bound=None,
    flag_values=_flagvalues.FLAGS, **args
)
 Use the flag on the command line multiple times to place multiple integer values into the list. The 'default' may be a single integer (which will be converted into a single-element list) or a list of integers.
 


 Args
  name   str, the flag name.  
  default   Union[Iterable[int], Text, None], the default value of the flag; see DEFINE_multi.  
  help   str, the help message.  
  lower_bound   int, min values of the flag.  
  upper_bound   int, max values of the flag.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_multi_string Registers a flag whose value can be a list of any strings.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_multi_string  
tf.compat.v1.flags.DEFINE_multi_string(
    name, default, help, flag_values=_flagvalues.FLAGS, **args
)
 Use the flag on the command line multiple times to place multiple string values into the list. The 'default' may be a single string (which will be converted into a single-element list) or a list of strings.
 


 Args
  name   str, the flag name.  
  default   Union[Iterable[Text], Text, None], the default value of the flag; see DEFINE_multi.  
  help   str, the help message.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_spaceseplist Registers a flag whose value is a whitespace-separated list of strings.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_spaceseplist  
tf.compat.v1.flags.DEFINE_spaceseplist(
    name, default, help, comma_compat=False, flag_values=_flagvalues.FLAGS, **args
)
 Any whitespace can be used as a separator.
 


 Args
  name   str, the flag name.  
  default   list|str|None, the default value of the flag.  
  help   str, the help message.  
  comma_compat   bool - Whether to support comma as an additional separator. If false then only whitespace is supported. This is intended only for backwards compatibility with flags that used to be comma-separated.  
  flag_values   FlagValues, the FlagValues instance with which the flag will be registered. This should almost never need to be overridden.  
  **args   Dictionary with extra keyword args that are passed to the Flag init.   
 


 Returns   a handle to defined flag.
tf.compat.v1.flags.DEFINE_string Registers a flag whose value can be any string.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DEFINE_string  
tf.compat.v1.flags.DEFINE_string(
    name, default, help, flag_values=_flagvalues.FLAGS, **args
)
tf.compat.v1.flags.disclaim_key_flags Declares that the current module will not define any more key flags.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.disclaim_key_flags  
tf.compat.v1.flags.disclaim_key_flags()
 Normally, the module that calls the DEFINE_xxx functions claims the flag to be its key flag. This is undesirable for modules that define additional DEFINE_yyy functions with its own flag parsers and serializers, since that module will accidentally claim flags defined by DEFINE_yyy as its key flags. After calling this function, the module disclaims flag definitions thereafter, so the key flags will be correctly attributed to the caller of DEFINE_yyy. After calling this function, the module will not be able to define any more flags. This function will affect all FlagValues objects.
tf.compat.v1.flags.doc_to_help Takes a doc string and reformats it as help.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.doc_to_help  
tf.compat.v1.flags.doc_to_help(
    doc
)
tf.compat.v1.flags.DuplicateFlagError Raised if there is a flag naming conflict. Inherits From: Error  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.DuplicateFlagError  Methods from_flag 
@classmethod
from_flag(
    flagname, flag_values, other_flag_values=None
)
 Creates a DuplicateFlagError by providing flag name and values.
 


 Args
  flagname   str, the name of the flag being redefined.  
  flag_values   FlagValues, the FlagValues instance containing the first definition of flagname.  
  other_flag_values   FlagValues, if it is not None, it should be the FlagValues object where the second definition of flagname occurs. If it is None, we assume that we're being called when attempting to create the flag a second time, and we use the module calling this one as the source of the second definition.   
 


 Returns   An instance of DuplicateFlagError.
tf.compat.v1.flags.EnumClassFlag Basic enum flag; its value is an enum class's member. Inherits From: Flag  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.EnumClassFlag  
tf.compat.v1.flags.EnumClassFlag(
    name, default, help, enum_class, short_name=None, case_sensitive=False, **args
)

 


 Attributes
  value  
   Methods flag_type 
flag_type()
 Returns a str that describes the type of the flag. 
Note: we use strings, and not the types.*Type constants because our flags can have more exotic types, e.g., 'comma separated list of strings', 'whitespace separated list of strings', etc.
 parse 
parse(
    argument
)
 Parses string and sets flag value.
 


 Args
  argument   str or the correct flag value type, argument to be parsed.    serialize 
serialize()
 Serializes the flag. unparse 
unparse()
 __eq__ 
__eq__(
    other
)
 Return self==value. __ge__ 
__ge__(
    other, NotImplemented=NotImplemented
)
 Return a >= b. Computed by @total_ordering from (not a < b). __gt__ 
__gt__(
    other, NotImplemented=NotImplemented
)
 Return a > b. Computed by @total_ordering from (not a < b) and (a != b). __le__ 
__le__(
    other, NotImplemented=NotImplemented
)
 Return a <= b. Computed by @total_ordering from (a < b) or (a == b). __lt__ 
__lt__(
    other
)
 Return self<value.
tf.compat.v1.flags.EnumClassParser Parser of an Enum class member. Inherits From: ArgumentParser  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.EnumClassParser  
tf.compat.v1.flags.EnumClassParser(
    enum_class, case_sensitive=True
)

 


 Args
  enum_class   class, the Enum class with all possible flag values.  
  case_sensitive   bool, whether or not the enum is to be case-sensitive. If False, all member names must be unique when case is ignored.   
 


 Raises
  TypeError   When enum_class is not a subclass of Enum.  
  ValueError   When enum_class is empty.   
 


 Attributes
  member_names   The accepted enum names, in lowercase if not case sensitive.    Methods flag_type 
flag_type()
 See base class. parse 
parse(
    argument
)
 Determines validity of argument and returns the correct element of enum.
 


 Args
  argument   str or Enum class member, the supplied flag value.   
 


 Returns   The first matching Enum class member in Enum class.  

 


 Raises
  ValueError   Raised when argument didn't match anything in enum.   
 


 Class Variables
  syntactic_help   ''
tf.compat.v1.flags.EnumFlag Basic enum flag; its value can be any string from list of enum_values. Inherits From: Flag  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.EnumFlag  
tf.compat.v1.flags.EnumFlag(
    name, default, help, enum_values, short_name=None, case_sensitive=True, **args
)

 


 Attributes
  value  
   Methods flag_type 
flag_type()
 Returns a str that describes the type of the flag. 
Note: we use strings, and not the types.*Type constants because our flags can have more exotic types, e.g., 'comma separated list of strings', 'whitespace separated list of strings', etc.
 parse 
parse(
    argument
)
 Parses string and sets flag value.
 


 Args
  argument   str or the correct flag value type, argument to be parsed.    serialize 
serialize()
 Serializes the flag. unparse 
unparse()
 __eq__ 
__eq__(
    other
)
 Return self==value. __ge__ 
__ge__(
    other, NotImplemented=NotImplemented
)
 Return a >= b. Computed by @total_ordering from (not a < b). __gt__ 
__gt__(
    other, NotImplemented=NotImplemented
)
 Return a > b. Computed by @total_ordering from (not a < b) and (a != b). __le__ 
__le__(
    other, NotImplemented=NotImplemented
)
 Return a <= b. Computed by @total_ordering from (a < b) or (a == b). __lt__ 
__lt__(
    other
)
 Return self<value.
tf.compat.v1.flags.EnumParser Parser of a string enum value (a string value from a given set). Inherits From: ArgumentParser  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.EnumParser  
tf.compat.v1.flags.EnumParser(
    enum_values, case_sensitive=True
)

 


 Args
  enum_values   [str], a non-empty list of string values in the enum.  
  case_sensitive   bool, whether or not the enum is to be case-sensitive.   
 


 Raises
  ValueError   When enum_values is empty.    Methods flag_type 
flag_type()
 See base class. parse 
parse(
    argument
)
 Determines validity of argument and returns the correct element of enum.
 


 Args
  argument   str, the supplied flag value.   
 


 Returns   The first matching element from enum_values.  

 


 Raises
  ValueError   Raised when argument didn't match anything in enum.   
 


 Class Variables
  syntactic_help   ''
tf.compat.v1.flags.Error The base class for all flags errors.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.Error
tf.compat.v1.flags.FlagHolder Holds a defined flag.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.FlagHolder  
tf.compat.v1.flags.FlagHolder(
    flag_values, flag, ensure_non_none_value=False
)
 This facilitates a cleaner api around global state. Instead of flags.DEFINE_integer('foo', ...)
flags.DEFINE_integer('bar', ...)
...
def method():
  # prints parsed value of 'bar' flag
  print(flags.FLAGS.foo)
  # runtime error due to typo or possibly bad coding style.
  print(flags.FLAGS.baz)
 it encourages code like FOO_FLAG = flags.DEFINE_integer('foo', ...)
BAR_FLAG = flags.DEFINE_integer('bar', ...)
...
def method():
  print(FOO_FLAG.value)
  print(BAR_FLAG.value)
 since the name of the flag appears only once in the source code.
 


 Args
  flag_values   The container the flag is registered to.  
  flag   The flag object for this flag.  
  ensure_non_none_value   Is the value of the flag allowed to be None.   
 


 Attributes
  default   Returns the default value of the flag.  
  name  
 
  value   Returns the value of the flag. If _ensure_non_none_value is True, then return value is not None. 
   Methods __bool__ 
__bool__()
 __eq__ 
__eq__(
    other
)
 Return self==value. __nonzero__ 
__nonzero__()
tf.compat.v1.flags.FlagNameConflictsWithMethodError Raised when a flag name conflicts with FlagValues methods. Inherits From: Error  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.FlagNameConflictsWithMethodError
tf.compat.v1.flags.FLAGS Registry of 'Flag' objects.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.FLAGS  
tf.compat.v1.flags.FLAGS(
    *args, **kwargs
)
 A 'FlagValues' can then scan command line arguments, passing flag arguments through to the 'Flag' objects that it owns. It also provides easy access to the flag values. Typically only one 'FlagValues' object is needed by an application: flags.FLAGS This class is heavily overloaded: 'Flag' objects are registered via setitem: FLAGS['longname'] = x # register a new flag The .value attribute of the registered 'Flag' objects can be accessed as attributes of this 'FlagValues' object, through getattr. Both the long and short name of the original 'Flag' objects can be used to access its value: FLAGS.longname # parsed flag value FLAGS.x # parsed flag value (short name) Command line arguments are scanned and passed to the registered 'Flag' objects through the call method. Unparsed arguments, including argv0 are returned. argv = FLAGS(sys.argv) # scan command line arguments The original registered Flag objects can be retrieved through the use of the dictionary-like operator, getitem: x = FLAGS['longname'] # access the registered Flag object The str() operator of a 'FlagValues' object provides help for all of the registered 'Flag' objects.
tf.compat.v1.flags.flag_dict_to_args Convert a dict of values into process call parameters.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.flag_dict_to_args  
tf.compat.v1.flags.flag_dict_to_args(
    flag_map, multi_flags=None
)
 This method is used to convert a dictionary into a sequence of parameters for a binary that parses arguments using this module.
 


 Args
  flag_map   dict, a mapping where the keys are flag names (strings). values are treated according to their type:  If value is None, then only the name is emitted. If value is True, then only the name is emitted. If value is False, then only the name prepended with 'no' is emitted. If value is a string then --name=value is emitted. If value is a collection, this will emit --name=value1,value2,value3, unless the flag name is in multi_flags, in which case this will emit --name=value1 --name=value2 --name=value3. Everything else is converted to string an passed as such. 

 
  multi_flags   set, names (strings) of flags that should be treated as multi-flags.   
 


 Yields   sequence of string suitable for a subprocess execution.
tf.compat.v1.flags.FloatParser Parser of floating point values. Inherits From: ArgumentParser  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.FloatParser  
tf.compat.v1.flags.FloatParser(
    lower_bound=None, upper_bound=None
)
 Parsed value may be bounded to a given upper and lower bound. Methods convert 
convert(
    argument
)
 Returns the float value of argument. flag_type 
flag_type()
 See base class. is_outside_bounds 
is_outside_bounds(
    val
)
 Returns whether the value is outside the bounds or not. parse 
parse(
    argument
)
 See base class.
 


 Class Variables
  number_article   'a'  
  number_name   'number'  
  syntactic_help   'a number'
tf.compat.v1.flags.get_help_width Returns the integer width of help lines that is used in TextWrap.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.get_help_width  
tf.compat.v1.flags.get_help_width()
tf.compat.v1.flags.IllegalFlagValueError Raised when the flag command line argument is illegal. Inherits From: Error  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.IllegalFlagValueError
tf.compat.v1.flags.IntegerParser Parser of an integer value. Inherits From: ArgumentParser  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.IntegerParser  
tf.compat.v1.flags.IntegerParser(
    lower_bound=None, upper_bound=None
)
 Parsed value may be bounded to a given upper and lower bound. Methods convert 
convert(
    argument
)
 Returns the int value of argument. flag_type 
flag_type()
 See base class. is_outside_bounds 
is_outside_bounds(
    val
)
 Returns whether the value is outside the bounds or not. parse 
parse(
    argument
)
 See base class.
 


 Class Variables
  number_article   'an'  
  number_name   'integer'  
  syntactic_help   'an integer'
tf.compat.v1.flags.ListParser Parser for a comma-separated list of strings. Inherits From: BaseListParser, ArgumentParser  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.ListParser  
tf.compat.v1.flags.ListParser()
 Methods flag_type 
flag_type()
 See base class. parse 
parse(
    argument
)
 Parses argument as comma-separated list of strings.
 


 Class Variables
  syntactic_help   ''
tf.compat.v1.flags.ListSerializer Base class for generating string representations of a flag value. Inherits From: ArgumentSerializer  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.ListSerializer  
tf.compat.v1.flags.ListSerializer(
    list_sep
)
 Methods serialize 
serialize(
    value
)
 See base class.
tf.compat.v1.flags.mark_bool_flags_as_mutual_exclusive Ensures that only one flag among flag_names is True.  View aliases  Compat aliases for migration 
See Migration guide for more details. tf.compat.v1.app.flags.mark_bool_flags_as_mutual_exclusive  
tf.compat.v1.flags.mark_bool_flags_as_mutual_exclusive(
    flag_names, required=False, flag_values=_flagvalues.FLAGS
)

 


 Args
  flag_names   [str], names of the flags.  
  required   bool. If true, exactly one flag must be True. Otherwise, at most one flag can be True, and it is valid for all flags to be False.  
  flag_values   flags.FlagValues, optional FlagValues instance where the flags are defined.