edu.stanford.nlp.neural

Class VectorMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,float[]>

edu.stanford.nlp.neural.VectorMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,float[]>

public class VectorMap
extends java.util.HashMap<java.lang.String,float[]>

A serializer for reading / writing word vectors. This is used to read word2vec in hcoref, and is primarily here for its efficient serialization / deserialization protocol, which saves/loads the vectors as 16 bit floats.

Author:

Gabor Angeli

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
VectorMap() Create an empty word vector storage.
VectorMap(java.util.Map<java.lang.String,float[]> vectors) Initialize word vectors from a given map.

Method Summary

Modifier and Type	Method and Description
static VectorMap	deserialize(java.io.InputStream in) Read word vectors from an input stream.
static VectorMap	deserialize(java.lang.String file) Read word vectors from a file or classpath or url.
boolean	equals(java.lang.Object other)
int	hashCode()
static VectorMap	readWord2Vec(java.lang.String file) Read the Word2Vec word vector flat txt file.
void	serialize(java.io.OutputStream out) Write the word vectors to an output stream.
void	serialize(java.lang.String file) Write the word vectors to a file.
java.lang.String	toString()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VectorMap

public VectorMap()

Create an empty word vector storage.

VectorMap

public VectorMap(java.util.Map<java.lang.String,float[]> vectors)

Initialize word vectors from a given map.

Parameters:

vectors - The word vectors as a simple map.

Method Detail

serialize

public void serialize(java.lang.String file)
               throws java.io.IOException

Write the word vectors to a file.

Parameters:

file - The file to write to.

Throws:

java.io.IOException - Thrown if the file could not be written to.

serialize

public void serialize(java.io.OutputStream out)
               throws java.io.IOException

Write the word vectors to an output stream. The stream is not closed on finishing the function.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - Thrown if the stream could not be written to.

deserialize

public static VectorMap deserialize(java.lang.String file)
                             throws java.io.IOException

Read word vectors from a file or classpath or url.

Parameters:

file - The file to read from.

Returns:

The vectors in the file.

Throws:

java.io.IOException - Thrown if we could not read from the resource

deserialize

public static VectorMap deserialize(java.io.InputStream in)
                             throws java.io.IOException

Read word vectors from an input stream. The stream is not closed on finishing the function.

Parameters:

in - The stream to read from. This is not closed.

Returns:

The word vectors encoded on the stream.

Throws:

java.io.IOException - Thrown if we could not read from the stream.

readWord2Vec

public static VectorMap readWord2Vec(java.lang.String file)

Read the Word2Vec word vector flat txt file.

Parameters:

file - The word2vec text file.

Returns:

The word vectors in the file.

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.util.Map<java.lang.String,float[]>

Overrides:

equals in class java.util.AbstractMap<java.lang.String,float[]>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,float[]>

Overrides:

hashCode in class java.util.AbstractMap<java.lang.String,float[]>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.String,float[]>