Spec-Zone.ru › TensorFlow 2.9

tf.compat.v1.data.TextLineDataset

A набор строк из одного или нескольких текстовых файлов.

Наследуется от: Dataset, Dataset

tf.compat.v1.data.TextLineDataset(
    filenames,
    compression_type=None,
    buffer_size=None,
    num_parallel_reads=None,
    name=None
)
Аргументы
filenames A tf.data.Dataset элементы которого являются tf.string скалярами, tf.string тензором или значением, которое можно преобразовать в tf.string тензор (например, список строк Python).
compression_type (Необязательно.) A tf.string скаляр, вычисляемый как один из "" (без сжатия), "ZLIB", или "GZIP".
buffer_size (Необязательно.) A tf.int64 скаляр, обозначающий количество байтов для буферизации. Значение 0 приводит к значениям буферизации по умолчанию, выбранным в зависимости от типа сжатия.
num_parallel_reads (Необязательно.) A tf.int64 скаляр, представляющий количество файлов для одновременного чтения. Если больше единицы, записи из файлов, прочитанные параллельно, выводятся в перекрещенном порядке. Если ваш конвейер ввода-вывода ограничен вводом-выводом, рассмотрите возможность установки этого параметра на значение, большее единицы, для паралелизации ввода-вывода. Если None, файлы будут читаться последовательно.
name (Необязательно.) Имя операции tf.data.
Атрибуты
element_spec Спецификация типа элемента этого набора данных.
dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
dataset.element_spec
TensorSpec(shape=(), dtype=tf.int32, name=None)

Для получения дополнительной информации ознакомьтесь с этим руководством.

output_classes Возвращает класс каждого компонента элемента этого набора данных. (устарело)
Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Используйте tf.compat.v1.data.get_output_classes(dataset).
output_shapes Возвращает форму каждого компонента элемента этого набора данных. (устарело)
Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Используйте tf.compat.v1.data.get_output_shapes(dataset).
output_types Возвращает тип каждого компонента элемента этого набора данных. (устарело)
Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Используйте tf.compat.v1.data.get_output_types(dataset).

Методы

apply

Просмотреть исходный код

apply(
    transformation_func
)

Применяет функцию преобразования к этому набору данных.

apply позволяет цепочке пользовательские Dataset преобразования, которые представляют собой функции, принимающие один Dataset аргумент и возвращающие преобразованный Dataset.

dataset = tf.data.Dataset.range(100)
def dataset_fn(ds):
  return ds.filter(lambda x: x < 5)
dataset = dataset.apply(dataset_fn)
list(dataset.as_numpy_iterator())
[0, 1, 2, 3, 4]
Аргументы
transformation_func Функция, принимающая один Dataset аргумент и возвращающая Dataset.
Возвращает
Dataset Dataset полученный путем применения transformation_func к этому набору данных.

as_numpy_iterator

Просмотреть исходный код

as_numpy_iterator()

Возвращает итератор, который преобразует все элементы набора данных в numpy.

Используйте as_numpy_iterator для проверки содержимого вашего набора данных. Чтобы увидеть формы и типы элементов, распечатайте элементы набора данных напрямую, а не с помощью as_numpy_iterator.

dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
for element in dataset:
  print(element)
tf.Tensor(1, shape=(), dtype=int32)
tf.Tensor(2, shape=(), dtype=int32)
tf.Tensor(3, shape=(), dtype=int32)

Этот метод требует, чтобы вы работали в режиме eager, и элемент набора данных содержит только TensorSpec компоненты.

dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
for element in dataset.as_numpy_iterator():
  print(element)
1
2
3
dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
print(list(dataset.as_numpy_iterator()))
[1, 2, 3]

as_numpy_iterator() сохранит вложенную структуру элементов набора данных.

dataset = tf.data.Dataset.from_tensor_slices({'a': ([1, 2], [3, 4]),
                                              'b': [5, 6]})
list(dataset.as_numpy_iterator()) == [{'a': (1, 3), 'b': 5},
                                      {'a': (2, 4), 'b': 6}]
True
Возвращает
Итерируемый объект по элементам набора данных, с их тензорами, преобразованными в массивы numpy.
Исключения
TypeError если элемент содержит не-Tensor значение.
RuntimeError если режим eager не включен.

batch

Просмотреть исходный код

batch(
    batch_size,
    drop_remainder=False,
    num_parallel_calls=None,
    deterministic=None,
    name=None
)

Объединяет последовательные элементы этого набора данных в пакеты.

dataset = tf.data.Dataset.range(8)
dataset = dataset.batch(3)
list(dataset.as_numpy_iterator())
[array([0, 1, 2]), array([3, 4, 5]), array([6, 7])]
dataset = tf.data.Dataset.range(8)
dataset = dataset.batch(3, drop_remainder=True)
list(dataset.as_numpy_iterator())
[array([0, 1, 2]), array([3, 4, 5])]

Компоненты результирующего элемента будут иметь дополнительное внешнее измерение, которое будет batch_size (или N % batch_size для последнего элемента, если batch_size не делит количество входных элементов N равномерно и drop_remainder является False). Если ваша программа зависит от того, что у пакетов одинаковое внешнее измерение, вы должны установить аргумент drop_remainder на True, чтобы избежать создания меньшего пакета.

Примечание: Если ваша программа требует, чтобы данные имели статически известную форму (например, при использовании XLA), вы должны использовать drop_remainder=True. Без drop_remainder=True форма выходного набора данных будет иметь неизвестное ведущее измерение из-за возможности меньшего конечного пакета.
Аргументы
batch_size A tf.int64 скалярный tf.Tensor, представляющий количество последовательных элементов этого набора данных для объединения в один пакет.
drop_remainder (Необязательно.) A tf.bool скалярный tf.Tensor, представляющий, должен ли последний пакет быть пропущен в случае, если он содержит меньше batch_size элементов; поведение по умолчанию - не пропускать меньший пакет.
num_parallel_calls (Необязательно.) A tf.int64 скалярный tf.Tensor, представляющий количество пакетов для вычисления асинхронно параллельно. Если не указано, пакеты вычисляются последовательно. Если используется значение tf.data.AUTOTUNE, тогда количество параллельных вызовов устанавливается динамически на основе доступных ресурсов.
deterministic (Необязательно.) Когда num_parallel_calls указан, если этот булевый параметр указан (True или False), он контролирует порядок, в котором преобразование генерирует элементы. Если установлен в False, преобразованию разрешено генерировать элементы вне порядка, чтобы обменять детерминизм на производительность. Если не указан, опция tf.data.Options.deterministic (True по умолчанию) контролирует поведение.
name (Необязательно.) Имя операции tf.data.
Возвращает
Dataset A Dataset.

bucket_by_sequence_length

Просмотреть исходный код

bucket_by_sequence_length(
    element_length_func,
    bucket_boundaries,
    bucket_batch_sizes,
    padded_shapes=None,
    padding_values=None,
    pad_to_bucket_boundary=False,
    no_padding=False,
    drop_remainder=False,
    name=None
)

Преобразование, которое группирует элементы в набор данных по длине.

Элементы набора данных группируются по длине, а затем дополняются и объединяются в пакеты.

Это полезно для задач с последовательностями, в которых элементы имеют переменную длину. Группирование элементов с похожими длинами уменьшает общую долю заполнения в пакете, что повышает эффективность шагов обучения.

Ниже приведен пример букетизации входных данных в 3 пакета "[0, 3), [3, 5), [5, inf)" на основе длины последовательности с размером пакета 2.

elements = [
  [0], [1, 2, 3, 4], [5, 6, 7],
  [7, 8, 9, 10, 11], [13, 14, 15, 16, 19, 20], [21, 22]]
dataset = tf.data.Dataset.from_generator(
    lambda: elements, tf.int64, output_shapes=[None])
dataset = dataset.bucket_by_sequence_length(
        element_length_func=lambda elem: tf.shape(elem)[0],
        bucket_boundaries=[3, 5],
        bucket_batch_sizes=[2, 2, 2])
for elem in dataset.as_numpy_iterator():
  print(elem)
[[1 2 3 4]
[5 6 7 0]]
[[ 7  8  9 10 11  0]
[13 14 15 16 19 20]]
[[ 0  0]
[21 22]]
Аргументы
element_length_func функция, преобразующая элемент из Dataset в tf.int32, определяющая длину элемента, которая определяет, в какой бак он попадет.
bucket_boundaries list<int>, верхние границы длин бакетов.
bucket_batch_sizes list<int>, размер пакета на бакет. Длина должна быть len(bucket_boundaries) + 1.
padded_shapes Вложенная структура tf.TensorShape для передачи в tf.data.Dataset.padded_batch. Если не указано, будет использовано dataset.output_shapes, что приведет к тому, что переменные длины будут дополнены до максимальной длины в каждом пакете.
padding_values Значения для дополнения, передаваемые в tf.data.Dataset.padded_batch. По умолчанию используется дополнение нулями.
pad_to_bucket_boundary bool, если False, будут дополнены измерения неизвестного размера до максимальной длины в пакете. Если True, будут дополнены измерения неизвестного размера до границы бакета минус 1 (т.е. максимальная длина в каждом бакете), и вызывающая сторона должна убедиться, что исходный Dataset не содержит элементов с длиной, превышающей max(bucket_boundaries).
no_padding bool, указывает, нужно ли дополнять пакетные признаки (признаки должны быть либо типа tf.sparse.SparseTensor, либо иметь одинаковую форму).
drop_remainder (Необязательно.) Скалярный tf.bool тензор tf.Tensor, представляющий собой то, нужно ли отбрасывать последний пакет в случае, если он содержит меньше, чем batch_size элементов; по умолчанию меньший пакет не отбрасывается.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
A Dataset.
Исключения
ValueError если len(bucket_batch_sizes) != len(bucket_boundaries) + 1.

cache

Просмотреть исходный код

cache(
    filename='', name=None
)

Кэширует элементы в этом наборе данных.

В первый раз при итерировании по набору данных его элементы будут кэшированы либо в указанном файле, либо в памяти. При последующих итерированиях будут использованы кэшированные данные.

Примечание: Для завершения кэширования входной набор данных должен быть проитерирован полностью. В противном случае при последующих итерированиях кэшированные данные не будут использоваться.
dataset = tf.data.Dataset.range(5)
dataset = dataset.map(lambda x: x**2)
dataset = dataset.cache()
# The first time reading through the data will generate the data using
# `range` and `map`.
list(dataset.as_numpy_iterator())
[0, 1, 4, 9, 16]
# Subsequent iterations read from the cache.
list(dataset.as_numpy_iterator())
[0, 1, 4, 9, 16]

При кэшировании в файл кэшированные данные будут сохраняться между запусками. Даже первое итерирование данных будет считывать данные из кэшированного файла. Изменение входной конвейера перед вызовом .cache() не повлияет, пока файл кэша не будет удален или имя файла не будет изменено.

