Package com.yahoo.embedding.huggingface

Class HuggingFaceEmbedderConfig

java.lang.Object

com.yahoo.config.Node

com.yahoo.config.InnerNode

com.yahoo.config.ConfigInstance

com.yahoo.embedding.huggingface.HuggingFaceEmbedderConfig

public final class HuggingFaceEmbedderConfig
extends com.yahoo.config.ConfigInstance

This class represents the root node of hugging-face-embedder Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HuggingFaceEmbedderConfig.Builder
static final class	HuggingFaceEmbedderConfig.PoolingStrategy	This class represents hugging-face-embedder.poolingStrategy
static interface	HuggingFaceEmbedderConfig.Producer
static final class	HuggingFaceEmbedderConfig.TransformerExecutionMode	This class represents hugging-face-embedder.transformerExecutionMode Settings for ONNX model evaluation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_DEF_MD5
static final String	CONFIG_DEF_NAME
static final String	CONFIG_DEF_NAMESPACE
static final String[]	CONFIG_DEF_SCHEMA

Constructor Summary

Constructors

Constructor	Description
HuggingFaceEmbedderConfig(HuggingFaceEmbedderConfig.Builder builder)

Method Summary

Modifier and Type	Method	Description
static String	getDefMd5()
static String	getDefName()
static String	getDefNamespace()
boolean	normalize()
HuggingFaceEmbedderConfig.PoolingStrategy.Enum	poolingStrategy()
String	prependDocument()
String	prependQuery()
Path	tokenizerPath()
com.yahoo.config.ModelReference	tokenizerPathReference()
String	transformerAttentionMask()
HuggingFaceEmbedderConfig.TransformerExecutionMode.Enum	transformerExecutionMode()
int	transformerGpuDevice()
String	transformerInputIds()
int	transformerInterOpThreads()
int	transformerIntraOpThreads()
int	transformerMaxTokens()
Path	transformerModel()
com.yahoo.config.ModelReference	transformerModelReference()
Optional<Path>	transformerOnnxConfigPath()
String	transformerOutput()
String	transformerTokenTypeIds()

Methods inherited from class com.yahoo.config.ConfigInstance

getDefName, getDefNamespace, serialize, serialize

Methods inherited from class com.yahoo.config.InnerNode

equals, getAllDescendantLeafNodes, getChildren, getChildrenWithVectorsFlattened, hashCode, postInitialize, toString

Methods inherited from class com.yahoo.config.Node

clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CONFIG_DEF_MD5

public static final String CONFIG_DEF_MD5

See Also:

• Constant Field Values

CONFIG_DEF_NAME

public static final String CONFIG_DEF_NAME

See Also:

• Constant Field Values

CONFIG_DEF_NAMESPACE

public static final String CONFIG_DEF_NAMESPACE

See Also:

• Constant Field Values

CONFIG_DEF_SCHEMA

public static final String[] CONFIG_DEF_SCHEMA

Constructor Details

HuggingFaceEmbedderConfig

public HuggingFaceEmbedderConfig(HuggingFaceEmbedderConfig.Builder builder)

Method Details

getDefMd5

public static String getDefMd5()

getDefName

public static String getDefName()

getDefNamespace

public static String getDefNamespace()

tokenizerPath

public Path tokenizerPath()

Returns:

hugging-face-embedder.tokenizerPath

tokenizerPathReference

public com.yahoo.config.ModelReference tokenizerPathReference()

Returns:

hugging-face-embedder.tokenizerPath ModelReference

transformerModel

public Path transformerModel()

Returns:

hugging-face-embedder.transformerModel

transformerModelReference

public com.yahoo.config.ModelReference transformerModelReference()

Returns:

hugging-face-embedder.transformerModel ModelReference

transformerMaxTokens

public int transformerMaxTokens()

Returns:

hugging-face-embedder.transformerMaxTokens

transformerInputIds

public String transformerInputIds()

Returns:

hugging-face-embedder.transformerInputIds

transformerAttentionMask

public String transformerAttentionMask()

Returns:

hugging-face-embedder.transformerAttentionMask

transformerTokenTypeIds

public String transformerTokenTypeIds()

Returns:

hugging-face-embedder.transformerTokenTypeIds

transformerOutput

public String transformerOutput()

Returns:

hugging-face-embedder.transformerOutput

prependQuery

public String prependQuery()

Returns:

hugging-face-embedder.prependQuery

prependDocument

public String prependDocument()

Returns:

hugging-face-embedder.prependDocument

normalize

public boolean normalize()

Returns:

hugging-face-embedder.normalize

poolingStrategy

public HuggingFaceEmbedderConfig.PoolingStrategy.Enum poolingStrategy()

Returns:

hugging-face-embedder.poolingStrategy

transformerExecutionMode

public HuggingFaceEmbedderConfig.TransformerExecutionMode.Enum transformerExecutionMode()

Returns:

hugging-face-embedder.transformerExecutionMode

transformerInterOpThreads

public int transformerInterOpThreads()

Returns:

hugging-face-embedder.transformerInterOpThreads

transformerIntraOpThreads

public int transformerIntraOpThreads()

Returns:

hugging-face-embedder.transformerIntraOpThreads

transformerGpuDevice

public int transformerGpuDevice()

Returns:

hugging-face-embedder.transformerGpuDevice

transformerOnnxConfigPath

public Optional<Path> transformerOnnxConfigPath()

Returns:

hugging-face-embedder.transformerOnnxConfigPath