tf.compat.v1.flags.Flag

Информация о флаге командной строки.

tf.compat.v1.flags.Flag(
    parser: _argument_parser.ArgumentParser[_T],
    serializer: Optional[_argument_parser.ArgumentSerializer[_T]],
    name: Text,
    default: Union[Optional[_T], Text],
    help_string: Optional[Text],
    short_name: Optional[Text] = None,
    boolean: bool = False,
    allow_override: bool = False,
    allow_override_cpp: bool = False,
    allow_hide_cpp: bool = False,
    allow_overwrite: bool = True,
    allow_using_method_names: bool = False
) -> None

Единственный публичный метод объекта Flag — :meth:parse, но он обычно вызывается объектом :class:~absl.flags.FlagValues. Метод :meth:parse — это тонкий обертка над методом :meth:ArgumentParser.parse()<absl.flags.ArgumentParser.parse>. Разложенное значение сохраняется в .value, а атрибут .present обновляется. Если этот флаг уже существует, генерируется ошибка.

Метод :meth:parse также вызывается во время __init__ для разбора значения по умолчанию и инициализации атрибута .value. Это позволяет другим модулям Python безопасно использовать флаги, даже если модуль __main__ не выполняет разбор аргументов командной строки. Атрибут .present очищается после разбора __init__. Если значение по умолчанию установлено в None, этап разбора __init__ пропускается, и атрибут .value инициализируется значением None.

Примечание: Значение по умолчанию также отображается пользователю в строке справки, поэтому важно, чтобы оно было допустимым значением для этого флага.

Атрибуты
`name`	имя этого флага
`default`	значение по умолчанию для этого флага
`default_unparsed`	неразложенное значение по умолчанию для этого флага.
`default_as_str`	строковое представление значения по умолчанию, например, "'true'" (или None)
`value`	последнее разложенное значение этого флага, установленное методом :meth:`parse`
`help`	строка справки или None, если справка недоступна
`short_name`	однобуквенный псевдоним для этого флага (или None)
`boolean`	если 'true', этот флаг не принимает аргументы
`present`	true, если этот флаг был разложен из флагов командной строки
`parser`	объект :class:`~absl.flags.ArgumentParser`
`serializer`	объект ArgumentSerializer
`allow_override`	флаг может быть переопределен без ошибок, и вновь определённый флаг переопределяет старый.
`allow_override_cpp`	использовать флаг из C++, если доступен; определение флага заменяется флагом C++ после инициализации.
`allow_hide_cpp`	использовать Python-флаг, несмотря на наличие C++-флага с тем же именем (игнорировать C++-флаг).
`using_default_value`	значение флага не было установлено пользователем
`allow_overwrite`	флаг может быть разложен несколько раз без ошибок; будет использовано последнее заданное значение
`allow_using_method_names`	может ли быть определен этот флаг, даже если у него есть имя, конфликтующее с методом FlagValues.
`validators`	список валидаторов флага.

Методы

`flag_type`

flag_type() -> Text

Возвращает строку, описывающую тип флага.

Примечание: мы используем строки, а не типы.*Постоянные значения типов, потому что наши флаги могут иметь более экзотические типы, например, 'список строк, разделённых запятыми', 'список строк, разделённых пробелами' и т. д.

`parse`

parse(
    argument: Union[Text, Optional[_T]]
) -> None

Разбирает строку и устанавливает значение флага.

Аргументы
`argument`	строка или правильный тип значения флага, аргумент для разбора.

`serialize`

serialize() -> Text

Сериализует флаг.

`unparse`

unparse() -> None

`bool`

__bool__()

`eq`

__eq__(
    other
)

Возвращает self==value.

`ge`

__ge__(
    other, NotImplemented=NotImplemented
)

Возвращает a >= b. Вычислено с помощью @total_ordering из (not a < b).

`gt`

__gt__(
    other, NotImplemented=NotImplemented
)

Возвращает a > b. Вычислено с помощью @total_ordering из (not a < b) и (a != b).

`le`

__le__(
    other, NotImplemented=NotImplemented
)

Возвращает a <= b. Вычислено с помощью @total_ordering из (a < b) или (a == b).

`lt`

__lt__(
    other
)

Возвращает self<value.

© 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/Flag