dataset = tf.data.Dataset.range(5)
dataset = dataset.cache("/path/to/file")
list(dataset.as_numpy_iterator())
# [0, 1, 2, 3, 4]
dataset = tf.data.Dataset.range(10)
dataset = dataset.cache("/path/to/file")  # Same file!
list(dataset.as_numpy_iterator())
# [0, 1, 2, 3, 4]
Примечание: cache будет генерировать точно такие же элементы во время каждого итерирования по набору данных. Если вы хотите случайный порядок итерирования, убедитесь, что вызываете shuffle после вызова cache.
Аргументы
filename Скалярный tf.string тензор tf.Tensor, представляющий собой имя каталога в файловой системе, используемого для кэширования элементов в этом наборе данных. Если имя файла не указано, набор данных будет кэширован в памяти.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.

cardinality

Просмотреть исходный код

cardinality()

Возвращает мощность набора данных, если она известна.

cardinality может вернуть tf.data.INFINITE_CARDINALITY, если набор данных содержит бесконечное число элементов, или tf.data.UNKNOWN_CARDINALITY, если анализ не смог определить количество элементов в наборе данных (например, когда источником набора данных является файл).

dataset = tf.data.Dataset.range(42)
print(dataset.cardinality().numpy())
42
dataset = dataset.repeat()
cardinality = dataset.cardinality()
print((cardinality == tf.data.INFINITE_CARDINALITY).numpy())
True
dataset = dataset.filter(lambda x: True)
cardinality = dataset.cardinality()
print((cardinality == tf.data.UNKNOWN_CARDINALITY).numpy())
True
Возвращаемое значение
Скалярный tf.int64 Tensor представляющий мощность набора данных. Если мощность бесконечна или неизвестна, cardinality возвращает именованные константы tf.data.INFINITE_CARDINALITY и tf.data.UNKNOWN_CARDINALITY соответственно.

choose_from_datasets

Просмотреть исходный код

@staticmethod
choose_from_datasets(
    datasets, choice_dataset, stop_on_empty_dataset=True
)

Создаёт набор данных, который детерминировано выбирает элементы из datasets.

Например, заданы следующие наборы данных:

datasets = [tf.data.Dataset.from_tensors("foo").repeat(),
            tf.data.Dataset.from_tensors("bar").repeat(),
            tf.data.Dataset.from_tensors("baz").repeat()]

# Define a dataset containing `[0, 1, 2, 0, 1, 2, 0, 1, 2]`.
choice_dataset = tf.data.Dataset.range(3).repeat(3)

result = tf.data.Dataset.choose_from_datasets(datasets, choice_dataset)

Элементы набора данных result будут:

"foo", "bar", "baz", "foo", "bar", "baz", "foo", "bar", "baz"
Аргументы
datasets Непустой список объектов tf.data.Dataset с совместимой структурой.
choice_dataset Набор данных скалярных tf.int64 тензоров между 0 и len(datasets) - 1.
stop_on_empty_dataset Если True, выбор останавливается, если встречается пустой набор данных. Если False, он пропускает пустые наборы данных. Рекомендуется установить его в True. В противном случае выбранные элементы начинаются так, как предполагает пользователь, но могут меняться по мере того, как входные наборы данных становятся пустыми. Это может быть трудно обнаружить, так как набор данных выглядит правильно с самого начала. По умолчанию True.
Возвращаемое значение
Набор данных, который чередует элементы из datasets в соответствии со значениями choice_dataset.
Исключения
TypeError Если datasets или choice_dataset имеют неправильный тип.
ValueError Если datasets пустой.

concatenate

Просмотреть исходный код

concatenate(
    dataset, name=None
)

Создает набор данных путем конкатенации заданного набора данных с этим набором данных.

a = tf.data.Dataset.range(1, 4)  # ==> [ 1, 2, 3 ]
b = tf.data.Dataset.range(4, 8)  # ==> [ 4, 5, 6, 7 ]
ds = a.concatenate(b)
list(ds.as_numpy_iterator())
[1, 2, 3, 4, 5, 6, 7]
# The input dataset and dataset to be concatenated should have
# compatible element specs.
c = tf.data.Dataset.zip((a, b))
a.concatenate(c)
Traceback (most recent call last):
TypeError: Two datasets to concatenate have different types
<dtype: 'int64'> and (tf.int64, tf.int64)
d = tf.data.Dataset.from_tensor_slices(["a", "b", "c"])
a.concatenate(d)
Traceback (most recent call last):
TypeError: Two datasets to concatenate have different types
<dtype: 'int64'> and <dtype: 'string'>
Аргументы
dataset Dataset для конкатенации.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.

enumerate

Просмотреть исходный код

enumerate(
    start=0, name=None
)

Перечисляет элементы этого набора данных.

Аналогично python's enumerate.

dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
dataset = dataset.enumerate(start=5)
for element in dataset.as_numpy_iterator():
  print(element)
(5, 1)
(6, 2)
(7, 3)
# The (nested) structure of the input dataset determines the
# structure of elements in the resulting dataset.
dataset = tf.data.Dataset.from_tensor_slices([(7, 8), (9, 10)])
dataset = dataset.enumerate()
for element in dataset.as_numpy_iterator():
  print(element)
(0, array([7, 8], dtype=int32))
(1, array([ 9, 10], dtype=int32))
Аргументы
start tf.int64 скалярный tf.Tensor, представляющий начальное значение для перечисления.
name Необязательно. Имя операций tf.data, используемых enumerate.
Возвращаемое значение
Dataset A Dataset.

filter

Просмотреть исходный код

filter(
    predicate, name=None
)

Фильтрация этого набора данных в соответствии с predicate.

dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
dataset = dataset.filter(lambda x: x < 3)
list(dataset.as_numpy_iterator())
[1, 2]
# `tf.math.equal(x, y)` is required for equality comparison
def filter_fn(x):
  return tf.math.equal(x, 1)
dataset = dataset.filter(filter_fn)
list(dataset.as_numpy_iterator())
[1]
Аргументы
predicate Функция, отображающая элемент набора данных в логическое значение.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset Dataset содержащий элементы этого набора данных, для которых predicate имеет значение True.

filter_with_legacy_function

Просмотреть исходный код

filter_with_legacy_function(
    predicate
)

