magpie.models.interfaces

Interface ExternalModel

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

ScikitLearnClassifier, ScikitLearnRegression

public interface ExternalModel
extends java.lang.AutoCloseable

Interface for models that run their model in a separate thread and communicate to it via a socket connection. Assumes that the model object is communicated over some kind of stream, and stored inside the Magpie Java object.

Method Summary

Modifier and Type	Method and Description
void	closeServer() Set a command to the model server that we are done with it.
int	getPort() Get the port number for this model's server
java.lang.Process	getProcess() Get the process holding this external port
void	readModel(java.io.InputStream input) Read file describing model into memory
boolean	serverIsRunning() Check whether the server is running
void	setCompressionLevel(int level) Define how well model file is compressed
void	startServer() Start the server hosting the model.
void	writeModel(java.io.OutputStream output) Write model to an output stream

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

startServer

void startServer()
          throws java.lang.Exception

Start the server hosting the model. This process will initialize the server and set the communication port number.

Throws:

java.lang.Exception

getProcess

java.lang.Process getProcess()

Get the process holding this external port

Returns:

serverIsRunning

boolean serverIsRunning()

Check whether the server is running

Returns:

Whether server is running

getPort

int getPort()

Get the port number for this model's server

Returns:

Port number. If server is not running, this is meaningless

closeServer

void closeServer()

Set a command to the model server that we are done with it. Use when program is done with a model, and needs to clear up port

readModel

void readModel(java.io.InputStream input)
        throws java.lang.Exception

Read file describing model into memory

Parameters:

input - Input stream providing model data

Throws:

java.io.IOException

java.lang.Exception

setCompressionLevel

void setCompressionLevel(int level)
                  throws java.lang.Exception

Define how well model file is compressed

Parameters:

level - Desired level. 1: Fastest, 9: Smallest memory footprint

Throws:

java.lang.Exception

See Also:

#ScikitModel

writeModel

void writeModel(java.io.OutputStream output)
         throws java.io.IOException

Write model to an output stream

Parameters:

output -

Throws:

java.io.IOException