Class

org.platanios.tensorflow.api.ops.io.data

FixedLengthRecordDataset

Related Doc: package data

Permalink

case class FixedLengthRecordDataset(filenames: tensors.Tensor[types.STRING], recordNumBytes: Long, headerNumBytes: Long, footerNumBytes: Long, bufferSize: Long = 256 * 1024, name: String = "FixedLengthRecordDataset") extends Dataset[tensors.Tensor[types.STRING], Output, types.STRING, core.Shape] with Product with Serializable

Dataset with elements read from binary files.

filenames

Scalar or vector tensor containing the the name(s) of the file(s) to be read.

recordNumBytes

Number of bytes in the record.

headerNumBytes

Number of bytes in the header (i.e., the number of bytes to skip at the beginning of a file).

footerNumBytes

Number of bytes in the footer (i.e., the number of bytes to skip at the end of a file).

bufferSize

Number of bytes to buffer while reading from the file.

name

Name for this dataset.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FixedLengthRecordDataset
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Dataset
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FixedLengthRecordDataset(filenames: tensors.Tensor[types.STRING], recordNumBytes: Long, headerNumBytes: Long, footerNumBytes: Long, bufferSize: Long = 256 * 1024, name: String = "FixedLengthRecordDataset")

    Permalink

    filenames

    Scalar or vector tensor containing the the name(s) of the file(s) to be read.

    recordNumBytes

    Number of bytes in the record.

    headerNumBytes

    Number of bytes in the header (i.e., the number of bytes to skip at the beginning of a file).

    footerNumBytes

    Number of bytes in the footer (i.e., the number of bytes to skip at the end of a file).

    bufferSize

    Number of bytes to buffer while reading from the file.

    name

    Name for this dataset.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val bufferSize: Long

    Permalink

    Number of bytes to buffer while reading from the file.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def createHandle(): Output

    Permalink

    Creates a VARIANT scalar tensor representing this dataset.

    Creates a VARIANT scalar tensor representing this dataset. This function adds ops to the current graph, that create the dataset resource.

    Definition Classes
    FixedLengthRecordDatasetDataset
  8. def createInitializableIterator(sharedName: String = "", name: String = "InitializableIterator"): InitializableIterator[tensors.Tensor[types.STRING], Output, types.STRING, core.Shape]

    Permalink

    Creates an Iterator for enumerating the elements of this dataset.

    Creates an Iterator for enumerating the elements of this dataset.

    **Note:** The returned iterator will be in an uninitialized state. You must execute the InitializableIterator.initializer op before using it.

    sharedName

    If non-empty, then the constructed reader will be shared under the the provided name across multiple sessions that share the same devices (e.g., when using a remote server).

    name

    Name for the op created in relation to the iterator.

    returns

    Created iterator.

    Definition Classes
    Dataset
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. implicit val evData: Aux[tensors.Tensor[types.STRING], Output, types.STRING, core.Shape]

    Permalink
    Definition Classes
    Dataset
  11. implicit val evFunctionInput: ArgType[Output]

    Permalink
    Definition Classes
    Dataset
  12. implicit val evStructure: Aux[tensors.Tensor[types.STRING], Output, types.STRING, core.Shape]

    Permalink
    Definition Classes
    Dataset
  13. val filenames: tensors.Tensor[types.STRING]

    Permalink

    Scalar or vector tensor containing the the name(s) of the file(s) to be read.

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val footerNumBytes: Long

    Permalink

    Number of bytes in the footer (i.e., the number of bytes to skip at the end of a file).

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. val headerNumBytes: Long

    Permalink

    Number of bytes in the header (i.e., the number of bytes to skip at the beginning of a file).

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val name: String

    Permalink

    Name for this dataset.

    Name for this dataset.

    Definition Classes
    FixedLengthRecordDatasetDataset
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def outputDataTypes: types.STRING

    Permalink

    Returns the data types corresponding to each element of this dataset, matching the structure of the elements.

    Returns the data types corresponding to each element of this dataset, matching the structure of the elements.

    Definition Classes
    FixedLengthRecordDatasetDataset
  24. def outputShapes: core.Shape

    Permalink

    Returns the shapes corresponding to each element of this dataset, matching the structure of the elements.

    Returns the shapes corresponding to each element of this dataset, matching the structure of the elements.

    Definition Classes
    FixedLengthRecordDatasetDataset
  25. val recordNumBytes: Long

    Permalink

    Number of bytes in the record.

  26. def shard(numShards: Long, shardIndex: Long): Dataset[tensors.Tensor[types.STRING], Output, types.STRING, core.Shape]

    Permalink

    Creates a dataset that includes only 1 / numShards of the elements of this dataset.

    Creates a dataset that includes only 1 / numShards of the elements of this dataset.

    This operator is very useful when running distributed training, as it allows each worker to read a unique subset of the dataset.

    When reading a single input file, you can skip elements as follows:

    tf.data.TFRecordDataset(inputFile)
      .shard(numWorkers, workerIndex)
      .repeat(numEpochs)
      .shuffle(shuffleBufferSize)
      .map(parserFn, numParallelCalls)

    Important caveats:

    • Be sure to shard before you use any randomizing operator (such as shuffle).
    • Generally it is best if the shard operator is used early in the dataset pipeline. For example, when reading from a set of TensorFlow record files, shard before converting the dataset to input samples. This avoids reading every file on every worker. The following is an example of an efficient sharding strategy within a complete pipeline:
    tf.data.listFiles(pattern)
      .shard(numWorkers, workerIndex)
      .repeat(numEpochs)
      .shuffle(shuffleBufferSize)
      .repeat()
      .interleave(tf.data.TFRecordDataset, cycleLength = numReaders, blockLength = 1)
      .map(parserFn, numParallelCalls)
    numShards

    Number of shards to use.

    shardIndex

    Index of the shard to obtain.

    returns

    Created (sharded) dataset.

    Definition Classes
    Dataset
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    Dataset → AnyRef → Any
  29. def transform[TT, TO, TD, TS](transformFn: (Dataset[tensors.Tensor[types.STRING], Output, types.STRING, core.Shape]) ⇒ Dataset[TT, TO, TD, TS])(implicit evStructure: Aux[TT, TO, TD, TS], evT: Aux[TT, TO, TD, TS], evFunctionInputT: ArgType[TO]): Dataset[TT, TO, TD, TS]

    Permalink

    Applies a transformation function to this dataset.

    Applies a transformation function to this dataset.

    transform() enables chaining of custom dataset transformations, which are represented as functions that take one dataset argument and return a transformed dataset.

    transformFn

    Dataset transformation function.

    returns

    Transformed dataset.

    Definition Classes
    Dataset
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped