ai.djl.nn.core

Class Embedding.Builder<T>

java.lang.Object

ai.djl.nn.core.Embedding.Builder<T>

Type Parameters:

T - the type of object to embed

Enclosing class:

Embedding<T>

public static final class Embedding.Builder<T>
extends java.lang.Object

The Builder to construct a Embedding type of Block.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Embedding<T>	build() Builds the Embedding.
Embedding.Builder<T>	optDataType(DataType dataType) Sets the data type of the embedding arrays (default is Float32).
Embedding.Builder<T>	optUseDefault(boolean useDefault) Sets whether to use a default embedding for undefined items (default true).
Embedding.Builder<T>	setEmbeddingSize(int embeddingSize) Sets the size of the embeddings.
Embedding.Builder<T>	setItems(java.util.Collection<T> items) Sets the collection of items that should feature embeddings.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setItems

public Embedding.Builder<T> setItems(java.util.Collection<T> items)

Sets the collection of items that should feature embeddings.

Parameters:

items - a collection containing all the items that embeddings should be created for

Returns:

this Builder

setEmbeddingSize

public Embedding.Builder<T> setEmbeddingSize(int embeddingSize)

Sets the size of the embeddings.

Parameters:

embeddingSize - the size of the 1D embedding array

Returns:

this Builder

optUseDefault

public Embedding.Builder<T> optUseDefault(boolean useDefault)

Sets whether to use a default embedding for undefined items (default true).

Parameters:

useDefault - true to provide a default embedding and false to throw an IllegalArgumentException when the item can not be found

Returns:

this Builder

optDataType

public Embedding.Builder<T> optDataType(DataType dataType)

Sets the data type of the embedding arrays (default is Float32).

Parameters:

dataType - the dataType to use for the embedding

Returns:

this Builder

build

public Embedding<T> build()

Builds the Embedding.

Returns:

the constructed Embedding

Throws:

java.lang.IllegalArgumentException - if all required parameters (items, embeddingSize) have not been set