Class/Object

com.intel.analytics.bigdl.dataset

Sample

Related Docs: object Sample | package dataset

Permalink

abstract class Sample[T] extends Serializable

Class that represents the features and labels of a data sample.

T

numeric type

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
ArraySample, TensorSample
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sample
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Sample()(implicit arg0: ClassTag[T])

    Permalink

Abstract Value Members

  1. abstract def feature(index: Int)(implicit ev: TensorNumeric[T]): Tensor[T]

    Permalink

    Get feature tensor for given index

    Get feature tensor for given index

    index

    index of specific sample

  2. abstract def feature()(implicit ev: TensorNumeric[T]): Tensor[T]

    Permalink

    Get feature tensor, for one feature Sample only.

    Get feature tensor, for one feature Sample only. You don't need to override this, because we have add a default implement to throw exception.

    returns

    feature tensor

  3. abstract def featureLength(index: Int): Int

    Permalink

    First dimension length of index-th feature.

    First dimension length of index-th feature. This function could be used to sort samples in DataSet.

  4. abstract def getData(): Array[T]

    Permalink

    Get data

    Get data

    returns

    data

  5. abstract def getFeatureSize(): Array[Array[Int]]

    Permalink

    Get feature sizes

    Get feature sizes

    returns

    feature sizes

  6. abstract def getLabelSize(): Array[Array[Int]]

    Permalink

    Get label sizes

    Get label sizes

    returns

    label sizes

  7. abstract def label(index: Int)(implicit ev: TensorNumeric[T]): Tensor[T]

    Permalink

    Get label tensor for given index

    Get label tensor for given index

    index

    index of specific sample

  8. abstract def label()(implicit ev: TensorNumeric[T]): Tensor[T]

    Permalink

    Get label tensor, for one label Sample only.

    Get label tensor, for one label Sample only. You don't need to override this, because we have add a default implement to throw exception.

    returns

    label tensor

  9. abstract def labelLength(index: Int): Int

    Permalink

    First dimension length of index-th label.

    First dimension length of index-th label. This function could be used to find the longest label.

  10. abstract def numFeature(): Int

    Permalink

    Number of tensors in feature

    Number of tensors in feature

    returns

    number of tensors in feature

  11. abstract def numLabel(): Int

    Permalink

    Number of tensors in label

    Number of tensors in label

    returns

    number of tensors in label

Concrete 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(): Sample.this.type

    Permalink

    returns

    A deep clone

    Definition Classes
    Sample → AnyRef

  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. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

  18. final def wait(arg0: Long, arg1: Int): Unit

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

  19. final def wait(arg0: Long): Unit

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

Deprecated Value Members

  1. def set(featureData: Array[T], labelData: Array[T], featureSize: Array[Int], labelSize: Array[Int])(implicit ev: TensorNumeric[T]): Sample[T]

    Permalink

    Set data of feature and label.

    Set data of feature and label.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.2.0) Old interface

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped