edu.stanford.nlp.neural

Class ConvertModels

java.lang.Object

edu.stanford.nlp.neural.ConvertModels

public class ConvertModels
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConvertModels.Model
static class	ConvertModels.Stage

Constructor Summary

Constructors

Constructor and Description
ConvertModels()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.util.List<java.lang.Double>>	fromMatrix(org.ejml.simple.SimpleMatrix in)
static java.util.List<java.util.List<java.util.List<java.lang.Double>>>	fromTensor(SimpleTensor in)
static void	main(java.lang.String[] args) This program converts a sentiment model or an RNN parser model from EJML v23, used by CoreNLP 3.9.2, to a more recent version of EJML, such as v38.
static NeuralCorefModel	readCoref(java.io.ObjectInputStream in)
static Embedding	readEmbedding(java.io.ObjectInputStream in)
static FastNeuralCorefModel	readFastCoref(java.io.ObjectInputStream in)
static LexicalizedParser	readParser(java.io.ObjectInputStream in)
static SentimentModel	readSentiment(java.io.ObjectInputStream in)
static org.ejml.simple.SimpleMatrix	toMatrix(java.util.List<java.util.List<java.lang.Double>> in)
static SimpleTensor	toTensor(java.util.List<java.util.List<java.util.List<java.lang.Double>>> in)
static <K1,K2,V,V2> TwoDimensionalMap<K1,K2,V2>	transform2DMap(TwoDimensionalMap<K1,K2,V> in, java.util.function.Function<V,V2> function) Transform this map into a new map using the given function
static <K,V,V2> java.util.Map<K,V2>	transformMap(java.util.Map<K,V> in, java.util.function.Function<V,V2> function)
static void	writeCoref(NeuralCorefModel model, java.io.ObjectOutputStream out)
static void	writeEmbedding(Embedding embedding, java.io.ObjectOutputStream out)
static void	writeFastCoref(FastNeuralCorefModel model, java.io.ObjectOutputStream out)
static void	writeParser(LexicalizedParser model, DVModelReranker reranker, java.io.ObjectOutputStream out)
static void	writeSentiment(SentimentModel model, java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertModels

public ConvertModels()

Method Detail

transform2DMap

public static <K1,K2,V,V2> TwoDimensionalMap<K1,K2,V2> transform2DMap(TwoDimensionalMap<K1,K2,V> in,
                                                                      java.util.function.Function<V,V2> function)

Transform this map into a new map using the given function

fromMatrix

public static java.util.List<java.util.List<java.lang.Double>> fromMatrix(org.ejml.simple.SimpleMatrix in)

fromTensor

public static java.util.List<java.util.List<java.util.List<java.lang.Double>>> fromTensor(SimpleTensor in)

toMatrix

public static org.ejml.simple.SimpleMatrix toMatrix(java.util.List<java.util.List<java.lang.Double>> in)

toTensor

public static SimpleTensor toTensor(java.util.List<java.util.List<java.util.List<java.lang.Double>>> in)

transformMap

public static <K,V,V2> java.util.Map<K,V2> transformMap(java.util.Map<K,V> in,
                                                        java.util.function.Function<V,V2> function)

writeSentiment

public static void writeSentiment(SentimentModel model,
                                  java.io.ObjectOutputStream out)
                           throws java.io.IOException

Throws:

java.io.IOException

readSentiment

public static SentimentModel readSentiment(java.io.ObjectInputStream in)
                                    throws java.io.IOException,
                                           java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeParser

public static void writeParser(LexicalizedParser model,
                               DVModelReranker reranker,
                               java.io.ObjectOutputStream out)
                        throws java.io.IOException

Throws:

java.io.IOException

readParser

public static LexicalizedParser readParser(java.io.ObjectInputStream in)
                                    throws java.io.IOException,
                                           java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeEmbedding

public static void writeEmbedding(Embedding embedding,
                                  java.io.ObjectOutputStream out)
                           throws java.io.IOException

Throws:

java.io.IOException

readEmbedding

public static Embedding readEmbedding(java.io.ObjectInputStream in)
                               throws java.io.IOException,
                                      java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeCoref

public static void writeCoref(NeuralCorefModel model,
                              java.io.ObjectOutputStream out)
                       throws java.io.IOException

Throws:

java.io.IOException

readCoref

public static NeuralCorefModel readCoref(java.io.ObjectInputStream in)
                                  throws java.io.IOException,
                                         java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeFastCoref

public static void writeFastCoref(FastNeuralCorefModel model,
                                  java.io.ObjectOutputStream out)
                           throws java.io.IOException

Throws:

java.io.IOException

readFastCoref

public static FastNeuralCorefModel readFastCoref(java.io.ObjectInputStream in)
                                          throws java.io.IOException,
                                                 java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException,
                        java.lang.InstantiationException,
                        java.lang.NoSuchMethodException

This program converts a sentiment model or an RNN parser model from EJML v23, used by CoreNLP 3.9.2, to a more recent version of EJML, such as v38. The reason for this is that the EJML v31 update changed the serialization of SimpleMatrix in a way that broke all the old models, so for years we never bit the bullet of upgrading. This script handles the upgrade of our models which use SimpleMatrix. It needs to be done in two steps.
The first conversion turns a model into a file with lists of doubles in place of the SimpleMatrix objects used in ejml.
The second conversion turns the lists of doubles back into a new SentimentModel or RNN parser.
In between the two steps you should replace the EJML version you are using with 0.38, although no one is judging you if you aimlessly convert back and forth using the same EJML version.
Concrete steps:
java edu.stanford.nlp.neural.ConvertModels -stage OLD -model SENTIMENT -input edu/stanford/nlp/models/sentiment/sentiment.ser.gz -output sentiment.INT.ser.gz
... update EJML library to v38 or a later
java edu.stanford.nlp.neural.ConvertModels -stage NEW -model SENTIMENT -input sentiment.INT.ser.gz -output sentiment.38.ser.gz
Congratulations, your old model will now work with EJML v38.
To upgrade an RNN model (did anyone train this themselves?) use -model DVPARSER
java edu.stanford.nlp.neural.ConvertModels -stage OLD -model DVPARSER -input /u/nlp/data/lexparser/chineseRNN.e21.ser.gz -output /u/nlp/data/lexparser/chineseRNN.INT.ser.gz
java edu.stanford.nlp.neural.ConvertModels -stage NEW -model DVPARSER -input /u/nlp/data/lexparser/chineseRNN.INT.ser.gz -output /u/nlp/data/lexparser/chineseRNN.e38.ser.gz
To upgrade a neural coref model, use -model COREF
java edu.stanford.nlp.neural.ConvertModels -stage OLD -model COREF -input /scr/nlp/data/coref/models/neural/english/english-model-default.ser.gz -output /scr/nlp/data/coref/models/neural/english/english-model-default.INT.ser.gz
java edu.stanford.nlp.neural.ConvertModels -stage NEW -model COREF -input /scr/nlp/data/coref/models/neural/english/english-model-default.INT.ser.gz -output /scr/nlp/data/coref/models/neural/english/english-model-default.e39.ser.gz
Neural coref models ship with a separate embedding file, although these are also embedded in the model itself. To upgrade this, use -model EMBEDDING
java edu.stanford.nlp.neural.ConvertModels -stage OLD -model EMBEDDING -input /scr/nlp/data/coref/models/neural/english/english-embeddings.e38.ser.gz -output /scr/nlp/data/coref/models/neural/english/english-embeddings.INT.ser.gz
java edu.stanford.nlp.neural.ConvertModels -stage NEW -model EMBEDDING -input /scr/nlp/data/coref/models/neural/english/english-embeddings.INT.ser.gz -output /scr/nlp/data/coref/models/neural/english/english-embeddings.e39.ser.gz
There is another coref model which isn't used in corenlp, but it might be in the future. To upgrade this, use -model FASTCOREF
java edu.stanford.nlp.neural.ConvertModels -stage OLD -model FASTCOREF -input /scr/nlp/data/coref/models/fastneural/fast-english-model.e38.ser.gz -output /scr/nlp/data/coref/models/fastneural/fast-english-model.INT.ser.gz
java edu.stanford.nlp.neural.ConvertModels -stage NEW -model FASTCOREF -input /scr/nlp/data/coref/models/fastneural/fast-english-model.INT.ser.gz -output /scr/nlp/data/coref/models/fastneural/fast-english-model.e39.ser.gz

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.NoSuchMethodException