Package ai.djl.modality.nlp.embedding

Class TrainableWordEmbedding.Builder

java.lang.Object

ai.djl.nn.core.Embedding.BaseBuilder<String,TrainableWordEmbedding.Builder>

ai.djl.modality.nlp.embedding.TrainableWordEmbedding.Builder

Enclosing class:

TrainableWordEmbedding

public static class TrainableWordEmbedding.Builder
extends Embedding.BaseBuilder<String,TrainableWordEmbedding.Builder>

A builder for a TrainableWordEmbedding.

Field Summary

Fields inherited from class ai.djl.nn.core.Embedding.BaseBuilder

defaultItem, embeddingSize, embeddingType, fallthrough, numEmbeddings, sparseFormat, useDefault

Method Summary

Modifier and Type	Method	Description
TrainableWordEmbedding	build()	Builds a new instance of TrainableWordEmbedding based on the arguments in this builder.
TrainableWordEmbedding.Builder	optUnknownToken(String unknownToken)	Sets the optional String value for the unknown token.
protected TrainableWordEmbedding.Builder	self()	Returns this {code Builder} object.
protected TrainableWordEmbedding.Builder	setType(Class<String> embeddingType)	Creates a new Embedding.BaseBuilder with the specified embedding type.
TrainableWordEmbedding.Builder	setVocabulary(Vocabulary vocabulary)	Sets the Vocabulary to be used.

Methods inherited from class ai.djl.nn.core.Embedding.BaseBuilder

getEmbeddingType, optDefaultItem, optFallthrough, optNumEmbeddings, optSparseFormat, optUseDefault, setEmbeddingSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setVocabulary

public TrainableWordEmbedding.Builder setVocabulary(Vocabulary vocabulary)

Sets the Vocabulary to be used.

Parameters:

vocabulary - the Vocabulary to be set

Returns:

this Builder

setType

protected TrainableWordEmbedding.Builder setType(Class<String> embeddingType)

Creates a new Embedding.BaseBuilder with the specified embedding type.

Specified by:

setType in class Embedding.BaseBuilder<String,TrainableWordEmbedding.Builder>

Parameters:

embeddingType - the embedding class

Returns:

a new Embedding.BaseBuilder class with the specified embedding type

self

protected TrainableWordEmbedding.Builder self()

Returns this {code Builder} object.

Specified by:

self in class Embedding.BaseBuilder<String,TrainableWordEmbedding.Builder>

Returns:

this BaseBuilder

optUnknownToken

public TrainableWordEmbedding.Builder optUnknownToken(String unknownToken)

Sets the optional String value for the unknown token.

Parameters:

unknownToken - the String value of unknown token

Returns:

this Builder

build

public TrainableWordEmbedding build()

Builds a new instance of TrainableWordEmbedding based on the arguments in this builder.

Returns:

a new instance of TrainableWordEmbedding