Method write

tensorflow_datasets/core/writer.py:367–378

Writes given example. The given example is not directly written to the shard, but to a temporary file (or memory). The finalize() method writes all the shards. Args: key (int|bytes): the key associated with the example. Used for shuffling. example: the Example to write to t

(self, key: int | bytes, example: Example)

    self._example_writer = example_writer

  def write(self, key: int | bytes, example: Example):
    """Writes given example.

    The given example is not directly written to the shard, but to a
    temporary file (or memory). The finalize() method writes all the shards.

    Args:
      key (int|bytes): the key associated with the example. Used for shuffling.
      example: the Example to write to the shard.
    """
    serialized_example = self._serializer.serialize_example(example=example)
    self._shuffler.add(key, serialized_example)

  def finalize(self) -> tuple[list[int], int]:
    """Effectively writes examples to the shards."""