com.cloudera.oryx.api.serving

Class AbstractServingModelManager<U>

java.lang.Object

com.cloudera.oryx.api.serving.AbstractServingModelManager<U>

Type Parameters:

U - type of update message read/written

All Implemented Interfaces:

ServingModelManager<U>, Closeable, AutoCloseable

Direct Known Subclasses:

ALSServingModelManager, ExampleServingModelManager, KMeansServingModelManager, RDFServingModelManager

public abstract class AbstractServingModelManager<U>
extends Object
implements ServingModelManager<U>

Convenience implementation of ServingModelManager that provides several default implementations.

Since:

2.0.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServingModelManager(com.typesafe.config.Config config)

Method Summary

Modifier and Type	Method and Description
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.
void	consumeKeyMessage(String key, U message, org.apache.hadoop.conf.Configuration hadoopConf) Convenience method that is called by the default implementation of consume(Iterator, Configuration), to process one key-message pair.
com.typesafe.config.Config	getConfig()
boolean	isReadOnly()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudera.oryx.api.serving.ServingModelManager

close, getModel

Constructor Detail

AbstractServingModelManager

protected AbstractServingModelManager(com.typesafe.config.Config config)

Parameters:

config - Oryx Config object

Since:

2.0.0

Method Detail

getConfig

public com.typesafe.config.Config getConfig()

Specified by:

getConfig in interface ServingModelManager<U>

Returns:

configuration for the serving layer

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ServingModelManager<U>

Returns:

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

consume

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

Description copied from interface: ServingModelManager

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.

Specified by:

consume in interface ServingModelManager<U>

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

consumeKeyMessage

public void consumeKeyMessage(String key,
                              U message,
                              org.apache.hadoop.conf.Configuration hadoopConf)
                       throws IOException

Convenience method that is called by the default implementation of consume(Iterator, Configuration), to process one key-message pair. It does nothing, except log the message. This should generally be overridden if and only if consume(Iterator, Configuration) is not.

Parameters:

key - key to process (non-null)

message - message to process

hadoopConf - Hadoop configuration for process

Throws:

IOException - if an error occurs while processing the message

Since:

2.3.0