com.cloudera.oryx.api.serving

Interface ServingModelManager<U>

Type Parameters:

U - type of update message read/written

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractServingModelManager, ALSServingModelManager, ExampleServingModelManager, KMeansServingModelManager, RDFServingModelManager, ScalaServingModelManagerAdapter

public interface ServingModelManager<U>
extends Closeable

Implementations of this interface maintain, in memory, the current state of a model in the serving layer. It is given a reference to a stream of updates during initialization, and consumes models and updates from it, and updates in-memory state accordingly.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
default void	close()
void	consume(Iterator<KeyMessage<String,U>> updateIterator, org.apache.hadoop.conf.Configuration hadoopConf) Called by the framework to initiate a continuous process of reading models, and reading from the input topic and updating model state in memory, and issuing updates to the update topic.
com.typesafe.config.Config	getConfig()
ServingModel	getModel()
boolean	isReadOnly()

Method Detail

consume

void consume(Iterator<KeyMessage<String,U>> updateIterator,
             org.apache.hadoop.conf.Configuration hadoopConf)
      throws IOException

Called by the framework to initiate a continuous process of reading models, and reading from the input topic and updating model state in memory, and issuing updates to the update topic. This will be executed asynchronously and may block. Note that an exception or error thrown from this method is fatal and shuts down processing.

Parameters:

updateIterator - iterator to read models from

hadoopConf - Hadoop context, which may be required for reading from HDFS

Throws:

IOException - if an error occurs while reading updates

Since:

2.0.0

getConfig

com.typesafe.config.Config getConfig()

Returns:

configuration for the serving layer

Since:

2.0.0

getModel

ServingModel getModel()

Returns:

in-memory model representation

Since:

2.0.0

isReadOnly

boolean isReadOnly()

Returns:

true iff the model is considered read-only and not updateable

Since:

2.0.0

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Since:

2.0.0