Фильтрация этого набора данных в соответствии с predicate. (устаревшая функция)

Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Используйте `tf.data.Dataset.filter()
Примечание: Это аварийный выход для существующих случаев использования filter , которые не работают с функциями V2. Новый использования категорически не рекомендуется, а существующие должны быть переведены на filter, так как этот метод будет удалён в версии V2.
Аргументы
predicate Функция, отображающая (вложенную) структуру тензоров (с формами и типами, определёнными self.output_shapes и self.output_types ) на скалярный тензор tf.bool.
Возвращаемое значение
Dataset Результат Dataset, содержащий элементы этого набора данных, для которых predicate имеет значение True.

flat_map

Просмотреть исходный код

flat_map(
    map_func, name=None
)

Применяет map_func к этому набору данных и уплощает результат.

Подпись типа:

def flat_map(
  self: Dataset[T],
  map_func: Callable[[T], Dataset[S]]
) -> Dataset[S]

Используйте flat_map , если хотите убедиться, что порядок элементов в вашем наборе данных сохраняется. Например, для уплощения набора данных из батчей в набор данных их элементов:

dataset = tf.data.Dataset.from_tensor_slices(
    [[1, 2, 3], [4, 5, 6], [7, 8, 9]])
dataset = dataset.flat_map(
    lambda x: tf.data.Dataset.from_tensor_slices(x))
list(dataset.as_numpy_iterator())
[1, 2, 3, 4, 5, 6, 7, 8, 9]

tf.data.Dataset.interleave() — это обобщение flat_map, поскольку flat_map производит тот же результат, что и tf.data.Dataset.interleave(cycle_length=1)

Аргументы
map_func Функция, отображающая элемент набора данных в набор данных.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset Новый набор данных Dataset.

from_generator

Просмотреть исходный код

@staticmethod
from_generator(
    generator,
    output_types=None,
    output_shapes=None,
    args=None,
    output_signature=None,
    name=None
)

Создаёт набор данных, элементы которого генерируются с помощью generator. (устаревшие аргументы)

Устарело: НЕКОТОРЫЕ АРГУМЕНТЫ УСТАРЕЛИ: (output_shapes, output_types). Они будут удалены в будущей версии. Инструкции по обновлению: Используйте output_signature вместо них.
Примечание: Текущая реализация Dataset.from_generator() использует tf.numpy_function и наследует те же ограничения. В частности, она требует, чтобы операции, связанные с набором данных и итератором, были размещены на устройстве в том же процессе, что и Python-программа, которая вызвала Dataset.from_generator(). В частности, использование from_generator запретит использование сервиса tf.data для масштабирования обработки наборов данных. Тело generator не будет сериализовано в GraphDef, и вы не должны использовать этот метод, если вам нужно сериализовать вашу модель и восстановить её в другой среде.

Аргумент generator должен быть вызываемым объектом, который возвращает объект, поддерживающий протокол iter() (например, функцию-генератор).

Элементы, сгенерированные generator, должны быть совместимы либо с заданным аргументом output_signature, либо с заданными аргументами output_types и (необязательно) output_shapes, какой из них был указан.

Рекомендуемый способ вызова from_generator — использование аргумента output_signature. В этом случае выходные данные будут предполагаться состоящими из объектов с классами, формами и типами, определёнными объектами tf.TypeSpec из аргумента output_signature.

def gen():
  ragged_tensor = tf.ragged.constant([[1, 2], [3]])
  yield 42, ragged_tensor

dataset = tf.data.Dataset.from_generator(
     gen,
     output_signature=(
         tf.TensorSpec(shape=(), dtype=tf.int32),
         tf.RaggedTensorSpec(shape=(2, None), dtype=tf.int32)))

list(dataset.take(1))
[(<tf.Tensor: shape=(), dtype=int32, numpy=42>,
<tf.RaggedTensor [[1, 2], [3]]>)]

Также существует устаревший способ вызова from_generator — либо с аргументом output_types в одиночку, либо вместе с аргументом output_shapes. В этом случае выходные данные функции будут предполагаться состоящими из объектов tf.Tensor с типами, определёнными output_types, и с формами, которые либо неизвестны, либо определены output_shapes.

Примечание: Если generator зависит от изменяемых глобальных переменных или другого внешнего состояния, помните, что среда выполнения может вызвать generator несколько раз (чтобы поддерживать повторение Dataset) и в любое время между вызовом Dataset.from_generator() и производством первого элемента из генератора. Изменение глобальных переменных или внешнего состояния может привести к неопределённому поведению, и мы рекомендуем вам явно кэшировать любое внешнее состояние в generator до вызова Dataset.from_generator().
Примечание: Хотя параметр output_signature позволяет возвращать элементы Dataset, область действия Dataset.from_generator() должна быть ограничена логикой, которую нельзя выразить с помощью операций tf.data. Использование операций tf.data внутри функции-генератора — это антипаттерн и может привести к увеличению потребления памяти.
Аргументы
generator Вызываемый объект, который возвращает объект, поддерживающий протокол iter(). Если args не указан, generator не должен принимать аргументов; в противном случае он должен принимать столько аргументов, сколько значений в args.
output_types (Необязательно.) (Вложенная) структура объектов tf.DType, соответствующих каждому компоненту элемента, возвращаемого generator.
output_shapes (Необязательно.) (Вложенная) структура объектов tf.TensorShape, соответствующих каждому компоненту элемента, возвращаемого generator.
args (Необязательно.) Кортеж объектов tf.Tensor, которые будут оценены и переданы generator в качестве аргументов массивов NumPy.
output_signature (Необязательно.) (Вложенная) структура объектов tf.TypeSpec, соответствующих каждому компоненту элемента, возвращаемого generator.
name (Необязательно.) Имя операций tf.data, используемых from_generator.
Возвращаемое значение
Dataset Новый набор данных Dataset.

from_sparse_tensor_slices

Просмотреть исходный код

@staticmethod
from_sparse_tensor_slices(
    sparse_tensor
)

Разделяет каждый тензор ранга-N tf.sparse.SparseTensor в этом наборе данных построчно. (устаревшая функция)

Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Используйте tf.data.Dataset.from_tensor_slices().
Аргументы
sparse_tensor tf.sparse.SparseTensor.
Возвращаемое значение
Dataset Набор данных ранга-(N-1) разреженных тензоров Dataset.

from_tensor_slices

Просмотреть исходный код

@staticmethod
from_tensor_slices(
    tensors, name=None
)

Создаёт набор данных, элементы которого являются слайсами заданных тензоров.

Заданные тензоры нарезаются по их первому измерению. Эта операция сохраняет структуру входных тензоров, удаляя первое измерение каждого тензора и используя его как измерение набора данных. Все входные тензоры должны иметь одинаковый размер в своих первых измерениях.

# Slicing a 1D tensor produces scalar tensor elements.
dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
list(dataset.as_numpy_iterator())
[1, 2, 3]
# Slicing a 2D tensor produces 1D tensor elements.
dataset = tf.data.Dataset.from_tensor_slices([[1, 2], [3, 4]])
list(dataset.as_numpy_iterator())
[array([1, 2], dtype=int32), array([3, 4], dtype=int32)]
# Slicing a tuple of 1D tensors produces tuple elements containing
# scalar tensors.
dataset = tf.data.Dataset.from_tensor_slices(([1, 2], [3, 4], [5, 6]))
list(dataset.as_numpy_iterator())
[(1, 3, 5), (2, 4, 6)]
# Dictionary structure is also preserved.
dataset = tf.data.Dataset.from_tensor_slices({"a": [1, 2], "b": [3, 4]})
list(dataset.as_numpy_iterator()) == [{'a': 1, 'b': 3},
                                      {'a': 2, 'b': 4}]
True
# Two tensors can be combined into one Dataset object.
features = tf.constant([[1, 3], [2, 1], [3, 3]]) # ==> 3x2 tensor
labels = tf.constant(['A', 'B', 'A']) # ==> 3x1 tensor
dataset = Dataset.from_tensor_slices((features, labels))
# Both the features and the labels tensors can be converted
# to a Dataset object separately and combined after.
features_dataset = Dataset.from_tensor_slices(features)
labels_dataset = Dataset.from_tensor_slices(labels)
dataset = Dataset.zip((features_dataset, labels_dataset))
# A batched feature and label set can be converted to a Dataset
# in similar fashion.
batched_features = tf.constant([[[1, 3], [2, 3]],
                                [[2, 1], [1, 2]],
                                [[3, 3], [3, 2]]], shape=(3, 2, 2))
batched_labels = tf.constant([['A', 'A'],
                              ['B', 'B'],
                              ['A', 'B']], shape=(3, 2, 1))
dataset = Dataset.from_tensor_slices((batched_features, batched_labels))
for element in dataset.as_numpy_iterator():
  print(element)
(array([[1, 3],
       [2, 3]], dtype=int32), array([[b'A'],
       [b'A']], dtype=object))
(array([[2, 1],
       [1, 2]], dtype=int32), array([[b'B'],
       [b'B']], dtype=object))
(array([[3, 3],
       [3, 2]], dtype=int32), array([[b'A'],
       [b'B']], dtype=object))

Обратите внимание, что если tensors содержит массив NumPy, а жадное выполнение не включено, значения будут встроены в граф как одна или несколько операций tf.constant. Для больших наборов данных (> 1 ГБ) это может привести к потере памяти и проблемам с ограничениями по размеру при сериализации графа. Если tensors содержит один или несколько больших массивов NumPy, рассмотрите альтернативный подход, описанный в этом руководстве.

Аргументы
tensors Элемент набора данных, компоненты которого имеют одинаковое первое измерение. Допустимые значения документированы здесь.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset Объект Dataset.

from_tensors

Просмотреть исходный код

@staticmethod
from_tensors(
    tensors, name=None
)

Создает набор данных Dataset с одним элементом, состоящим из заданных тензоров.

from_tensors генерирует набор данных, содержащий только один элемент. Для разделения входного тензора на несколько элементов используйте from_tensor_slices.

dataset = tf.data.Dataset.from_tensors([1, 2, 3])
list(dataset.as_numpy_iterator())
[array([1, 2, 3], dtype=int32)]
dataset = tf.data.Dataset.from_tensors(([1, 2, 3], 'A'))
list(dataset.as_numpy_iterator())
[(array([1, 2, 3], dtype=int32), b'A')]
# You can use `from_tensors` to produce a dataset which repeats
# the same example many times.
example = tf.constant([1,2,3])
dataset = tf.data.Dataset.from_tensors(example).repeat(2)
list(dataset.as_numpy_iterator())
[array([1, 2, 3], dtype=int32), array([1, 2, 3], dtype=int32)]

Обратите внимание, что если tensors содержит массив NumPy, а выполнение в режиме eager не включено, значения будут встроены в граф как одна или несколько операций tf.constant. Для больших наборов данных (> 1 ГБ) это может привести к потере памяти и ограничениям по размеру при сериализации графа. Если tensors содержит один или несколько больших массивов NumPy, рассмотрите альтернативу, описанную в этом руководстве.

Аргументы
tensors Элемент набора данных. Допустимые значения документированы здесь.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset Набор данных Dataset.

get_single_element

Просмотреть исходный код

get_single_element(
    name=None
)

Возвращает единственный элемент dataset.

Функция позволяет использовать набор данных tf.data.Dataset в бессостоятельном выражении «тензор-в-тензор», без создания итератора. Это упрощает преобразование данных над тензорами с помощью оптимизированной абстракции наборов данных tf.data.Dataset поверх них.

Например, рассмотрим набор данных preprocessing_fn, который принимает на вход исходные данные и возвращает обработанные данные вместе с меткой.

def preprocessing_fn(raw_feature):
  # ... the raw_feature is preprocessed as per the use-case
  return feature

raw_features = ...  # input batch of BATCH_SIZE elements.
dataset = (tf.data.Dataset.from_tensor_slices(raw_features)
          .map(preprocessing_fn, num_parallel_calls=BATCH_SIZE)
          .batch(BATCH_SIZE))

processed_features = dataset.get_single_element()

В приведенном выше примере тензор raw_features длиной BATCH_SIZE был преобразован в набор данных tf.data.Dataset. Затем каждый из элементов raw_feature был обработан с помощью preprocessing_fn, а обработанные данные были объединены в один пакет. Конечный набор данных dataset содержит только один элемент, представляющий пакет всех обработанных данных.

Примечание: Набор данных dataset должен содержать только один элемент.

Теперь, вместо создания итератора для dataset и извлечения пакета данных, используется функция tf.data.get_single_element(), чтобы пропустить создание итератора и напрямую вывести пакет данных.

Это может быть особенно полезно, когда преобразования тензора выражаются как операции над наборами данных tf.data.Dataset и вы хотите использовать эти преобразования при обслуживании вашей модели.

Keras

model = ... # A pre-built or custom model

class PreprocessingModel(tf.keras.Model):
  def __init__(self, model):
    super().__init__(self)
    self.model = model

  @tf.function(input_signature=[...])
  def serving_fn(self, data):
    ds = tf.data.Dataset.from_tensor_slices(data)
    ds = ds.map(preprocessing_fn, num_parallel_calls=BATCH_SIZE)
    ds = ds.batch(batch_size=BATCH_SIZE)
    return tf.argmax(self.model(ds.get_single_element()), axis=-1)

preprocessing_model = PreprocessingModel(model)
your_exported_model_dir = ... # save the model to this path.
tf.saved_model.save(preprocessing_model, your_exported_model_dir,
              signatures={'serving_default': preprocessing_model.serving_fn}
              )

Estimator

В случае с оценщиками, как правило, необходимо определить serving_input_fn, которая потребует обработки данных моделью во время вывода.

def serving_input_fn():

  raw_feature_spec = ... # Spec for the raw_features
  input_fn = tf.estimator.export.build_parsing_serving_input_receiver_fn(
      raw_feature_spec, default_batch_size=None)
  )
  serving_input_receiver = input_fn()
  raw_features = serving_input_receiver.features

  def preprocessing_fn(raw_feature):
    # ... the raw_feature is preprocessed as per the use-case
    return feature

  dataset = (tf.data.Dataset.from_tensor_slices(raw_features)
            .map(preprocessing_fn, num_parallel_calls=BATCH_SIZE)
            .batch(BATCH_SIZE))

  processed_features = dataset.get_single_element()

  # Please note that the value of `BATCH_SIZE` should be equal to
  # the size of the leading dimension of `raw_features`. This ensures
  # that `dataset` has only element, which is a pre-requisite for
  # using `dataset.get_single_element()`.

  return tf.estimator.export.ServingInputReceiver(
      processed_features, serving_input_receiver.receiver_tensors)

estimator = ... # A pre-built or custom estimator
estimator.export_saved_model(your_exported_model_dir, serving_input_fn)
Аргументы
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Вложенная структура объектов tf.Tensor, соответствующая единственному элементу dataset.
Исключения
InvalidArgumentError (во время выполнения) если dataset не содержит ровно одного элемента.

group_by_window

Просмотреть исходный код

group_by_window(
    key_func, reduce_func, window_size=None, window_size_func=None, name=None
)

Группирует окна элементов по ключу и сводит их.

Это преобразование сопоставляет каждый последовательный элемент в наборе данных с ключом, используя key_func, и группирует элементы по ключу. Затем оно применяет reduce_func к не более чем window_size_func(key) элементам, соответствующим одному и тому же ключу. Все, кроме конечного окна для каждого ключа, будут содержать window_size_func(key) элементов; конечное окно может быть меньше.

Вы можете указать либо постоянный window_size размер окна, либо размер окна, определяемый ключом через window_size_func.

dataset = tf.data.Dataset.range(10)
window_size = 5
key_func = lambda x: x%2
reduce_func = lambda key, dataset: dataset.batch(window_size)
dataset = dataset.group_by_window(
          key_func=key_func,
          reduce_func=reduce_func,
          window_size=window_size)
for elem in dataset.as_numpy_iterator():
  print(elem)
[0 2 4 6 8]
[1 3 5 7 9]
Аргументы
key_func Функция, сопоставляющая вложенную структуру тензоров (с формами и типами, определенными self.output_shapes и self.output_types) со скалярным тензором tf.int64.
reduce_func Функция, сопоставляющая ключ и набор данных до window_size последовательных элементов, соответствующих этому ключу, с другим набором данных.
window_size Скалярный тензор типа tf.int64, представляющий количество последовательных элементов, соответствующих одному и тому же ключу, для объединения в один пакет, который будет передан в reduce_func. Взаимоисключающее с window_size_func.
window_size_func Функция, сопоставляющая ключ со скалярным тензором типа tf.int64, представляющим количество последовательных элементов, соответствующих одному и тому же ключу, для объединения в один пакет, который будет передан в reduce_func. Взаимоисключающее с window_size.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Набор данных Dataset.
Исключения
ValueError если ни один, ни оба из {window_size, window_size_func} не переданы.

interleave

Просмотреть исходный код

interleave(
    map_func,
    cycle_length=None,
    block_length=None,
    num_parallel_calls=None,
    deterministic=None,
    name=None
)

Применяет map_func к этому набору данных и переплетает результаты.

Тип сигнатуры:

def interleave(
  self: Dataset[T],
  map_func: Callable[[T], Dataset[S]]
) -> Dataset[S]

Например, вы можете использовать Dataset.interleave() для одновременной обработки многих входных файлов:

# Preprocess 4 files concurrently, and interleave blocks of 16 records
# from each file.
filenames = ["/var/data/file1.txt", "/var/data/file2.txt",
             "/var/data/file3.txt", "/var/data/file4.txt"]
dataset = tf.data.Dataset.from_tensor_slices(filenames)
def parse_fn(filename):
  return tf.data.Dataset.range(10)
dataset = dataset.interleave(lambda x:
    tf.data.TextLineDataset(x).map(parse_fn, num_parallel_calls=1),
    cycle_length=4, block_length=16)

Аргументы cycle_length и block_length управляют порядком получения элементов. cycle_length контролирует количество входных элементов, которые обрабатываются одновременно. Если вы установите cycle_length в 1, это преобразование будет обрабатывать по одному входному элементу за раз, и результат будет идентичен tf.data.Dataset.flat_map. В общем случае это преобразование применит map_func к cycle_length входным элементам, откроет итераторы на возвращаемых объектах Dataset и проциклится по ним, производя block_length последовательных элементов из каждого итератора, и потребляя следующий входной элемент каждый раз, когда достигает конца итератора.

Например:

dataset = Dataset.range(1, 6)  # ==> [ 1, 2, 3, 4, 5 ]
# NOTE: New lines indicate "block" boundaries.
dataset = dataset.interleave(
    lambda x: Dataset.from_tensors(x).repeat(6),
    cycle_length=2, block_length=4)
list(dataset.as_numpy_iterator())
[1, 1, 1, 1,
 2, 2, 2, 2,
 1, 1,
 2, 2,
 3, 3, 3, 3,
 4, 4, 4, 4,
 3, 3,
 4, 4,
 5, 5, 5, 5,
 5, 5]
Примечание: Порядок элементов, возвращаемых этим преобразованием, детерминированный, при условии, что map_func является чистой функцией и deterministic=True. Если map_func содержит какие-либо состоятельные операции, порядок доступа к состоянию не определен.

Производительность часто можно улучшить, установив num_parallel_calls, чтобы interleave использовало несколько потоков для извлечения элементов. Если детерминизм не требуется, производительность также можно улучшить, установив deterministic=False.

filenames = ["/var/data/file1.txt", "/var/data/file2.txt",
             "/var/data/file3.txt", "/var/data/file4.txt"]
dataset = tf.data.Dataset.from_tensor_slices(filenames)
dataset = dataset.interleave(lambda x: tf.data.TFRecordDataset(x),
    cycle_length=4, num_parallel_calls=tf.data.AUTOTUNE,
    deterministic=False)
Аргументы
map_func Функция, которая принимает элемент набора данных и возвращает tf.data.Dataset.
cycle_length (Необязательно.) Количество входных элементов, которые будут обрабатываться параллельно. Если не указано, среда выполнения tf.data сама определяет это значение на основе доступных ресурсов процессора. Если num_parallel_calls установлено в tf.data.AUTOTUNE, аргумент cycle_length определяет максимальную степень параллелизма.
block_length (Необязательно.) Количество последовательных элементов, которые должны быть сгенерированы из каждого входного элемента перед переходом к следующему входному элементу. Если не указано, по умолчанию равно 1.
num_parallel_calls (Необязательно.) Если указано, реализация создаёт пул потоков, который используется для асинхронного и параллельного извлечения входных данных из циклических элементов. По умолчанию входные данные из циклических элементов извлекаются синхронно без параллелизма. Если используется значение tf.data.AUTOTUNE, то количество параллельных вызовов устанавливается динамически на основе доступных ресурсов процессора.
deterministic (Необязательно.) Когда num_parallel_calls указано, если указан этот булевый параметр (True или False), он управляет порядком, в котором преобразование генерирует элементы. Если установлено в False, преобразование допускается генерировать элементы вне порядка, чтобы обменять детерминизм на производительность. Если не указано, поведение контролируется параметром tf.data.Options.deterministic (по умолчанию True).
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Dataset Dataset.

list_files

Просмотреть исходный код

@staticmethod
list_files(
    file_pattern, shuffle=None, seed=None, name=None
)

Набор данных всех файлов, соответствующих одному или нескольким шаблонам glob.

Аргумент file_pattern должен содержать небольшое количество шаблонов glob. Если имена файлов уже обработаны с помощью glob, используйте Dataset.from_tensor_slices(filenames) вместо этого, так как повторная обработка каждого имени файла с помощью list_files может привести к низкой производительности с удалёнными системами хранения.

Примечание: По умолчанию этот метод возвращает имена файлов в случайном, не детерминированном порядке. Передайте seed или shuffle=False для получения результатов в детерминированном порядке.

Пример:

Если на файловой системе имеются следующие файлы:

  • /path/to/dir/a.txt
  • /path/to/dir/b.py
  • /path/to/dir/c.py

Если в качестве директории передать "/path/to/dir/*.py", набор данных вернёт:

  • /path/to/dir/b.py
  • /path/to/dir/c.py
Аргументы
file_pattern Строка, список строк или tf.Tensor типа строка (скаляр или вектор), представляющая шаблон(ы) имени файла glob (т. е. шаблон командной строки), который будет сопоставлен.
shuffle (Необязательно.) Если True, имена файлов будут перемешаны случайным образом. По умолчанию True.
seed (Необязательно.) Скаляр tf.int64 tf.Tensor, представляющий случайное семя, которое будет использоваться для создания распределения. См. tf.random.set_seed для поведения.
name (Необязательно.) Имя операций tf.data, используемых list_files.
Возвращаемые значения
Dataset Dataset строк, соответствующих именам файлов.

make_initializable_iterator

Просмотреть исходный код

make_initializable_iterator(
    shared_name=None
)

Создаёт итератор для элементов этого набора данных. (устаревшая функция)

Устаревшая функция: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Эта устаревшая API должна использоваться только в графическом режиме TF 1 и графическом режиме устаревшего TF 2, доступном через tf.compat.v1. Во всех других ситуациях — в частности, режиме eager и внутри tf.function — вы можете потреблять элементы набора данных с помощью for elem in dataset: ... или создавая итератор явно через iterator = iter(dataset) и получая его элементы через values = next(iterator). Кроме того, эта API недоступна в TF 2. Во время перехода с TF 1 на TF 2 вы можете использовать tf.compat.v1.data.make_initializable_iterator(dataset) для создания итератора в стиле графического режима TF 1 для набора данных, созданного с помощью API TF 2. Обратите внимание, что это должно быть временное состояние вашего кода, так как нет никаких гарантий по взаимозаменяемости кода TF 1 и TF 2.
Примечание: Возвращённый итератор будет в неинициализированном состоянии, и вам необходимо выполнить операцию iterator.initializer перед его использованием:
# Building graph ...
dataset = ...
iterator = dataset.make_initializable_iterator()
next_value = iterator.get_next()  # This is a Tensor.

# ... from within a session ...
sess.run(iterator.initializer)
try:
  while True:
    value = sess.run(next_value)
    ...
except tf.errors.OutOfRangeError:
    pass
Аргументы
shared_name (Необязательно.) Если не пусто, возвращаемый итератор будет совместно использоваться под данным именем в нескольких сессиях, которые используют одни и те же устройства (например, при использовании удалённого сервера).
Возвращаемые значения
tf.data.Iterator для элементов этого набора данных.
Исключения
RuntimeError Если включён режим eager execution.

make_one_shot_iterator

Просмотреть исходный код

make_one_shot_iterator()

Создаёт итератор для элементов этого набора данных. (устаревшая функция)

Устаревшая функция: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Эта устаревшая API должна использоваться только в графическом режиме TF 1 и графическом режиме устаревшего TF 2, доступном через tf.compat.v1. Во всех других ситуациях — в частности, режиме eager и внутри tf.function — вы можете потреблять элементы набора данных с помощью for elem in dataset: ... или создавая итератор явно через iterator = iter(dataset) и получая его элементы через values = next(iterator). Кроме того, эта API недоступна в TF 2. Во время перехода с TF 1 на TF 2 вы можете использовать tf.compat.v1.data.make_one_shot_iterator(dataset) для создания итератора в стиле графического режима TF 1 для набора данных, созданного с помощью API TF 2. Обратите внимание, что это должно быть временное состояние вашего кода, так как нет никаких гарантий по взаимозаменяемости кода TF 1 и TF 2.
Примечание: Возвращённый итератор будет инициализирован автоматически. Итератор «one-shot» в настоящее время не поддерживает повторную инициализацию. Для этого см. make_initializable_iterator.

Пример:

# Building graph ...
dataset = ...
next_value = dataset.make_one_shot_iterator().get_next()

# ... from within a session ...
try:
  while True:
    value = sess.run(next_value)
    ...
except tf.errors.OutOfRangeError:
    pass
Возвращаемые значения
tf.data.Iterator для элементов этого набора данных.

map

Просмотреть исходный код

map(
    map_func, num_parallel_calls=None, deterministic=None, name=None
)

Применяет map_func к элементам этого набора данных.

Это преобразование применяет map_func к каждому элементу этого набора данных и возвращает новый набор данных, содержащий преобразованные элементы в том же порядке, что и в исходном наборе. map_func можно использовать для изменения как значений, так и структуры элементов набора данных. Поддерживаемые структуры элементов документированы здесь.

Например, map_func можно использовать для добавления 1 к каждому элементу или для проекции подмножества компонентов элемента.

dataset = Dataset.range(1, 6)  # ==> [ 1, 2, 3, 4, 5 ]
dataset = dataset.map(lambda x: x + 1)
list(dataset.as_numpy_iterator())
[2, 3, 4, 5, 6]

Подпись входных данных для map_func определяется структурой каждого элемента в этом наборе данных.

dataset = Dataset.range(5)
# `map_func` takes a single argument of type `tf.Tensor` with the same
# shape and dtype.
result = dataset.map(lambda x: x + 1)
# Each element is a tuple containing two `tf.Tensor` objects.
elements = [(1, "foo"), (2, "bar"), (3, "baz")]
dataset = tf.data.Dataset.from_generator(
    lambda: elements, (tf.int32, tf.string))
# `map_func` takes two arguments of type `tf.Tensor`. This function
# projects out just the first component.
result = dataset.map(lambda x_int, y_str: x_int)
list(result.as_numpy_iterator())
[1, 2, 3]
# Each element is a dictionary mapping strings to `tf.Tensor` objects.
elements =  ([{"a": 1, "b": "foo"},
              {"a": 2, "b": "bar"},
              {"a": 3, "b": "baz"}])
dataset = tf.data.Dataset.from_generator(
    lambda: elements, {"a": tf.int32, "b": tf.string})
# `map_func` takes a single argument of type `dict` with the same keys
# as the elements.
result = dataset.map(lambda d: str(d["a"]) + d["b"])

Возвращаемое значение или значения map_func определяют структуру каждого элемента в возвращаемом наборе данных.

dataset = tf.data.Dataset.range(3)
# `map_func` returns two `tf.Tensor` objects.
def g(x):
  return tf.constant(37.0), tf.constant(["Foo", "Bar", "Baz"])
result = dataset.map(g)
result.element_spec
(TensorSpec(shape=(), dtype=tf.float32, name=None), TensorSpec(shape=(3,), dtype=tf.string, name=None))
# Python primitives, lists, and NumPy arrays are implicitly converted to
# `tf.Tensor`.
def h(x):
  return 37.0, ["Foo", "Bar"], np.array([1.0, 2.0], dtype=np.float64)
result = dataset.map(h)
result.element_spec
(TensorSpec(shape=(), dtype=tf.float32, name=None), TensorSpec(shape=(2,), dtype=tf.string, name=None), TensorSpec(shape=(2,), dtype=tf.float64, name=None))
# `map_func` can return nested structures.
def i(x):
  return (37.0, [42, 16]), "foo"
result = dataset.map(i)
result.element_spec
((TensorSpec(shape=(), dtype=tf.float32, name=None),
  TensorSpec(shape=(2,), dtype=tf.int32, name=None)),
 TensorSpec(shape=(), dtype=tf.string, name=None))

map_func может принимать в качестве аргументов и возвращать любой тип элемента набора данных.

Обратите внимание, что независимо от контекста, в котором map_func определён (eager или graph), tf.data отслеживает функцию и выполняет её как граф. Для использования кода Python внутри функции у вас есть несколько вариантов:

1) Используйте AutoGraph для преобразования кода Python в эквивалентное вычисление графа. Недостатком этого подхода является то, что AutoGraph может преобразовать некоторые, но не все фрагменты кода Python.

2) Используйте tf.py_function, что позволяет писать произвольный код Python, но, как правило, приводит к худшей производительности, чем 1). Например:

d = tf.data.Dataset.from_tensor_slices(['hello', 'world'])
# transform a string tensor to upper case string using a Python function
def upper_case_fn(t: tf.Tensor):
  return t.numpy().decode('utf-8').upper()
d = d.map(lambda x: tf.py_function(func=upper_case_fn,
          inp=[x], Tout=tf.string))
list(d.as_numpy_iterator())
[b'HELLO', b'WORLD']

3) Используйте tf.numpy_function, что также позволяет писать произвольный код Python. Обратите внимание, что tf.py_function принимает tf.Tensor, в то время как tf.numpy_function принимает массивы NumPy и возвращает только массивы NumPy. Например:

d = tf.data.Dataset.from_tensor_slices(['hello', 'world'])
def upper_case_fn(t: np.ndarray):
  return t.decode('utf-8').upper()
d = d.map(lambda x: tf.numpy_function(func=upper_case_fn,
          inp=[x], Tout=tf.string))
list(d.as_numpy_iterator())
[b'HELLO', b'WORLD']

Обратите внимание, что использование tf.numpy_function и tf.py_function в общем случае исключает возможность выполнения пользовательских преобразований параллельно (из-за блокировки Python GIL).

Производительность часто можно улучшить, установив num_parallel_calls таким образом, чтобы map использовало несколько потоков для обработки элементов. Если порядок не требуется, производительность также можно повысить, установив deterministic=False.

dataset = Dataset.range(1, 6)  # ==> [ 1, 2, 3, 4, 5 ]
dataset = dataset.map(lambda x: x + 1,
    num_parallel_calls=tf.data.AUTOTUNE,
    deterministic=False)

Порядок элементов, возвращаемых этим преобразованием, является детерминированным, если deterministic=True. Если map_func содержит операции с состоянием и num_parallel_calls > 1, порядок доступа к этому состоянию не определен, поэтому значения выходных элементов могут быть не детерминированными независимо от значения флага deterministic.

Аргументы
map_func Функция, сопоставляющая элемент набора данных с другим элементом набора данных.
num_parallel_calls (Необязательно.) Скалярное tf.int64 значение tf.Tensor, представляющее количество элементов для асинхронной параллельной обработки. Если не указано, элементы будут обрабатываться последовательно. Если используется значение tf.data.AUTOTUNE, то количество параллельных вызовов устанавливается динамически в зависимости от доступных ЦП.
deterministic (Необязательно.) Если указано num_parallel_calls, и этот булевый параметр указан (True или False), он контролирует порядок, в котором преобразование генерирует элементы. Если установлено значение False, преобразование разрешается выдавать элементы вне порядка, чтобы поменять детерминизм на производительность. Если не указано, поведение контролируется параметром tf.data.Options.deterministic (по умолчанию True).
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.

map_with_legacy_function

Просмотреть исходный код

map_with_legacy_function(
    map_func, num_parallel_calls=None, deterministic=None
)

Применяет map_func к элементам этого набора данных. (устаревший)

Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Используйте `tf.data.Dataset.map()
Примечание: Это временное решение для существующих случаев использования map , которые не работают с функциями V2. Новые случаи использования настоятельно не рекомендуются, и существующие случаи использования должны быть перенесены в map, так как этот метод будет удалён в V2.
Аргументы
map_func Функция, сопоставляющая (вложенную) структуру тензоров (с формами и типами, определёнными self.output_shapes и self.output_types ) с другой (вложенной) структурой тензоров.
num_parallel_calls (Необязательно.) Скалярное tf.int32 значение tf.Tensor, представляющее количество элементов для асинхронной параллельной обработки. Если не указано, элементы будут обрабатываться последовательно. Если используется значение tf.data.AUTOTUNE, то количество параллельных вызовов устанавливается динамически в зависимости от доступных ЦП.
deterministic (Необязательно.) Когда num_parallel_calls указано, этот булевый параметр контролирует порядок, в котором преобразование генерирует элементы. Если установлено значение False, преобразование разрешается выдавать элементы вне порядка, чтобы поменять детерминизм на производительность. Если не указано, поведение контролируется параметром tf.data.Options.deterministic (по умолчанию True).
Возвращаемое значение
Dataset A Dataset.

options

Просмотреть исходный код

options()

Возвращает параметры этого набора данных и его входных данных.

Возвращаемое значение
Объект tf.data.Options, представляющий параметры набора данных.

padded_batch

Просмотреть исходный код

padded_batch(
    batch_size,
    padded_shapes=None,
    padding_values=None,
    drop_remainder=False,
    name=None
)

Объединяет последовательные элементы этого набора данных в заполненные пакеты.

Это преобразование объединяет несколько последовательных элементов входного набора данных в один элемент.

Как и tf.data.Dataset.batch, компоненты результирующего элемента будут иметь дополнительное внешнее измерение, которое будет batch_size (или N % batch_size для последнего элемента, если batch_size не делит количество входных элементов N равномерно и drop_remainder имеет значение False). Если ваша программа зависит от того, чтобы пакеты имели одинаковое внешнее измерение, вы должны установить аргумент drop_remainder в значение True , чтобы предотвратить создание меньшего пакета.

В отличие от tf.data.Dataset.batch, входные элементы для пакетной обработки могут иметь разные формы, и это преобразование заполнит каждый компонент до соответствующей формы в padded_shapes. Аргумент padded_shapes определяет результирующую форму для каждого измерения каждого компонента в выходном элементе:

  • Если измерение является константой, компонент будет заполнен до этого значения в этом измерении.
  • Если измерение неизвестно, компонент будет заполнен до максимальной длины во всех элементах в этом измерении.
