CosineEmbeddingCriterion

Instance Constructors

new CosineEmbeddingCriterion(margin: Double = 0.0, sizeAverage: Boolean = true)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

margin
a number from -1 to 1, 0 to 0.5 is suggested

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 backward(input: Table, target: Table): Table

Performs a back-propagation step through the criterion, with respect to the given input.
Performs a back-propagation step through the criterion, with respect to the given input.
input
input data
target
target
returns
gradient corresponding to input data

Definition Classes
AbstractCriterion
def canEqual(other: Any): Boolean

Definition Classes
CosineEmbeddingCriterion → AbstractCriterion
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def cloneCriterion(): AbstractCriterion[Table, Table, T]

Deep copy this criterion
Deep copy this criterion
returns
a deep copied criterion

Definition Classes
AbstractCriterion
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
CosineEmbeddingCriterion → AbstractCriterion → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forward(input: Table, target: Table): T

Takes an input object, and computes the corresponding loss of the criterion, compared with target.
Takes an input object, and computes the corresponding loss of the criterion, compared with target.
input
input data
target
target
returns
the loss of criterion

Definition Classes
AbstractCriterion
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
var gradInput: Table

Definition Classes
AbstractCriterion
def hashCode(): Int

Definition Classes
CosineEmbeddingCriterion → AbstractCriterion → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val margin: Double

a number from -1 to 1, 0 to 0.5 is suggested
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var output: T

Definition Classes
AbstractCriterion
val sizeAverage: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
CosineEmbeddingCriterion → AnyRef → Any
def updateGradInput(input: Table, target: Table): Table

Computing the gradient of the criterion with respect to its own input.
Computing the gradient of the criterion with respect to its own input. This is returned in gradInput. Also, the gradInput state variable is updated accordingly.
input
input data
target
target data / labels
returns
gradient of input

Definition Classes
CosineEmbeddingCriterion → AbstractCriterion
def updateOutput(input: Table, target: Table): T

Computes the loss using input and objective function.
Computes the loss using input and objective function. This function returns the result which is stored in the output field.
input
input of the criterion
target
target or labels
returns
the loss of the criterion

Definition Classes
CosineEmbeddingCriterion → AbstractCriterion
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object CosineEmbeddingCriterion | package nn

class CosineEmbeddingCriterion[T] extends AbstractCriterion[Table, Table, T]

Instance Constructors

new CosineEmbeddingCriterion(margin: Double = 0.0, sizeAverage: Boolean = true)(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def backward(input: Table, target: Table): Table

def canEqual(other: Any): Boolean

def clone(): AnyRef

def cloneCriterion(): AbstractCriterion[Table, Table, T]

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

def forward(input: Table, target: Table): T

final def getClass(): Class[_]

var gradInput: Table

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val margin: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

var output: T

val sizeAverage: Boolean

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

def toString(): String

def updateGradInput(input: Table, target: Table): Table

def updateOutput(input: Table, target: Table): T

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AbstractCriterion[Table, Table, T]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped