org.deeplearning4j.nn.modelexport.solr.ltr.model

Class ScoringModel

java.lang.Object

org.apache.solr.ltr.model.LTRScoringModel

org.apache.solr.ltr.model.AdapterModel

org.deeplearning4j.nn.modelexport.solr.ltr.model.ScoringModel

public class ScoringModel
extends org.apache.solr.ltr.model.AdapterModel

An org.apache.solr.ltr.model.LTRScoringModel that computes scores using a MultiLayerNetwork or ComputationGraph model.

Example configuration (snippet):

{
  "class" : "org.deeplearning4j.nn.modelexport.solr.ltr.model.ScoringModel",
  "name" : "myModel",
  "features" : [
    { "name" : "documentRecency", ... },
    { "name" : "isBook", ... },
    { "name" : "originalScore", ... }
  ],
  "params" : {
    "serializedModelFileName" : "mySerializedModel"
  }
}

Apache Solr Reference Guide:

• Learning To Rank

Field Summary

Fields

Modifier and Type	Field and Description
protected org.deeplearning4j.nn.api.Model	model

Fields inherited from class org.apache.solr.ltr.model.AdapterModel

solrResourceLoader

Fields inherited from class org.apache.solr.ltr.model.LTRScoringModel

features, name, norms

Constructor Summary

Constructors

Constructor and Description
ScoringModel(String name, List<org.apache.solr.ltr.feature.Feature> features, List<org.apache.solr.ltr.norm.Normalizer> norms, String featureStoreName, List<org.apache.solr.ltr.feature.Feature> allFeatures, Map<String,Object> params)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Explanation	explain(org.apache.lucene.index.LeafReaderContext context, int doc, float finalScore, List<org.apache.lucene.search.Explanation> featureExplanations)
void	init(org.apache.solr.core.SolrResourceLoader solrResourceLoader)
protected InputStream	openInputStream()
static float	outputScore(org.deeplearning4j.nn.api.Model model, float[] modelFeatureValuesNormalized) Uses the NetworkUtils.output(Model, INDArray) method.
protected org.deeplearning4j.nn.api.Model	restoreModel(InputStream inputStream) Uses the ModelGuesser.loadModelGuess(InputStream) method.
float	score(float[] modelFeatureValuesNormalized)
void	setSerializedModelFileName(String serializedModelFileName)
protected void	validate()
protected void	validateModel()

Methods inherited from class org.apache.solr.ltr.model.LTRScoringModel

equals, getAllFeatures, getFeatures, getFeatureStoreName, getInstance, getName, getNormalizerExplanation, getNorms, getParams, hashCode, normalizeFeaturesInPlace, toString

Methods inherited from class java.lang.Object

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

Field Detail

model

protected org.deeplearning4j.nn.api.Model model

Constructor Detail

ScoringModel

public ScoringModel(String name,
                    List<org.apache.solr.ltr.feature.Feature> features,
                    List<org.apache.solr.ltr.norm.Normalizer> norms,
                    String featureStoreName,
                    List<org.apache.solr.ltr.feature.Feature> allFeatures,
                    Map<String,Object> params)

Method Detail

setSerializedModelFileName

public void setSerializedModelFileName(String serializedModelFileName)

init

public void init(org.apache.solr.core.SolrResourceLoader solrResourceLoader)
          throws org.apache.solr.ltr.model.ModelException

Overrides:

init in class org.apache.solr.ltr.model.AdapterModel

Throws:

org.apache.solr.ltr.model.ModelException

openInputStream

protected InputStream openInputStream()
                               throws IOException

Throws:

IOException

restoreModel

protected org.deeplearning4j.nn.api.Model restoreModel(InputStream inputStream)
                                                throws Exception

Uses the ModelGuesser.loadModelGuess(InputStream) method.

Throws:

Exception

validate

protected void validate()
                 throws org.apache.solr.ltr.model.ModelException

Overrides:

validate in class org.apache.solr.ltr.model.LTRScoringModel

Throws:

org.apache.solr.ltr.model.ModelException

validateModel

protected void validateModel()
                      throws org.apache.solr.ltr.model.ModelException

Throws:

org.apache.solr.ltr.model.ModelException

score

public float score(float[] modelFeatureValuesNormalized)

Specified by:

score in class org.apache.solr.ltr.model.LTRScoringModel

outputScore

public static float outputScore(org.deeplearning4j.nn.api.Model model,
                                float[] modelFeatureValuesNormalized)

Uses the NetworkUtils.output(Model, INDArray) method.

explain

public org.apache.lucene.search.Explanation explain(org.apache.lucene.index.LeafReaderContext context,
                                                    int doc,
                                                    float finalScore,
                                                    List<org.apache.lucene.search.Explanation> featureExplanations)

Specified by:

explain in class org.apache.solr.ltr.model.LTRScoringModel