final case class GradientDef(functionName: String = "", gradientFunc: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GradientDef] with Product with Serializable
GradientDef defines the gradient function of a function defined in a function library.
A gradient function g (specified by gradient_func) for a function f (specified by function_name) must follow the following:
The function 'f' must be a numerical function which takes N inputs and produces M outputs. Its gradient function 'g', which is a function taking N + M inputs and produces N outputs.
I.e. if we have (y1, y2, ..., y_M) = f(x1, x2, ..., x_N), then, g is (dL/dx1, dL/dx2, ..., dL/dx_N) = g(x1, x2, ..., x_N, dL/dy1, dL/dy2, ..., dL/dy_M), where L is a scalar-value function of (x1, x2, ..., xN) (e.g., the loss function). dL/dx_i is the partial derivative of L with respect to x_i.
- functionName
 The function name.
- gradientFunc
 The gradient function's name.
- Annotations
 - @SerialVersionUID()
 
- Alphabetic
 - By Inheritance
 
- GradientDef
 - Updatable
 - GeneratedMessage
 - Serializable
 - Serializable
 - Product
 - Equals
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - All
 
Instance Constructors
- 
      
      
      
        
      
    
      
        
        new
      
      
        GradientDef(functionName: String = "", gradientFunc: String = "", unknownFields: UnknownFieldSet = ...)
      
      
      
- functionName
 The function name.
- gradientFunc
 The gradient function's name.
 
Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... ) @native() @HotSpotIntrinsicCandidate()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        companion: GradientDef.type
      
      
      
- Definition Classes
 - GradientDef → GeneratedMessage
 
 -  def discardUnknownFields: GradientDef
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 -  val functionName: String
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native() @HotSpotIntrinsicCandidate()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        getField(__field: FieldDescriptor): PValue
      
      
      
- Definition Classes
 - GradientDef → GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        getFieldByNumber(__fieldNumber: Int): Any
      
      
      
- Definition Classes
 - GradientDef → GeneratedMessage
 
 -  val gradientFunc: String
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native() @HotSpotIntrinsicCandidate()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native() @HotSpotIntrinsicCandidate()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        serializedSize: Int
      
      
      
- Definition Classes
 - GradientDef → GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        toByteArray: Array[Byte]
      
      
      
- Definition Classes
 - GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        toByteString: ByteString
      
      
      
- Definition Classes
 - GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        toPMessage: PMessage
      
      
      
- Definition Classes
 - GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toProtoString: String
      
      
      
- Definition Classes
 - GradientDef → GeneratedMessage
 
 -  val unknownFields: UnknownFieldSet
 - 
      
      
      
        
      
    
      
        
        def
      
      
        update(ms: (Lens[GradientDef, GradientDef]) ⇒ Mutation[GradientDef]*): GradientDef
      
      
      
- Definition Classes
 - Updatable
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... ) @native()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 -  def withFunctionName(__v: String): GradientDef
 -  def withGradientFunc(__v: String): GradientDef
 -  def withUnknownFields(__v: UnknownFieldSet): GradientDef
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        writeDelimitedTo(output: OutputStream): Unit
      
      
      
- Definition Classes
 - GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        writeTo(_output__: CodedOutputStream): Unit
      
      
      
- Definition Classes
 - GradientDef → GeneratedMessage
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        writeTo(output: OutputStream): Unit
      
      
      
- Definition Classes
 - GeneratedMessage
 
 
Deprecated Value Members
- 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( classOf[java.lang.Throwable] ) @Deprecated
 - Deprecated