ModelTupleStream (deeplearning4j 1.0.0-beta6 API)

java.lang.Object
- org.apache.solr.client.solrj.io.stream.TupleStream
- - org.deeplearning4j.nn.modelexport.solr.handler.ModelTupleStream

All Implemented Interfaces:: Closeable, Serializable, AutoCloseable, org.apache.solr.client.solrj.io.stream.expr.Expressible, org.apache.solr.common.MapSerializable, org.apache.solr.common.MapWriter, org.apache.solr.common.NavigableObject

public class ModelTupleStream
extends org.apache.solr.client.solrj.io.stream.TupleStream
implements org.apache.solr.client.solrj.io.stream.expr.Expressible

A org.apache.solr.client.solrj.io.stream.TupleStream that uses a Model to compute output scores. Tuple fields are the model inputs and the model output(s) are added to the returned tuple.

Illustrative configuration snippet:

  <expressible name="emailModel" class="org.deeplearning4j.nn.modelexport.solr.handler.ModelTupleStream"/>

Illustrative expression snippet:

  emailModel(search(myCollection,
                    q="*:*",
                    fl="id,fieldX,fieldY,fieldZ",
                    sort="id asc",
                    qt="/export"),
             serializedModelFileName="mySerializedModel",
             inputKeys="fieldX,fieldY,fieldZ",
             outputKeys="modelScoreField1,modelScoreField2")

Apache Solr Reference Guide:

Streaming Expressions

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.solr.client.solrj.io.stream.TupleStream
  org.apache.solr.client.solrj.io.stream.TupleStream.IgnoreException
- Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter
  org.apache.solr.common.MapWriter.EntryWriter

Constructor Summary

Constructors
Constructor and Description
`ModelTupleStream(org.apache.solr.client.solrj.io.stream.expr.StreamExpression streamExpression, org.apache.solr.client.solrj.io.stream.expr.StreamFactory streamFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.apache.solr.client.solrj.io.Tuple`	`applyOutputsToTuple(org.apache.solr.client.solrj.io.Tuple tuple, INDArray output)`
`List<org.apache.solr.client.solrj.io.stream.TupleStream>`	`children()`
`void`	`close()`
`protected INDArray`	`getInputsFromTuple(org.apache.solr.client.solrj.io.Tuple tuple)`
`org.apache.solr.client.solrj.io.comp.StreamComparator`	`getStreamSort()`
`void`	`open()`
`protected InputStream`	`openInputStream()`
`org.apache.solr.client.solrj.io.Tuple`	`read()`
`protected Model`	`restoreModel(InputStream inputStream)` Uses the `ModelGuesser.loadModelGuess(InputStream)` method.
`void`	`setStreamContext(org.apache.solr.client.solrj.io.stream.StreamContext streamContext)`
`org.apache.solr.client.solrj.io.stream.expr.Explanation`	`toExplanation(org.apache.solr.client.solrj.io.stream.expr.StreamFactory streamFactory)`
`org.apache.solr.client.solrj.io.stream.expr.StreamExpressionParameter`	`toExpression(org.apache.solr.client.solrj.io.stream.expr.StreamFactory streamFactory)`
`Map`	`toMap(Map<String,Object> map)`

Methods inherited from class org.apache.solr.client.solrj.io.stream.TupleStream
getCost, getShards, getStreamNodeId, writeMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.common.MapWriter
jsonStr

Methods inherited from interface org.apache.solr.common.NavigableObject
_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr

Constructor Detail

ModelTupleStream

public ModelTupleStream(org.apache.solr.client.solrj.io.stream.expr.StreamExpression streamExpression,
                        org.apache.solr.client.solrj.io.stream.expr.StreamFactory streamFactory)
                 throws IOException

Throws:: IOException

Method Detail

toMap
```
public Map toMap(Map<String,Object> map)
```
Specified by:

toMap in interface org.apache.solr.common.MapSerializable

Specified by:

toMap in interface org.apache.solr.common.MapWriter

setStreamContext
```
public void setStreamContext(org.apache.solr.client.solrj.io.stream.StreamContext streamContext)
```
Specified by:

setStreamContext in class org.apache.solr.client.solrj.io.stream.TupleStream

children
```
public List<org.apache.solr.client.solrj.io.stream.TupleStream> children()
```
Specified by:

children in class org.apache.solr.client.solrj.io.stream.TupleStream

open
```
public void open()
          throws IOException
```
Specified by:

open in class org.apache.solr.client.solrj.io.stream.TupleStream

Throws:

IOException

close
```
public void close()
           throws IOException
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class org.apache.solr.client.solrj.io.stream.TupleStream

Throws:

IOException

read

public org.apache.solr.client.solrj.io.Tuple read()
                                           throws IOException

Specified by:: read in class org.apache.solr.client.solrj.io.stream.TupleStream
Throws:: IOException

getStreamSort
```
public org.apache.solr.client.solrj.io.comp.StreamComparator getStreamSort()
```
Specified by:

getStreamSort in class org.apache.solr.client.solrj.io.stream.TupleStream

toExplanation

public org.apache.solr.client.solrj.io.stream.expr.Explanation toExplanation(org.apache.solr.client.solrj.io.stream.expr.StreamFactory streamFactory)
                                                                      throws IOException

Specified by:: toExplanation in interface org.apache.solr.client.solrj.io.stream.expr.Expressible
Specified by:: toExplanation in class org.apache.solr.client.solrj.io.stream.TupleStream
Throws:: IOException

toExpression

public org.apache.solr.client.solrj.io.stream.expr.StreamExpressionParameter toExpression(org.apache.solr.client.solrj.io.stream.expr.StreamFactory streamFactory)
                                                                                   throws IOException

Specified by:: toExpression in interface org.apache.solr.client.solrj.io.stream.expr.Expressible
Throws:: IOException

openInputStream

protected InputStream openInputStream()
                               throws IOException

Throws:: IOException

restoreModel

protected Model restoreModel(InputStream inputStream)
                      throws IOException

Uses the ModelGuesser.loadModelGuess(InputStream) method.

Throws:: IOException

getInputsFromTuple

protected INDArray getInputsFromTuple(org.apache.solr.client.solrj.io.Tuple tuple)

applyOutputsToTuple

protected org.apache.solr.client.solrj.io.Tuple applyOutputsToTuple(org.apache.solr.client.solrj.io.Tuple tuple,
                                                                    INDArray output)

Class ModelTupleStream

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.client.solrj.io.stream.TupleStream

Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter

Constructor Summary

Method Summary

Methods inherited from class org.apache.solr.client.solrj.io.stream.TupleStream

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.solr.common.MapWriter

Methods inherited from interface org.apache.solr.common.NavigableObject

Constructor Detail

ModelTupleStream

Method Detail

toMap

setStreamContext

children

open

close