Trait/Object

com.thoughtworks.deeplearning

Symbolic

Related Docs: object Symbolic | package deeplearning

Permalink

trait Symbolic[NativeOutput] extends AnyRef

Provides @Symbolic annotation to create symbolic methods, in which you can create Layers from mathematical formulas.

Symbolic is a dependent type class that calculates a specific Layer type according to NativeOutput. Combining with implicit-dependent-type compiler plugin, it can be treated as a type annotation in the form of NativeOutput @Symbolic, converting NativeOutput to a specific Layer type.

@Symbolic 的三种用法

用于符号方法的隐式参数类型

如果某个方法的隐式类型参数标注了@Symbolic，那么这个方法就是符号方法，@Symbolic所标注的隐式参数类型是这个符号方法的输入类型。 这种情况下，NativeOutput @Symbolic会被展开为：

Identity[NativeOutput, NativeOutput的导数类型]

例如：

def sumNetwork(implicit scores: INDArray @Symbolic): Double = {
  exp(scores).sum
}

上述代码中，由于INDArray的导数类型也是INDArray，所以sumNetwork的输入类型INDArray @Symbolic展开后是Identity[INDArray, INDArray]。

用于符号方法内部变量和返回值

在符号方法内部和返回值处，NativeOutput @Symbolic会被展开为：

Layer.Aux[Tape.Aux[输入类型的值类型, 输入类型的导数类型], Tape.Aux[NativeOutput, NativeOutput的导数类型]]

例如：

def sumNetwork(implicit scores: INDArray @Symbolic): Double @Symbolic = {
  val expScores: INDArray @Symbolic = exp(scores)
  val result: Double @Symbolic = expScores.sum
  result
}

上述代码中，expScores的类型INDArray @Symbolic展开后是：

Layer.Aux[Tape.Aux[INDArray, INDArray], Tape.Aux[INDArray, INDArray]]

而result的类型Double @Symbolic展开后是：

Layer.Aux[Tape.Aux[INDArray, INDArray], Tape.Aux[Double, Double]]
用于符号方法之外

在符号方法之外，(NativeInput => NativeOutput) @Symbolic会被展开为：

Layer.Aux[Tape.Aux[NativeInput, NativeInput的导数类型], Tape.Aux[NativeOutput, NativeOutput的导数类型]]

例如：

val predictor: (INDArray => Double) @Symbolic = sumNetwork

上述代码中，predictor的类型(INDArray => Double) @Symbolic展开后是：

Layer.Aux[Tape.Aux[INDArray, INDArray], Tape.Aux[Double, Double]]

定制符号类型

@Symbolic通过检查Symbolic.ToLiteral隐式值来确定原生类型和导数之间的映射关系。 因此，只要定义Symbolic.ToLiteral类型的隐式值，@Symbolic就可以支持定制符号类型。

比如，假如你希望支持Short @Symbolic，其中使用Float作为Short的导数类型，那么可以这样做：

implicit object ShortToLiteral extends ToLiteral[Short] {
  override type Data = Short
  override type Delta = Float
  override def apply(data: Short) = Literal(data)
}

def makeShortNetwork(implicit input: Short @Symbolic): Short @Symbolic = {
  input
}

val shortNetwork: (Short => Short) @Symbolic = makeShortNetwork

这样一来shortNetwork的类型就会展开为：

Layer.Aux[Tape.Aux[Short, Float], Tape.Aux[Short, Float]]
Annotations
@implicitNotFound( ... )
See also

Layer.Tape#Delta

Symbolic.ToLiteral

Symbolic.Layers.Identity

Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Symbolic
  2. AnyRef
  3. 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

Type Members

  1. abstract type @ <: Layer

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to any2stringadd[Symbolic[NativeOutput]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Symbolic[NativeOutput], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to ArrowAssoc[Symbolic[NativeOutput]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (Symbolic[NativeOutput]) ⇒ Boolean, msg: ⇒ Any): Symbolic[NativeOutput]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to Ensuring[Symbolic[NativeOutput]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (Symbolic[NativeOutput]) ⇒ Boolean): Symbolic[NativeOutput]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to Ensuring[Symbolic[NativeOutput]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Symbolic[NativeOutput]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to Ensuring[Symbolic[NativeOutput]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): Symbolic[NativeOutput]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to Ensuring[Symbolic[NativeOutput]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to StringFormat[Symbolic[NativeOutput]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. def forward: ((input: _62.Input)_62.Output) forSome {val _62: Layer { ... /* 2 definitions in type refinement */ }}

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] 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[Symbolic[NativeOutput], Input, OutputData, OutputDelta] is in scope.
    Definition Classes
    Layer

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  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. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toLayer: Aux[Input, Aux[OutputData, OutputDelta]]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to ToLayerOps[Symbolic[NativeOutput], 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[Symbolic[NativeOutput], Input, OutputData, OutputDelta] is in scope.
    Definition Classes
    ToLayerOps

  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  26. def toTape: Aux[Data, Delta]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to ToTapeOps[Symbolic[NativeOutput], Data, Delta] performed by method ToTapeOps in com.thoughtworks.deeplearning.Symbolic. This conversion will take place only if an implicit value of type Aux[Symbolic[NativeOutput], Data, Delta] is in scope.
    Definition Classes
    ToTapeOps
    Annotations
    @inline()

  27. final def wait(): Unit

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

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

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

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

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

  30. def →[B](y: B): (Symbolic[NativeOutput], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Symbolic[NativeOutput] to ArrowAssoc[Symbolic[NativeOutput]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion autoToLayer from Symbolic[NativeOutput] to Aux[Input, Aux[OutputData, OutputDelta]]

Inherited by implicit conversion ToTapeOps from Symbolic[NativeOutput] to ToTapeOps[Symbolic[NativeOutput], Data, Delta]

Inherited by implicit conversion ToLayerOps from Symbolic[NativeOutput] to ToLayerOps[Symbolic[NativeOutput], Input, OutputData, OutputDelta]

Inherited by implicit conversion any2stringadd from Symbolic[NativeOutput] to any2stringadd[Symbolic[NativeOutput]]

Inherited by implicit conversion StringFormat from Symbolic[NativeOutput] to StringFormat[Symbolic[NativeOutput]]

Inherited by implicit conversion Ensuring from Symbolic[NativeOutput] to Ensuring[Symbolic[NativeOutput]]

Inherited by implicit conversion ArrowAssoc from Symbolic[NativeOutput] to ArrowAssoc[Symbolic[NativeOutput]]

Ungrouped