A = (tf.data.Dataset
     .range(1, 5, output_type=tf.int32)
     .map(lambda x: tf.fill([x], x)))
# Pad to the smallest per-batch size that fits all elements.
B = A.padded_batch(2)
for element in B.as_numpy_iterator():
  print(element)
[[1 0]
 [2 2]]
[[3 3 3 0]
 [4 4 4 4]]
# Pad to a fixed size.
C = A.padded_batch(2, padded_shapes=5)
for element in C.as_numpy_iterator():
  print(element)
[[1 0 0 0 0]
 [2 2 0 0 0]]
[[3 3 3 0 0]
 [4 4 4 4 0]]
# Pad with a custom value.
D = A.padded_batch(2, padded_shapes=5, padding_values=-1)
for element in D.as_numpy_iterator():
  print(element)
[[ 1 -1 -1 -1 -1]
 [ 2  2 -1 -1 -1]]
[[ 3  3  3 -1 -1]
 [ 4  4  4  4 -1]]
# Components of nested elements can be padded independently.
elements = [([1, 2, 3], [10]),
            ([4, 5], [11, 12])]
dataset = tf.data.Dataset.from_generator(
    lambda: iter(elements), (tf.int32, tf.int32))
# Pad the first component of the tuple to length 4, and the second
# component to the smallest size that fits.
dataset = dataset.padded_batch(2,
    padded_shapes=([4], [None]),
    padding_values=(-1, 100))
list(dataset.as_numpy_iterator())
[(array([[ 1,  2,  3, -1], [ 4,  5, -1, -1]], dtype=int32),
  array([[ 10, 100], [ 11,  12]], dtype=int32))]
# Pad with a single value and multiple components.
E = tf.data.Dataset.zip((A, A)).padded_batch(2, padding_values=-1)
for element in E.as_numpy_iterator():
  print(element)
(array([[ 1, -1],
       [ 2,  2]], dtype=int32), array([[ 1, -1],
       [ 2,  2]], dtype=int32))
(array([[ 3,  3,  3, -1],
       [ 4,  4,  4,  4]], dtype=int32), array([[ 3,  3,  3, -1],
       [ 4,  4,  4,  4]], dtype=int32))

См. также tf.data.experimental.dense_to_sparse_batch, который объединяет элементы, которые могут иметь разные формы, в tf.sparse.SparseTensor.

Аргументы
batch_size Скалярное tf.int64 значение tf.Tensor, представляющее количество последовательных элементов этого набора данных, которые объединяются в один пакет.
padded_shapes (Необязательно.) (Вложенная) структура объектов tf.TensorShape или tf.int64 векторов, представляющих форму, до которой должен быть дополнен соответствующий компонент каждого входного элемента перед пакетной обработкой. Любые неизвестные измерения будут заполнены до максимального размера этого измерения в каждом пакете. padded_shapes должно быть установлено, если у любого компонента неизвестный ранг.
padding_values (Необязательно.) (Вложенная) структура скалярных tf.Tensor, представляющих значения заполнения для соответствующих компонентов. None обозначает, что (вложенная) структура должна быть заполнена значениями по умолчанию. По умолчанию 0 для числовых типов и пустая строка для строковых типов. padding_values должна иметь ту же (вложенную) структуру, что и входной набор данных. Если padding_values содержит один элемент, а входной набор данных имеет несколько компонентов, то то же самое padding_values будет использоваться для заполнения каждого компонента набора данных. Если padding_values является скаляром, то его значение будет транслировано для соответствия форме каждого компонента.
drop_remainder (Необязательно.) Скалярное tf.bool значение tf.Tensor, указывающее, должен ли последний пакет быть отброшен в случае, если он содержит меньше batch_size элементов; поведение по умолчанию – не отбрасывать меньший пакет.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.
Исключения
ValueError Если у компонента неизвестный ранг, и аргумент padded_shapes не задан.
TypeError Если компонент имеет неподдерживаемый тип. Список поддерживаемых типов документирован в https://www.tensorflow.org/guide/data#dataset_structure

prefetch

Просмотреть исходный код

prefetch(
    buffer_size, name=None
)

Создаёт Dataset для предварительной выборки элементов из этого набора данных.

Большинство конвейеров ввода данных набора данных должны завершаться вызовом prefetch. Это позволяет подготавливать последующие элементы во время обработки текущего элемента. Это часто повышает задержку и пропускную способность, но требует дополнительной памяти для хранения предварительно выбранных элементов.

Примечание: Как и другие методы Dataset, prefetch работает с элементами входного набора данных. Он не имеет понятия об примерах против пакетов. examples.prefetch(2) будет предварительно выбирать два элемента (2 примера), в то время как examples.batch(20).prefetch(2) предварительно выберет 2 элемента (2 пакета по 20 примеров каждый).
dataset = tf.data.Dataset.range(3)
dataset = dataset.prefetch(2)
list(dataset.as_numpy_iterator())
[0, 1, 2]
Аргументы
buffer_size Скалярное значение типа tf.int64 tf.Tensor, представляющее максимальное количество элементов, которые будут буферизованы при предварительной выборке. Если используется значение tf.data.AUTOTUNE, размер буфера настраивается динамически.
name Необязательно. Название преобразования tf.data.
Возвращаемое значение
Dataset Объект Dataset.

random

Просмотреть исходный код

@staticmethod
random(
    seed=None, name=None
)

Создаёт набор Dataset псевдослучайных значений.

Набор генерирует последовательность целых значений, равномерно распределённых.

ds1 = tf.data.Dataset.random(seed=4).take(10)
ds2 = tf.data.Dataset.random(seed=4).take(10)
print(list(ds2.as_numpy_iterator())==list(ds2.as_numpy_iterator()))
True
Аргументы
seed (Необязательно) Если задано, набор создаёт детерминированную последовательность значений.
name (Необязательно.) Название операции tf.data.
Возвращаемое значение
Dataset Объект Dataset.

range

Просмотреть исходный код

@staticmethod
range(
    *args, **kwargs
)

Создаёт набор Dataset последовательных значений с заданным шагом.

list(Dataset.range(5).as_numpy_iterator())
[0, 1, 2, 3, 4]
list(Dataset.range(2, 5).as_numpy_iterator())
[2, 3, 4]
list(Dataset.range(1, 5, 2).as_numpy_iterator())
[1, 3]
list(Dataset.range(1, 5, -2).as_numpy_iterator())
[]
list(Dataset.range(5, 1).as_numpy_iterator())
[]
list(Dataset.range(5, 1, -2).as_numpy_iterator())
[5, 3]
list(Dataset.range(2, 5, output_type=tf.int32).as_numpy_iterator())
[2, 3, 4]
list(Dataset.range(1, 5, 2, output_type=tf.float32).as_numpy_iterator())
[1.0, 3.0]
Аргументы
*args соответствует семантике python's range. len(args) == 1 -> start = 0, stop = args[0], step = 1. len(args) == 2 -> start = args[0], stop = args[1], step = 1. len(args) == 3 -> start = args[0], stop = args[1], step = args[2].
**kwargs
  • output_type: ожидаемый тип данных. (Необязательно, по умолчанию: tf.int64).
  • name: (Необязательно.) Название операции tf.data.
Возвращаемое значение
Dataset Объект RangeDataset.
Исключения
ValueError если len(args) == 0.

reduce

Просмотреть исходный код

reduce(
    initial_state, reduce_func, name=None
)

Приводит набор данных к одному элементу.

Преобразование вычисляет reduce_func последовательно для каждого элемента входного набора данных до исчерпания набора, агрегируя информацию во внутренней переменной. Аргумент initial_state используется для начального состояния, а конечное состояние возвращается в качестве результата.

tf.data.Dataset.range(5).reduce(np.int64(0), lambda x, _: x + 1).numpy()
5
tf.data.Dataset.range(5).reduce(np.int64(0), lambda x, y: x + y).numpy()
10
Аргументы
initial_state Элемент, представляющий начальное состояние преобразования.
reduce_func Функция, которая отображает (old_state, input_element) на new_state. Она должна принимать два аргумента и возвращать новый элемент. Структура new_state должна соответствовать структуре initial_state.
name (Необязательно.) Название операции tf.data.
Возвращаемое значение
Элемент набора данных, соответствующий конечному состоянию преобразования.

rejection_resample

Просмотреть исходный код

rejection_resample(
    class_func, target_dist, initial_dist=None, seed=None, name=None
)

Преобразование, перевыборка набора данных в соответствии с целевым распределением.

Рассмотрим пример, где набор данных с начальным распределением init_dist должен быть перевыбран в набор данных с распределением target_dist.

initial_dist = [0.6, 0.4]
num_classes = len(initial_dist)
num_samples = 1000
data_np = np.random.choice(num_classes, num_samples, p=initial_dist)
dataset = tf.data.Dataset.from_tensor_slices(data_np)

Значение x будет близко к {0: 50000, 1: 50000} в соответствии с распределением initial_dist.

target_dist = [0.5, 0.5]
resampled_dataset = dataset.rejection_resample(
   class_func=lambda x: x,
   target_dist=target_dist,
   initial_dist=initial_dist)
resampled_dataset = resampled_dataset.map(
    lambda class_func_result, data: data)

Распределение значений классов в перевыбранном распределении теперь будет близко к целевому распределению.

Аргументы
class_func Функция, отображающая элемент входного набора данных в скалярный тензор tf.int32. Значения должны быть в [0, num_classes).
target_dist Тензор с плавающей точкой, формы [num_classes].
initial_dist (Необязательно.) Тензор с плавающей точкой, формы [num_classes]. Если не указано, истинное распределение классов оценивается в потоковом режиме.
seed (Необязательно.) Целое число Python, используемое в качестве начального значения для перевыборки.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Объект Dataset.

repeat

Просмотреть исходный код

repeat(
    count=None, name=None
)

Повторяет этот набор данных, чтобы каждое исходное значение отображалось count раз.

dataset = tf.data.Dataset.from_tensor_slices([1, 2, 3])
dataset = dataset.repeat(3)
list(dataset.as_numpy_iterator())
[1, 2, 3, 1, 2, 3, 1, 2, 3]
Примечание: Если входной набор данных зависит от глобального состояния (например, генератора случайных чисел) или его выходные данные не детерминированы (например, из-за shuffle), то разные повторения могут генерировать разные элементы.
Аргументы
count (Необязательно.) Скалярное значение типа tf.int64 tf.Tensor, представляющее количество повторений набора данных. По умолчанию (если count равно None или -1) набор данных повторяется бесконечно.
name (Необязательно.) Название операции tf.data.
Возвращаемое значение
Dataset Объект Dataset.

sample_from_datasets

Просмотреть исходный код

@staticmethod
sample_from_datasets(
    datasets, weights=None, seed=None, stop_on_empty_dataset=False
)

Выбирает элементы случайным образом из наборов данных в datasets.

Создаёт набор данных, интерполируя элементы datasets с вероятностью weight[i] выбора элемента из набора данных i. Выборка происходит без повторения. Например, предположим, что у нас есть 2 набора данных:

dataset1 = tf.data.Dataset.range(0, 3)
dataset2 = tf.data.Dataset.range(100, 103)

Предположим, что мы выбираем из этих 2 наборов данных со следующими весами:

sample_dataset = tf.data.Dataset.sample_from_datasets(
    [dataset1, dataset2], weights=[0.5, 0.5])

Возможный результат элементов в sample_dataset:

print(list(sample_dataset.as_numpy_iterator()))
# [100, 0, 1, 101, 2, 102]
Аргументы
datasets Непустой список объектов tf.data.Dataset с совместимой структурой.
weights (Необязательно.) Список или тензор len(datasets) чисел с плавающей точкой, где weights[i] представляет вероятность выборки из datasets[i], или объект tf.data.Dataset, где каждый элемент является таким списком. По умолчанию используется равномерное распределение по datasets.
seed (Необязательно.) Скалярное значение типа tf.int64 tf.Tensor, представляющее начальное значение для генерации случайных чисел. Смотрите tf.random.set_seed для получения дополнительных сведений.
stop_on_empty_dataset Если True, выборка прекращается, если она встречает пустой набор данных. Если False, она пропускает пустые наборы данных. Рекомендуется установить это значение в True. В противном случае распределение выборок начинается как планируется, но может измениться, когда входные наборы данных опустеют. Это может быть трудно обнаружить, поскольку набор данных на первый взгляд выглядит корректно. По умолчанию False для обратной совместимости.
Возвращаемое значение
Набор данных, интерполирующий элементы из datasets случайным образом в соответствии с weights (если указано), иначе с равномерной вероятностью.
Исключения
TypeError Если аргументы datasets или weights имеют неправильный тип.
ValueError
  • Если datasets пустой, или
  • Если weights задано и не соответствует длине datasets.

