Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package thoughtworks
    Definition Classes
    com
  • package deeplearning

    This is the documentation for the DeepLearning.Scala

    This is the documentation for the DeepLearning.Scala

    Overview

    BufferedLayer, DifferentiableAny, DifferentiableNothing, Layer, Poly and Symbolic are base packages which contains necessary operations , all other packages dependent on those base packages.

    If you want to implement a layer, you need to know how to use base packages.

    Imports guidelines

    If you want use some operations of Type T, you should import:

    import com.thoughtworks.deeplearning.DifferentiableT._

    it means: If you want use some operations of INDArray, you should import:

    import com.thoughtworks.deeplearning.DifferentiableINDArray._

    If you write something like this:

    def softmax(implicit scores: INDArray @Symbolic): INDArray @Symbolic = {
      val expScores = exp(scores)
      expScores / expScores.sum(1)
    }

    If compiler shows error :

    Could not infer implicit value for com.thoughtworks.deeplearning.Symbolic[org.nd4j.linalg.api.ndarray.INDArray]

    you need add import this time :

    import com.thoughtworks.deeplearning.DifferentiableINDArray._

    If you write something like this:

    def crossEntropyLossFunction(
      implicit pair: (INDArray :: INDArray :: HNil) @Symbolic)
    : Double @Symbolic = {
     val score = pair.head
     val label = pair.tail.head
     -(label * log(score * 0.9 + 0.1) + (1.0 - label) * log(1.0 - score * 0.9)).mean
    }

    If the compiler shows error:

    value * is not a member of com.thoughtworks.deeplearning.Layer.Aux[com.thoughtworks.deeplearning.Layer.Tape.Aux[org.nd4j.linalg.api.ndarray.INDArray,org.nd4j.linalg.api.ndarray.INDArray],com.thoughtworks.deeplearning.DifferentiableINDArray.INDArrayPlaceholder.Tape]val bias = Nd4j.ones(numberOfOutputKernels).toWeight * 0.1...

    you need add import :

    import com.thoughtworks.deeplearning.Poly.MathMethods.*
    import com.thoughtworks.deeplearning.DifferentiableINDArray._

    If the compiler shows error:

    not found: value log -(label * log(score * 0.9 + 0.1) + (1.0 - label) * log(1.0 - score * 0.9)).mean...

    you need add import:

    import com.thoughtworks.deeplearning.Poly.MathFunctions.*
    import com.thoughtworks.deeplearning.DifferentiableINDArray._

    Those + - * / and log exp abs max min are defined at MathMethods and MathFunctions,those method are been implemented at DifferentiableType,so you need to import the implicit of DifferentiableType.

    Composability

    Neural networks created by DeepLearning.scala are composable. You can create large networks by combining smaller networks. If two larger networks share some sub-networks, the weights in shared sub-networks trained with one network affect the other network.

    Definition Classes
    thoughtworks
    See also

    Compose

  • object Symbolic extends LowPrioritySymbolic

    There are two ways to convert a value to Layer.

    There are two ways to convert a value to Layer.

    The first way is invoke toLayer, such as:

    def createMyNeuralNetwork(implicit input: Float @Symbolic): Float @Symbolic = {
      val floatLayer: Float @Symbolic = 1.0f.toLayer
      floatLayer
    }

    The second way is autoToLayer, such as:

    def createMyNeuralNetwork(implicit input: Float @Symbolic): Float @Symbolic = {
      val floatLayer: Float @Symbolic = 1.0f
      floatLayer
    }

    In order to compile the above code through, you will need:

    import com.thoughtworks.deeplearning.Symbolic._
    import com.thoughtworks.deeplearning.Symbolic
    import com.thoughtworks.deeplearning.DifferentiableFloat._
    Definition Classes
    deeplearning
  • object Layers
    Definition Classes
    Symbolic
  • Identity
  • Literal

final case class Literal[Data0](value0: Data0) extends Layer with Tape with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Literal
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Tape
  7. AutoCloseable
  8. Layer
  9. AnyRef
  10. Any
Implicitly
  1. by autoToLayer
  2. by ToTapeOps
  3. by ToLayerOps
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Literal(value0: Data0)

