org.dkpro.core.api.embeddings.binary

Class BinaryVectorizer

java.lang.Object

org.dkpro.core.api.embeddings.binary.BinaryVectorizer

All Implemented Interfaces:

Vectorizer

public class BinaryVectorizer
extends Object
implements Vectorizer

A Vectorizer for a binary file. Initialize with load(File).

See Also:

BinaryWordVectorUtils

Method Summary

Modifier and Type	Method and Description
boolean	contains(String aWord) True if the token is known by the vectorizer.
int	dimensions() The dimensionality of the embeddings
boolean	isCaseless()
static BinaryVectorizer	load(File f) Load a binary embeddings file and return a new BinaryVectorizer object.
int	size() The total number of known tokens.
float[]	unknownVector() The vector for unknown tokens.
float[]	vectorize(String aWord) Get the vector for a token.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static BinaryVectorizer load(File f)
                             throws IOException

Load a binary embeddings file and return a new BinaryVectorizer object.

Parameters:

f - a File

Returns:

a new BinaryVectorizer

Throws:

IOException - if an I/O error occurs

vectorize

public float[] vectorize(String aWord)
                  throws IOException

Description copied from interface: Vectorizer

Get the vector for a token. If the token is unknown, implementing classes should return the Vectorizer.unknownVector().

Specified by:

vectorize in interface Vectorizer

Parameters:

aWord - a token String

Returns:

a float array

Throws:

IOException - if there was an error accessing the vector file.

contains

public boolean contains(String aWord)

Description copied from interface: Vectorizer

True if the token is known by the vectorizer.

Specified by:

contains in interface Vectorizer

Parameters:

aWord - a token String

Returns:

true if the token is known

unknownVector

public float[] unknownVector()

Description copied from interface: Vectorizer

The vector for unknown tokens.

Specified by:

unknownVector in interface Vectorizer

Returns:

a float array

dimensions

public int dimensions()

Description copied from interface: Vectorizer

The dimensionality of the embeddings

Specified by:

dimensions in interface Vectorizer

Returns:

an int

size

public int size()

Description copied from interface: Vectorizer

The total number of known tokens.

Specified by:

size in interface Vectorizer

Returns:

an int

isCaseless

public boolean isCaseless()

Specified by:

isCaseless in interface Vectorizer