ai.djl.modality.nlp

Class SimpleVocabulary

java.lang.Object

ai.djl.modality.nlp.SimpleVocabulary

All Implemented Interfaces:

Vocabulary

public class SimpleVocabulary
extends java.lang.Object
implements Vocabulary

The simple implementation of Vocabulary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleVocabulary.VocabularyBuilder Builder class that is used to build the SimpleVocabulary.

Constructor Summary

Constructors

Constructor and Description
SimpleVocabulary(SimpleVocabulary.VocabularyBuilder builder) Create a SimpleVocabulary object with ta SimpleVocabulary.VocabularyBuilder.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllTokens() Returns all the tokens in the vocabulary.
long	getIndex(java.lang.String token) Returns the index of the given token.
java.lang.String	getToken(long index) Returns the token corresponding to the given index.
java.lang.String	getUnknownToken() Return a String used for unseen or rarely-seen tokens.
boolean	isKnownToken(java.lang.String token) Returns whether the given token is a known word.
int	size() Returns the size of the Vocabulary.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleVocabulary

public SimpleVocabulary(SimpleVocabulary.VocabularyBuilder builder)

Create a SimpleVocabulary object with ta SimpleVocabulary.VocabularyBuilder.

Parameters:

builder - the SimpleVocabulary.VocabularyBuilder to build the vocabulary with

Method Detail

isKnownToken

public boolean isKnownToken(java.lang.String token)

Returns whether the given token is a known word.

Parameters:

token - the token

Returns:

whether the given token is a known word

getUnknownToken

public java.lang.String getUnknownToken()

Return a String used for unseen or rarely-seen tokens.

Returns:

the String used for unseen or rarely-seen tokens

getToken

public java.lang.String getToken(long index)

Returns the token corresponding to the given index.

Specified by:

getToken in interface Vocabulary

Parameters:

index - the index

Returns:

the token corresponding to the given index

getAllTokens

public java.util.List<java.lang.String> getAllTokens()

Returns all the tokens in the vocabulary.

Returns:

the token corresponding to the given index

getIndex

public long getIndex(java.lang.String token)

Returns the index of the given token.

Specified by:

getIndex in interface Vocabulary

Parameters:

token - the token

Returns:

the index of the given token

size

public int size()

Returns the size of the Vocabulary.

Returns:

the size of the Vocabulary