Class/Object

org.platanios.tensorflow.api.ops.io

Reader

Related Docs: object Reader | package io

Permalink

class Reader extends AnyRef

Class that supports all TensorFlow reader implementations.

Conceptually, readers convert string "work units" into records (i.e., key-value pairs). Typically the "work units" are filenames and the records are extracted from the contents of those files. We want a single record produced per step, but a work unit can correspond to many records.

Therefore we introduce some decoupling using a Queue. The queue contains the work units and the reader dequeues from the queue when it is asked to produce a record (e.g., via its read method) but it has already finished the last work unit.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. val handle: Output

    Permalink

    Handle to the underlying TensorFlow reader.

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. val name: String

    Permalink

    Name of this reader.

    Name of this reader.

    Attributes
    protected
  14. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  17. def numRecordsProduced(name: String = s"$name/NumRecordsProduced"): Output

    Permalink

    Creates an op that returns the number of records that this reader has produced.

    Creates an op that returns the number of records that this reader has produced.

    This is the same as the number of read executions that have succeeded.

    name

    Name for the created op.

    returns

    Created op output, which is an INT64 scalar tensor.

  18. def numWorkUnitsCompleted(name: String = s"$name/NumWorkUnitsCompleted"): Output

    Permalink

    Creates an op that returns the number of work units that this reader has finished processing.

    Creates an op that returns the number of work units that this reader has finished processing.

    name

    Name for the created op.

    returns

    Created op output, which is an INT64 scalar tensor.

  19. def read(queue: Queue, name: String = s"$name/Read"): (Output, Output)

    Permalink

    Creates an op that reads the next record (i.e., key-value pair) produced by this reader.

    Creates an op that reads the next record (i.e., key-value pair) produced by this reader.

    The op will dequeue from the input queue if necessary (e.g., when the reader needs to start reading from a new file since it has finished with the previous file).

    queue

    Queue to obtain the work units from.

    name

    Name for the created op.

    returns

    Created op outputs as a key-value pair.

  20. def readUpTo(queue: Queue, numRecords: Output, name: String = s"$name/ReadUpTo"): (Output, Output)

    Permalink

    Creates an op that reads up to the next numRecords records (i.e., key-value pairs) produced by this reader.

    Creates an op that reads up to the next numRecords records (i.e., key-value pairs) produced by this reader.

    The op will dequeue from the input queue if necessary (e.g., when the reader needs to start reading from a new file since it has finished with the previous file).

    queue

    Queue to obtain the work units from.

    numRecords

    INT64 scalar tensor specifying how many records to read.

    name

    Name for the created op.

    returns

    Created op outputs as a key-value pair of one-dimensional tensors.

  21. def reset(name: String = s"$name/Reset"): Op

    Permalink

    Creates an op that restores this reader to its initial clean state.

    Creates an op that restores this reader to its initial clean state.

    name

    Name for the created op.

    returns

    Created op.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped