ai.djl.nn.core

Class Embedding<T>

java.lang.Object

ai.djl.nn.AbstractBlock

ai.djl.nn.ParameterBlock

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

Type Parameters:

T - the type of item that should be embedded and map to the array

All Implemented Interfaces:

Block, AbstractEmbedding<T>, AbstractIndexedEmbedding<T>

Direct Known Subclasses:

TrainableWordEmbedding

public abstract class Embedding<T>
extends ParameterBlock
implements AbstractIndexedEmbedding<T>

An Embedding block map a collection of items to 1-Dimensional representative NDArrays.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Embedding.BaseBuilder<T,B extends Embedding.BaseBuilder<T,B>> The Builder to construct a Embedding type of Block.
protected class	Embedding.DefaultEmbedding
protected class	Embedding.DefaultItem

Field Summary

Fields

Modifier and Type	Field and Description
protected DataType	dataType
protected java.util.Map<T,java.lang.Integer>	embedder
protected Parameter	embedding
protected int	embeddingSize
protected AbstractIndexedEmbedding<T>	fallthroughEmbedding
protected int	numItems
protected boolean	sparseGrad
protected java.util.Map<java.lang.Integer,T>	unembedder

Fields inherited from class ai.djl.nn.AbstractBlock

inputNames, inputShapes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Embedding(Embedding.BaseBuilder<T,?> baseBuilder)
	Embedding(NDArray embedding, java.util.List<T> items) Constructs a pretrained embedding.
	Embedding(NDArray embedding, java.util.List<T> items, boolean sparseGrad) Constructs a pretrained embedding.

Method Summary

Modifier and Type	Method and Description
NDArray	embed(NDManager manager, T[] items) Embeds an array of items.
int	embed(T item) Embeds an item.
NDList	forward(ParameterStore parameterStore, NDList inputs, boolean training, ai.djl.util.PairList<java.lang.String,java.lang.Object> params) Applies the operating function of the block once.
java.util.List<Parameter>	getDirectParameters() Returns a list of all the direct parameters of the block.
Shape[]	getOutputShapes(NDManager manager, Shape[] inputShapes) Returns the expected output shapes of the block for the specified input shapes.
Shape	getParameterShape(java.lang.String name, Shape[] inputShapes) Returns the shape of the specified direct parameter of this block given the shapes of the input to the block.
boolean	hasItem(T item) Returns whether an item is in the embedding.
void	loadParameters(NDManager manager, java.io.DataInputStream is) Loads the parameters from the given input stream.
void	saveParameters(java.io.DataOutputStream os) Writes the parameters of the block to the given outputStream.
java.util.Optional<T>	unembed(int index) Returns the item corresponding to the given index.

Methods inherited from class ai.djl.nn.ParameterBlock

getChildren, initialize, toString

Methods inherited from class ai.djl.nn.AbstractBlock

beforeInitialize, cast, clear, describeInput, getParameters, isInitialized, readInputShapes, saveInputShapes, setInitializer, setInitializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.nn.core.AbstractIndexedEmbedding

decode, encode

Methods inherited from interface ai.djl.nn.Block

forward, validateLayout

Field Detail

embeddingSize

protected int embeddingSize

sparseGrad

protected boolean sparseGrad

dataType

protected DataType dataType

embedder

protected java.util.Map<T,java.lang.Integer> embedder

unembedder

protected java.util.Map<java.lang.Integer,T> unembedder

numItems

protected int numItems

fallthroughEmbedding

protected AbstractIndexedEmbedding<T> fallthroughEmbedding

embedding

protected Parameter embedding

Constructor Detail

Embedding

protected Embedding(Embedding.BaseBuilder<T,?> baseBuilder)

Embedding

public Embedding(NDArray embedding,
                 java.util.List<T> items)

Constructs a pretrained embedding.

Parameters:

embedding - the embedding array

items - the items in the embedding (in matching order to the embedding array)

Embedding

public Embedding(NDArray embedding,
                 java.util.List<T> items,
                 boolean sparseGrad)

Constructs a pretrained embedding.

Parameters:

embedding - the embedding array

items - the items in the embedding (in matching order to the embedding array)

sparseGrad - whether to compute row sparse gradient in the backward calculation

Method Detail

getOutputShapes

public Shape[] getOutputShapes(NDManager manager,
                               Shape[] inputShapes)

Returns the expected output shapes of the block for the specified input shapes.

Specified by:

getOutputShapes in interface Block

Parameters:

manager - an NDManager

inputShapes - the shapes of the inputs

Returns:

the expected output shapes of the block

getDirectParameters

public java.util.List<Parameter> getDirectParameters()

Returns a list of all the direct parameters of the block.

Specified by:

getDirectParameters in interface Block

Returns:

the list of Parameter

getParameterShape

public Shape getParameterShape(java.lang.String name,
                               Shape[] inputShapes)

Returns the shape of the specified direct parameter of this block given the shapes of the input to the block.

Specified by:

getParameterShape in interface Block

Parameters:

name - the name of the parameter

inputShapes - the shapes of the input to the block

Returns:

the shape of the parameter specified

forward

public NDList forward(ParameterStore parameterStore,
                      NDList inputs,
                      boolean training,
                      ai.djl.util.PairList<java.lang.String,java.lang.Object> params)

Applies the operating function of the block once. This method should be called only on blocks that are initialized.

Specified by:

forward in interface Block

Parameters:

parameterStore - the parameter store

inputs - the input NDList

training - true for a training forward pass

params - optional parameters

Returns:

the output of the forward pass

saveParameters

public void saveParameters(java.io.DataOutputStream os)
                    throws java.io.IOException

Writes the parameters of the block to the given outputStream.

Specified by:

saveParameters in interface Block

Parameters:

os - the outputstream to save the parameters to

Throws:

java.io.IOException - if an I/O error occurs

loadParameters

public void loadParameters(NDManager manager,
                           java.io.DataInputStream is)
                    throws java.io.IOException,
                           MalformedModelException

Loads the parameters from the given input stream.

Specified by:

loadParameters in interface Block

Parameters:

manager - an NDManager to create the parameter arrays

is - the inputstream that stream the parameter values

Throws:

java.io.IOException - if an I/O error occurs

MalformedModelException - if the model file is corrupted or unsupported

hasItem

public boolean hasItem(T item)

Returns whether an item is in the embedding.

Specified by:

hasItem in interface AbstractEmbedding<T>

Parameters:

item - the item to test

Returns:

true if the item is in the embedding

embed

public NDArray embed(NDManager manager,
                     T[] items)

Embeds an array of items.

Specified by:

embed in interface AbstractEmbedding<T>

Parameters:

manager - the manager for the new embeddings

items - the items to embed

Returns:

the embedding NDArray of Shape(items.length, embeddingSize)

embed

public int embed(T item)

Embeds an item.

Specified by:

embed in interface AbstractIndexedEmbedding<T>

Parameters:

item - the item to embed

Returns:

the embedding NDArray of Shape()

unembed

public java.util.Optional<T> unembed(int index)

Returns the item corresponding to the given index.

Specified by:

unembed in interface AbstractIndexedEmbedding<T>

Parameters:

index - the index

Returns:

the item corresponding to the given index