Package de.uni_mannheim.informatik.dws.melt.matching_ml.python.nlptransformers

Enum SentenceTransformersLoss

java.lang.Object

java.lang.Enum<SentenceTransformersLoss>

de.uni_mannheim.informatik.dws.melt.matching_ml.python.nlptransformers.SentenceTransformersLoss

All Implemented Interfaces:

Serializable, Comparable<SentenceTransformersLoss>, java.lang.constant.Constable

public enum SentenceTransformersLoss
extends Enum<SentenceTransformersLoss>

Enum which lists all possible types of loss for training sentence transformers.

See Also:

• https://www.sbert.net/docs/package_reference/losses.html

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CosineSimilarityLoss	For each sentence pair, we pass sentence A and sentence B through our network which yields the embeddings u und v.
MultipleNegativesRankingLoss	This loss expects as input a batch consisting of sentence pairs (a_1, p_1), (a_2, p_2)…, (a_n, p_n) where we assume that (a_i, p_i) are a positive pair and (a_i, p_j) for i!=j a negative pair.
MultipleNegativesRankingLossWithHardNegatives	This loss expects as input a batch consisting of sentence pairs (a_1, p_1), (a_2, p_2)…, (a_n, p_n) where we assume that (a_i, p_i) are a positive pair and (a_i, p_j) for i!=j a negative pair.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SentenceTransformersLoss()

Method Summary

Modifier and Type	Method	Description
static SentenceTransformersLoss	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SentenceTransformersLoss[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CosineSimilarityLoss

public static final SentenceTransformersLoss CosineSimilarityLoss

For each sentence pair, we pass sentence A and sentence B through our network which yields the embeddings u und v. The similarity of these embeddings is computed using cosine similarity and the result is compared to the gold similarity score.

See Also:

• https://www.sbert.net/docs/package_reference/losses.html#cosinesimilarityloss

MultipleNegativesRankingLoss

public static final SentenceTransformersLoss MultipleNegativesRankingLoss

This loss expects as input a batch consisting of sentence pairs (a_1, p_1), (a_2, p_2)…, (a_n, p_n) where we assume that (a_i, p_i) are a positive pair and (a_i, p_j) for i!=j a negative pair.

See Also:

• https://www.sbert.net/docs/package_reference/losses.html#multiplenegativesrankingloss

MultipleNegativesRankingLossWithHardNegatives

public static final SentenceTransformersLoss MultipleNegativesRankingLossWithHardNegatives

This loss expects as input a batch consisting of sentence pairs (a_1, p_1), (a_2, p_2)…, (a_n, p_n) where we assume that (a_i, p_i) are a positive pair and (a_i, p_j) for i!=j a negative pair.

See Also:

• https://www.sbert.net/docs/package_reference/losses.html#multiplenegativesrankingloss

Constructor Details

SentenceTransformersLoss

private SentenceTransformersLoss()

Method Details

values

public static SentenceTransformersLoss[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SentenceTransformersLoss valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null