scan

Просмотреть исходный код

scan(
    initial_state, scan_func, name=None
)

Преобразование, которое применяет функцию к входному набору данных.

Это преобразование является состоятельным аналогом tf.data.Dataset.map. В дополнение к применению scan_func к элементам входного набора данных, scan() накапливает один или несколько тензоров состояния, начальные значения которых initial_state.

dataset = tf.data.Dataset.range(10)
initial_state = tf.constant(0, dtype=tf.int64)
scan_func = lambda state, i: (state + i, state + i)
dataset = dataset.scan(initial_state=initial_state, scan_func=scan_func)
list(dataset.as_numpy_iterator())
[0, 1, 3, 6, 10, 15, 21, 28, 36, 45]
Аргументы
initial_state Вложенная структура тензоров, представляющая начальное состояние аккумулятора.
scan_func Функция, которая отображает (old_state, input_element) на (new_state, output_element). Она должна принимать два аргумента и возвращать пару вложенных структур тензоров. Структура new_state должна соответствовать структуре initial_state.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
A Dataset.

shard

Просмотреть исходный код

shard(
    num_shards, index, name=None
)

Создаёт набор данных, содержащий только 1/num_shards элементов исходного набора данных.

shard является детерминированным. Набор данных, созданный с помощью A.shard(n, i), будет содержать все элементы A, для которых индекс mod n = i.

A = tf.data.Dataset.range(10)
B = A.shard(num_shards=3, index=0)
list(B.as_numpy_iterator())
[0, 3, 6, 9]
C = A.shard(num_shards=3, index=1)
list(C.as_numpy_iterator())
[1, 4, 7]
D = A.shard(num_shards=3, index=2)
list(D.as_numpy_iterator())
[2, 5, 8]

Этот оператор набора данных очень полезен при распределённом обучении, так как он позволяет каждому процессу читать уникальный подмножество.

При чтении одного входного файла, можно разделить элементы следующим образом:

d = tf.data.TFRecordDataset(input_file)
d = d.shard(num_workers, worker_index)
d = d.repeat(num_epochs)
d = d.shuffle(shuffle_buffer_size)
d = d.map(parser_fn, num_parallel_calls=num_map_threads)

Важные замечания:

  • Убедитесь, что вы разделили набор данных до использования любого оператора случайного выбора (например, shuffle).
  • В общем случае лучше использовать оператор разделения на ранних стадиях обработки набора данных. Например, при чтении из набора файлов TFRecord, разделите набор данных перед преобразованием его в входные образцы. Это позволит избежать чтения каждого файла на каждом процессоре. Ниже приведён пример эффективной стратегии разделения в полной обработке набора данных:
d = Dataset.list_files(pattern)
d = d.shard(num_workers, worker_index)
d = d.repeat(num_epochs)
d = d.shuffle(shuffle_buffer_size)
d = d.interleave(tf.data.TFRecordDataset,
                 cycle_length=num_readers, block_length=1)
d = d.map(parser_fn, num_parallel_calls=num_map_threads)
Аргументы
num_shards Скалярное значение tf.int64 типа tf.Tensor, представляющее количество фрагментов, работающих параллельно.
index Скалярное значение tf.int64 типа tf.Tensor, представляющее индекс процесса.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.
Исключения
InvalidArgumentError если num_shards или index имеют недопустимые значения.
Примечание: проверка ошибок выполняется с наилучшим результатом, и ошибки не гарантируются при создании набора данных. (например, предоставление тензора-заполнителя обходит раннюю проверку и вместо этого приведёт к ошибке во время вызова session.run.)

shuffle

Просмотреть исходный код

shuffle(
    buffer_size, seed=None, reshuffle_each_iteration=None, name=None
)

Случайным образом перемешивает элементы этого набора данных.

Этот набор данных заполняет буфер buffer_size элементами, затем случайным образом выбирает элементы из этого буфера, заменяя выбранные элементы новыми элементами. Для идеального перемешивания требуется размер буфера, больший или равный полному размеру набора данных.

Например, если ваш набор данных содержит 10 000 элементов, но buffer_size установлено в 1000, тогда shuffle первоначально выберет случайный элемент только из первых 1000 элементов в буфере. После выбора элемента, его место в буфере заменяется следующим (т.е. 1001-м) элементом, сохраняя буфер из 1000 элементов.

reshuffle_each_iteration управляет тем, должен ли порядок перемешивания быть разным для каждой эпохи. В TF 1.X стандартным способом создания эпох было использование преобразования repeat.

dataset = tf.data.Dataset.range(3)
dataset = dataset.shuffle(3, reshuffle_each_iteration=True)
dataset = dataset.repeat(2)
# [1, 0, 2, 1, 2, 0]

dataset = tf.data.Dataset.range(3)
dataset = dataset.shuffle(3, reshuffle_each_iteration=False)
dataset = dataset.repeat(2)
# [1, 0, 2, 1, 0, 2]

В TF 2.0 объекты tf.data.Dataset являются итерируемыми объектами Python, что позволяет также создавать эпохи с помощью циклов Python:

dataset = tf.data.Dataset.range(3)
dataset = dataset.shuffle(3, reshuffle_each_iteration=True)
list(dataset.as_numpy_iterator())
# [1, 0, 2]
list(dataset.as_numpy_iterator())
# [1, 2, 0]
dataset = tf.data.Dataset.range(3)
dataset = dataset.shuffle(3, reshuffle_each_iteration=False)
list(dataset.as_numpy_iterator())
# [1, 0, 2]
list(dataset.as_numpy_iterator())
# [1, 0, 2]
Аргументы
buffer_size Скалярное значение tf.int64 типа tf.Tensor, представляющее количество элементов из этого набора данных, из которых новый набор данных будет выбирать.
seed (Необязательно.) Скалярное значение tf.int64 типа tf.Tensor, представляющее случайное семя, которое будет использоваться для создания распределения. Смотрите tf.random.set_seed для поведения.
reshuffle_each_iteration (Необязательно.) Булево значение, которое, если истинно, указывает, что набор данных должен быть псевдослучайно перемешан каждый раз при его итерировании. (По умолчанию True.)
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.

skip

Просмотреть исходный код

skip(
    count, name=None
)

Создаёт набор данных, пропускающий count элементов из этого набора данных.

dataset = tf.data.Dataset.range(10)
dataset = dataset.skip(7)
list(dataset.as_numpy_iterator())
[7, 8, 9]
Аргументы
count Скалярное значение tf.int64 типа tf.Tensor, представляющее количество элементов этого набора данных, которые должны быть пропущены для создания нового набора данных. Если count больше размера этого набора данных, новый набор данных не будет содержать элементов. Если count равно -1, пропускается весь набор данных.
name (Необязательно.) Имя операции tf.data.
Возвращаемое значение
Dataset A Dataset.

snapshot

Просмотреть исходный код

snapshot(
    path,
    compression='AUTO',
    reader_func=None,
    shard_func=None,
    name=None
)

API для сохранения выходных данных входного набора данных.

API snapshot позволяет пользователям прозрачно сохранять выходные данные своей предварительной обработки на диск и материализовать предварительно обработанные данные в другой обучающей сессии.

Этот API позволяет объединить несколько шагов предварительной обработки и повторно использовать уже обработанные данные, торгуя хранилищем на диске и пропускной способностью сети для освобождения большего количества ценных ресурсов процессора и вычислительных ресурсов ускорителей.

https://github.com/tensorflow/community/blob/master/rfcs/20200107-tf-data-snapshot.md содержит подробную документацию по проектированию этой функции.

Пользователи могут указать различные параметры для управления поведением snapshot, включая то, как snapshot читаются и записываются, передавая пользовательские функции в параметры reader_func и shard_func.

shard_func — это определяемая пользователем функция, которая отображает входные элементы на фрагменты snapshot.

Пользователи могут указать эту функцию для управления тем, как файлы snapshot записываются на диск. Ниже приведен пример, как можно записать потенциальную shard_func.

dataset = ...
dataset = dataset.enumerate()
dataset = dataset.snapshot("/path/to/snapshot/dir",
    shard_func=lambda x, y: x % NUM_SHARDS, ...)
dataset = dataset.map(lambda x, y: y)

reader_func — это определяемая пользователем функция, которая принимает один аргумент: (1) набор данных наборов данных, каждый из которых представляет «разделение» элементов исходного набора данных. Мощность входного набора данных соответствует количеству фрагментов, указанных в shard_func (см. выше). Функция должна вернуть набор данных элементов исходного набора данных.

Пользователи могут указать эту функцию для управления тем, как файлы snapshot читаются с диска, включая количество перемешивания и параллельности.

Вот пример стандартной функции чтения, которую может определить пользователь. Эта функция позволяет как перемешивать набор данных, так и читать наборы данных параллельно:

def user_reader_func(datasets):
  # shuffle the datasets splits
  datasets = datasets.shuffle(NUM_CORES)
  # read datasets in parallel and interleave their elements
  return datasets.interleave(lambda x: x, num_parallel_calls=AUTOTUNE)

dataset = dataset.snapshot("/path/to/snapshot/dir",
    reader_func=user_reader_func)

По умолчанию snapshot параллелизует чтение с количеством ядер, доступных в системе, но не пытается перемешать данные.

Аргументы
path Обязательно. Директория для хранения/загрузки snapshot.
compression Необязательно. Тип сжатия, применяемый к snapshot, записываемому на диск. Поддерживаемые варианты — GZIP, SNAPPY, AUTO или None. По умолчанию AUTO, который пытается выбрать подходящий алгоритм сжатия для набора данных.
reader_func Необязательно. Функция для управления чтением данных из фрагментов snapshot.
shard_func Необязательно. Функция для управления тем, как данные фрагментируются при записи snapshot.
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Объект Dataset.

take

Просмотреть исходный код

take(
    count, name=None
)

Создаёт объект Dataset с не более чем count элементами из этого набора данных.

dataset = tf.data.Dataset.range(10)
dataset = dataset.take(3)
list(dataset.as_numpy_iterator())
[0, 1, 2]
Аргументы
count Скалярный тензор tf.int64 типа tf.Tensor, представляющий количество элементов из этого набора данных, которые нужно взять для создания нового набора данных. Если count равно -1, или если count больше размера этого набора данных, новый набор данных будет содержать все элементы этого набора данных.
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Dataset Объект Dataset.

take_while

Просмотреть исходный код

take_while(
    predicate, name=None
)

Преобразование, останавливающее итерацию набора данных на основе predicate.

dataset = tf.data.Dataset.range(10)
dataset = dataset.take_while(lambda x: x < 5)
list(dataset.as_numpy_iterator())
[0, 1, 2, 3, 4]
Аргументы
predicate Функция, отображающая вложенную структуру тензоров (с формами и типами, определёнными self.output_shapes и self.output_types) в скалярный тензор типа tf.bool.
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Объект Dataset.

unbatch

Просмотреть исходный код

unbatch(
    name=None
)

Разделяет элементы набора данных на несколько элементов.

Например, если элементы набора данных имеют форму [B, a0, a1, ...], где B может меняться для каждого входного элемента, то для каждого элемента в наборе данных, набор данных unbatch будет содержать B последовательных элементов формы [a0, a1, ...].

elements = [ [1, 2, 3], [1, 2], [1, 2, 3, 4] ]
dataset = tf.data.Dataset.from_generator(lambda: elements, tf.int64)
dataset = dataset.unbatch()
list(dataset.as_numpy_iterator())
[1, 2, 3, 1, 2, 1, 2, 3, 4]
Примечание: unbatch требует копирования данных для разделения объединённого тензора на меньшие, не объединённые тензоры. При оптимизации производительности старайтесь избегать ненужного использования unbatch.
Аргументы
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Объект Dataset.

unique

Просмотреть исходный код

unique(
    name=None
)

Преобразование, отбрасывающее дубликаты элементов набора данных Dataset.

Используйте это преобразование для создания набора данных, содержащего по одному экземпляру каждого уникального элемента на входе. Например:

dataset = tf.data.Dataset.from_tensor_slices([1, 37, 2, 37, 2, 1])
dataset = dataset.unique()
sorted(list(dataset.as_numpy_iterator()))
[1, 2, 37]
Примечание: Это преобразование поддерживает только наборы данных, которые помещаются в память, и имеют элементы типа tf.int32, tf.int64 или tf.string.
Аргументы
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Объект Dataset.

window

Просмотреть исходный код

window(
    size, shift=None, stride=1, drop_remainder=False, name=None
)

Возвращает набор данных «окон».

Каждое «окно» — это набор данных, содержащий подмножество элементов входного набора данных. Это конечные наборы данных размером size (или возможно меньше, если нет достаточного количества входных элементов для заполнения окна и drop_remainder вычисляется как False).

Например:

dataset = tf.data.Dataset.range(7).window(3)
for window in dataset:
  print(window)
<...Dataset element_spec=TensorSpec(shape=(), dtype=tf.int64, name=None)>
<...Dataset element_spec=TensorSpec(shape=(), dtype=tf.int64, name=None)>
<...Dataset element_spec=TensorSpec(shape=(), dtype=tf.int64, name=None)>

Поскольку окна являются наборами данных, они могут быть итерированы:

for window in dataset:
  print([item.numpy() for item in window])
[0, 1, 2]
[3, 4, 5]
[6]

Сдвиг

Аргумент shift определяет количество входных элементов, которые необходимо сдвинуть между началом каждого окна. Если окна и элементы пронумерованы начиная с 0, первый элемент в окне k будет элементом k * shift входного набора данных. В частности, первый элемент первого окна всегда будет первым элементом входного набора данных.

dataset = tf.data.Dataset.range(7).window(3, shift=1,
                                          drop_remainder=True)
for window in dataset:
  print(list(window.as_numpy_iterator()))
[0, 1, 2]
[1, 2, 3]
[2, 3, 4]
[3, 4, 5]
[4, 5, 6]

Шаг

Аргумент stride определяет шаг между входными элементами в окне.

dataset = tf.data.Dataset.range(7).window(3, shift=1, stride=2,
                                          drop_remainder=True)
for window in dataset:
  print(list(window.as_numpy_iterator()))
[0, 2, 4]
[1, 3, 5]
[2, 4, 6]

Вложенные элементы

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

Подпись типа:

def window(
    self: Dataset[Nest[T]], ...
) -> Dataset[Nest[Dataset[T]]]

Применение window к набору данных кортежей даёт кортеж окон:

dataset = tf.data.Dataset.from_tensor_slices(([1, 2, 3, 4, 5],
                                              [6, 7, 8, 9, 10]))
dataset = dataset.window(2)
windows = next(iter(dataset))
windows
(<...Dataset element_spec=TensorSpec(shape=(), dtype=tf.int32, name=None)>,
 <...Dataset element_spec=TensorSpec(shape=(), dtype=tf.int32, name=None)>)
def to_numpy(ds):
  return list(ds.as_numpy_iterator())

for windows in dataset:
  print(to_numpy(windows[0]), to_numpy(windows[1]))
[1, 2] [6, 7]
[3, 4] [8, 9]
[5] [10]

Применение window к набору данных словарей даёт словарь окон:

dataset = tf.data.Dataset.from_tensor_slices({'a': [1, 2, 3],
                                              'b': [4, 5, 6],
                                              'c': [7, 8, 9]})
dataset = dataset.window(2)
def to_numpy(ds):
  return list(ds.as_numpy_iterator())

for windows in dataset:
  print(tf.nest.map_structure(to_numpy, windows))
{'a': [1, 2], 'b': [4, 5], 'c': [7, 8]}
{'a': [3], 'b': [6], 'c': [9]}

Разворачивание набора данных окон

Методы Dataset.flat_map и Dataset.interleave могут быть использованы для разворачивания набора данных окон в один набор данных.

Аргумент для flat_map — это функция, которая берёт элемент из набора данных и возвращает набор данных. flat_map последовательно объединяет получившиеся наборы данных.

Например, чтобы преобразовать каждое окно в плотный тензор:

size = 3
dataset = tf.data.Dataset.range(7).window(size, shift=1,
                                          drop_remainder=True)
batched = dataset.flat_map(lambda x:x.batch(3))
for batch in batched:
  print(batch.numpy())
[0 1 2]
[1 2 3]
[2 3 4]
[3 4 5]
[4 5 6]
Аргументы
size Скалярный тензор tf.int64 типа tf.Tensor, представляющий количество элементов входного набора данных для объединения в окно. Должно быть положительным.
shift (Необязательно.) Скалярный тензор tf.int64 типа tf.Tensor, представляющий количество входных элементов, на которые сдвигается окно в каждой итерации. По умолчанию size. Должно быть положительным.
stride (Необязательно.) Скалярный тензор tf.int64 типа tf.Tensor, представляющий шаг входных элементов в скользящем окне. Значение по умолчанию 1 означает «сохранять каждый входной элемент».
drop_remainder (Необязательно.) Скалярный тензор типа tf.bool tf.Tensor, указывающий, нужно ли отбрасывать последние окна, если их размер меньше size.
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Dataset Набор данных (вложенных) окон. Каждое окно — это конечный набор данных плоских элементов.

with_options

Просмотреть исходный код

with_options(
    options, name=None
)

Возвращает новый набор данных tf.data.Dataset с заданными параметрами.

Параметры «глобальны» в том смысле, что они применяются ко всему набору данных. Если параметры задаются несколько раз, они объединяются, при условии что различные параметры не используют разные значения, отличные от значений по умолчанию.

ds = tf.data.Dataset.range(5)
ds = ds.interleave(lambda x: tf.data.Dataset.range(5),
                   cycle_length=3,
                   num_parallel_calls=3)
options = tf.data.Options()
# This will make the interleave order non-deterministic.
options.deterministic = False
ds = ds.with_options(options)
Аргументы
options Объект tf.data.Options, определяющий используемые параметры.
name (Необязательно.) Имя операции tf.data.
Возвращаемые значения
Dataset Набор данных Dataset с заданными параметрами.
Исключения
ValueError когда параметр задаётся более одного раза с нестандартным значением

zip

Просмотр исходного кода

@staticmethod
zip(
    datasets, name=None
)

Создаёт Dataset, объединяя заданные наборы данных.

Этот метод имеет сходные семантику со встроенной функцией zip() в Python, основное отличие заключается в том, что аргумент datasets может быть (вложенной) структурой Dataset объектов. Поддерживаемые механизмы вложения документированы здесь.

# The nested structure of the `datasets` argument determines the
# structure of elements in the resulting dataset.
a = tf.data.Dataset.range(1, 4)  # ==> [ 1, 2, 3 ]
b = tf.data.Dataset.range(4, 7)  # ==> [ 4, 5, 6 ]
ds = tf.data.Dataset.zip((a, b))
list(ds.as_numpy_iterator())
[(1, 4), (2, 5), (3, 6)]
ds = tf.data.Dataset.zip((b, a))
list(ds.as_numpy_iterator())
[(4, 1), (5, 2), (6, 3)]

# The `datasets` argument may contain an arbitrary number of datasets.
c = tf.data.Dataset.range(7, 13).batch(2)  # ==> [ [7, 8],
                                           #       [9, 10],
                                           #       [11, 12] ]
ds = tf.data.Dataset.zip((a, b, c))
for element in ds.as_numpy_iterator():
  print(element)
(1, 4, array([7, 8]))
(2, 5, array([ 9, 10]))
(3, 6, array([11, 12]))

# The number of elements in the resulting dataset is the same as
# the size of the smallest dataset in `datasets`.
d = tf.data.Dataset.range(13, 15)  # ==> [ 13, 14 ]
ds = tf.data.Dataset.zip((a, d))
list(ds.as_numpy_iterator())
[(1, 13), (2, 14)]
Аргументы
datasets (Вложенная) структура наборов данных.
name (Необязательно.) Имя операции tf.data.
Возвращает
Dataset Dataset.

__bool__

Просмотр исходного кода

__bool__()

__iter__

Просмотр исходного кода

__iter__()

Создаёт итератор для элементов этого набора данных.

Возвращаемый итератор реализует протокол Python Iterator.

Возвращает
tf.data.Iterator для элементов этого набора данных.
Возможные исключения
RuntimeError Если не внутри tf.function и выполнение не происходит в режиме Eager.

__len__

Просмотр исходного кода

__len__()

Возвращает длину набора данных, если она известна и конечна.

Этот метод требует, чтобы вы выполняли код в режиме Eager, и что длина набора данных известна и не бесконечна. Если длина неизвестна или бесконечна, или если вы выполняете код в режиме графа, используйте tf.data.Dataset.cardinality вместо этого.

Возвращает
Целое число, представляющее длину набора данных.
Возможные исключения
RuntimeError Если длина набора данных неизвестна или бесконечна, или если выполнение в режиме Eager отключено.

__nonzero__

Просмотр исходного кода

__nonzero__()

© 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/versions/r2.9/api_docs/python/tf/compat/v1/data/TextLineDataset

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API