Type Members

  1. type Data = Data0

    Type of the result of forward pass.

    Type of the result of forward pass.

    Definition Classes
    LiteralTape
    See also

    value

  2. type Delta = Any

    Type of the information passing in backward pass, usually the partial derivative of Data.

    Type of the information passing in backward pass, usually the partial derivative of Data.

    Definition Classes
    LiteralTape
    See also

    backward

  3. type Input = Tape
    Definition Classes
    LiteralLayer
  4. type Output = Tape { ... /* 2 definitions in type refinement */ }
    Definition Classes
    LiteralLayer

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to any2stringadd[Literal[Data0]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Literal[Data0], B)
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to ArrowAssoc[Literal[Data0]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def backward(delta: ⇒ Delta): Unit

    invoke forceBackward if isTrainable is true

    invoke forceBackward if isTrainable is true

    Definition Classes
    Tape
    Annotations
    @inline()
    See also

    Delta

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def close(): Unit
    Definition Classes
    Literal → AutoCloseable
  10. def duplicate(): Literal[Data0]

    Returns a new Tape that shares the same value and backward behavior with this Tape.

    Returns a new Tape that shares the same value and backward behavior with this Tape.

    Definition Classes
    LiteralTape
    Note

    The newly created Tape and this Tape must be closed independently.

  11. def ensuring(cond: (Literal[Data0]) ⇒ Boolean, msg: ⇒ Any): Literal[Data0]
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to Ensuring[Literal[Data0]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Literal[Data0]) ⇒ Boolean): Literal[Data0]
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to Ensuring[Literal[Data0]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Literal[Data0]
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to Ensuring[Literal[Data0]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Literal[Data0]
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to Ensuring[Literal[Data0]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def forceBackward(delta: Delta): Unit
    Attributes
    protected
    Definition Classes
    LiteralTape
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to StringFormat[Literal[Data0]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def forward(input: Input): Literal[Data0]
    Definition Classes
    LiteralLayer
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isTrainable: Boolean
    Definition Classes
    LiteralTape
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toLayer: Aux[Input, Aux[OutputData, OutputDelta]]
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to ToLayerOps[Literal[Data0], Input, OutputData, OutputDelta] performed by method ToLayerOps in com.thoughtworks.deeplearning.Symbolic. This conversion will take place only if an implicit value of type Aux[Literal[Data0], Input, OutputData, OutputDelta] is in scope.
    Definition Classes
    ToLayerOps
  28. def toTape: Aux[Data, Delta]
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to ToTapeOps[Literal[Data0], Data, Delta] performed by method ToTapeOps in com.thoughtworks.deeplearning.Symbolic. This conversion will take place only if an implicit value of type Aux[Literal[Data0], Data, Delta] is in scope.
    Definition Classes
    ToTapeOps
    Annotations
    @inline()
  29. def value: Data

    Value of the result of forward pass.

    Value of the result of forward pass.

    Definition Classes
    LiteralTape
    See also

    Data

  30. val value0: Data0
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (Literal[Data0], B)
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to ArrowAssoc[Literal[Data0]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def forward: ((input: _1.Input)_1.Output) forSome {val _1: Layer { ... /* 2 definitions in type refinement */ }}
    Implicit
    This member is added by an implicit conversion from Literal[Data0] to Aux[Input, Aux[OutputData, OutputDelta]] performed by method autoToLayer in com.thoughtworks.deeplearning.Symbolic. This conversion will take place only if an implicit value of type Aux[Literal[Data0], Input, OutputData, OutputDelta] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (literal: Aux[Input, Aux[OutputData, OutputDelta]]).forward
    Definition Classes
    Layer

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Tape

Inherited from AutoCloseable

Inherited from Layer

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion autoToLayer from Literal[Data0] to Aux[Input, Aux[OutputData, OutputDelta]]

Inherited by implicit conversion ToTapeOps from Literal[Data0] to ToTapeOps[Literal[Data0], Data, Delta]

Inherited by implicit conversion ToLayerOps from Literal[Data0] to ToLayerOps[Literal[Data0], Input, OutputData, OutputDelta]

Inherited by implicit conversion any2stringadd from Literal[Data0] to any2stringadd[Literal[Data0]]

Inherited by implicit conversion StringFormat from Literal[Data0] to StringFormat[Literal[Data0]]

Inherited by implicit conversion Ensuring from Literal[Data0] to Ensuring[Literal[Data0]]

Inherited by implicit conversion ArrowAssoc from Literal[Data0] to ArrowAssoc[Literal[Data0]]

Ungrouped