Class/Object

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

Iterator

Related Docs: object Iterator | package data

Permalink

class Iterator[T, O, D, S] extends AnyRef

A simple iterator that does contains an initializer and can thus not be used until an initializer is created for it, using its createInitializer method.

An iterator represents the state of iterating through a dataset.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Iterator
  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. def createInitializer(dataset: Dataset[T, O, D, S], name: String = s"$name/Initializer"): Op

    Permalink

    Returns an op that initializes this iterator using the provided dataset.

    Returns an op that initializes this iterator using the provided dataset.

    dataset

    Dataset to initialize this iterator with. The output data types of this iterator must match the output data types of the dataset, and its output shapes must be compatible with the output shapes of the dataset.

    name

    Name for the created op.

    returns

    Created op.

    Annotations
    @throws( ... )
    Exceptions thrown

    IllegalArgumentException If any of the output data types or shapes of this iterator is not compatible with the corresponding output data type or shape of the provided dataset.

  7. def createInitializerFromHandle(datasetHandle: Output, name: String = s"$name/Initializer"): Op

    Permalink

    Returns an op that initializes this iterator using the provided dataset handle.

    Returns an op that initializes this iterator using the provided dataset handle.

    NOTE: It is advisable not to use this method for initializing iterators as it does not support compile-time checking for whether the provided dataset handle is compatible with this iterator.

    datasetHandle

    Dataset handle to initialize this iterator with. The output data types of this iterator must match the output data types of the corresponding dataset, and its output shapes must be compatible with the output shapes of that dataset.

    name

    Name for the created op.

    returns

    Created op.

  8. def dispose(name: String = s"$name/Dispose"): Op

    Permalink

    Creates an op that destroys this iterator.

    Creates an op that destroys this iterator.

    The returned op may be used to release any resources consumed by this iterator, without closing the session.

    name

    Name for the created op.

    returns

    Created op.

  9. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink

    Handle of the iterator.

  14. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  16. val name: String

    Permalink
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def next(name: String = s"$name/Next"): O

    Permalink

    Creates an op that obtains the next element of this iterator and returns a nested structure of outputs (according to the structures supported by the Data type trait) that corresponds to that element.

    Creates an op that obtains the next element of this iterator and returns a nested structure of outputs (according to the structures supported by the Data type trait) that corresponds to that element.

    name

    Name for the created op.

    returns

    Created op outputs in a nested structure according to the data type of this initializer.

  19. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  21. val outputDataTypes: D

    Permalink

    Data types corresponding to each element of the iterator.

  22. val outputShapes: S

    Permalink

    Shapes corresponding to each element of the iterator.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. def toStringHandle(name: String = s"$name/ToStringHandle"): Output

    Permalink

    Creates an op that converts the provided resource handle representing an iterator to a string.

    Creates an op that converts the provided resource handle representing an iterator to a string.

    name

    Name for the created op.

    returns

    Created op.

  26. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped