Architecture Diagrams for /oryxproject/oryx[edit]
Packages / com.cloudera.oryx

Package com.cloudera.oryx

com.cloudera.oryx
com.cloudera.oryx.api
KeyMessage
Simple interface encapsulating a key and message in a topic.
KeyMessageImpl
Simple value class encapsulating a key and message in a topic.
TopicProducer
Wraps access to a message topic Producer , including logic to instantia...
com.cloudera.oryx.api.batch
BatchLayerUpdate
Implementations of this interface define the update process for an inst...
com.cloudera.oryx.api.serving
A
AbstractServingModelManager
Convenience implementation of ServingModelManager that provides several...
HasCSV
Implementations of this interface can produce a CSV representation. Thi...
A
OryxResource
A utility class that can serve as a superclass of Serving Layer applica...
OryxServingException
Thrown by Serving Layer endpoints to indicate an error in processing.
ServingModel
Interface that all Serving Layer in-memory models implement.
ServingModelManager
Implementations of this interface maintain, in memory, the current stat...
com.cloudera.oryx.api.speed
A
AbstractSpeedModelManager
Convenience implementation of SpeedModelManager that provides default i...
SpeedModel
Interface that all Speed Layer in-memory models implement.
SpeedModelManager
Implementations of this interface maintain, in memory, the current stat...
com.cloudera.oryx.app
com.cloudera.oryx.app.als
ALSUtils
ALS-related utility methods for the app tier.
A
AbstractRescorerProvider
Abstract implementation of RescorerProvider which implements all method...
FeatureVectors
Encapsulates a feature vectors, keyed by an ID, and associated data str...
FeatureVectorsPartition
Encapsulates a feature vectors, keyed by an ID, and associated data str...
MultiRescorer
Convenience implementation that will aggregate the behavior of multiple...
MultiRescorerProvider
Convenience implementation that will aggregate the behavior of Rescorer...
PartitionedFeatureVectors
Encapsulates a feature vectors, keyed by an ID, and associated data str...
Rescorer
Implementations of this interface can "rescore" the recommender's score...
RescorerProvider
Implementations of this interface provide, optionally, objects that ca...
SolverCache
A cache around a Solver that manages computing it when necessary from F...
com.cloudera.oryx.app.batch
com.cloudera.oryx.app.batch.mllib
com.cloudera.oryx.app.batch.mllib.als
ALSUpdate
A specialization of MLUpdate that creates a matrix factorization model...
EnqueueFeatureVecsAndKnownItemsFn
EnqueueFeatureVecsFn
Evaluation
Computes AUC (area under the ROC curve) as a recommender evaluation met...
com.cloudera.oryx.app.batch.mllib.kmeans
A
AbstractKMeansEvaluation
ClusterMetric
DaviesBouldinIndex
DunnIndex
E
KMeansEvalStrategy
Evaluation metrics for k-means clustering.
KMeansUpdate
Update function that builds and evaluates k-means models in the Batch L...
SilhouetteCoefficient
SumSquaredError
com.cloudera.oryx.app.batch.mllib.rdf
Evaluation
RDFUpdate
Update function that builds and evaluates random decision forest models...
com.cloudera.oryx.app.classreg
com.cloudera.oryx.app.classreg.example
CategoricalFeature
Represents a value of a categorical feature -- one that takes on discre...
Example
Encapsulates one example, or data point: a set of features that predict...
ExampleUtils
Utility methods supporting the Example class, like factory methods.
Feature
Implementations represent the value of one feature in an Example .
E
FeatureType
Represents the type of a Feature .
NumericFeature
Represents the value of a numeric feature -- one that takes on a real v...
com.cloudera.oryx.app.classreg.predict
CategoricalPrediction
Represents a prediction of the value of a categorical target. The predi...
NumericPrediction
Represents a predicted value of a numeric target. The prediction is sim...
A
Prediction
Subclasses represent the predicted value of the target.
WeightedPrediction
A utility class with methods for combining the results of many com.clou...
com.cloudera.oryx.app.common
com.cloudera.oryx.app.common.fn
MLFunctions
Contains some reusable functions that are useful for ML-related apps fr...
com.cloudera.oryx.app.kmeans
ClusterInfo
Encapsulates a cluster, including its center and number of points assig...
DistanceFn
A function that returns a distance between things.
EuclideanDistanceFn
Returns the Euclidean distance between two double[] .
KMeansPMMLUtils
Utility methods related to PMML serialization of k-means clustering mod...
KMeansUtils
K-means-related utility methods for the app tier.
com.cloudera.oryx.app.pmml
AppPMMLUtils
General app tier PMML-related utility methods.
com.cloudera.oryx.app.rdf
RDFPMMLUtils
Utility methods related to PMML serialization of random decision forest...
com.cloudera.oryx.app.rdf.decision
CategoricalDecision
Represents a decision over a categorical feature. If the categorical fe...
A
Decision
Subclasses represent a binary yes/no positive/negative decision based o...
NumericDecision
Represents a decision over a numeric feature. Decisions are defined sim...
com.cloudera.oryx.app.rdf.tree
DecisionForest
An ensemble classifier based on many DecisionTree s.
DecisionNode
Represents an internal node in a DecisionTree , which encapsulates a bi...
DecisionTree
A decision-tree classifier. Given a set of training Example s, builds a...
TerminalNode
Represents a leaf node in a DecisionTree , which contains a Prediction ...
TreeBasedClassifier
Base interface for decision-tree-based classifiers in this package, whe...
A
TreeNode
Implementations of this interface represent nodes in a DecisionTree , w...
TreePath
Encapsulates a path from root to a node in the tree.
com.cloudera.oryx.app.schema
CategoricalValueEncodings
Encapsulates a two-way mapping between the set of values for one catego...
InputSchema
Represents the essential schema information needed for some learning pr...
com.cloudera.oryx.app.serving
A
AbstractConsoleResource
Superclass of web resources that contain a small console for a Serving ...
A
AbstractOryxResource
Superclass of all Serving Layer application endpoints.
FileItemPart
Adapter from FileItem to Part , for use in tests while still necessary ...
IDCount
Encapsulates a String ID and a count.
A
IDEntity
Superclass of objects that encapsulate, among other things, a String ID.
IDValue
Encapsulates a String ID and a floating-point value.
Ready
Responds to a HEAD or GET request to /ready and returns Response.Statu...
com.cloudera.oryx.app.serving.als
A
AbstractALSResource
Superclass of all Serving Layer ALS application endpoints.
AllItemIDs
Responds to a GET request to /item/allIDs . CSV output consists of one...
AllUserIDs
Responds to a GET request to /user/allIDs . CSV output consists of one...
Because
Responds to a GET request to /because/[userID]/[itemID](?howMany=n)(&o...
Console
ALS app Serving Layer console.
CosineAverageFunction
Computes the cosine of the angle between a target vector and other vect...
CosineDistanceSensitiveFunction
Implementations of this type of function return a value that depends on...
DotsFunction
Computes the dot product of a target vector and other vectors.
Estimate
Responds to a GET request to /estimate/[userID]/[itemID] . The results...
EstimateForAnonymous
Responds to a GET request to /estimateForAnonymous/[toItemID]/[itemID1...
Ingest
Responds to a POST to /ingest . For each line in the request body, a l...
KnownItems
Responds to a GET request to /knownItems/[userID] . CSV output consist...
MostActiveUsers
Responds to a GET request to /mostActiveUsers(?howMany=n)(&offset=o)(&...
MostPopularItems
Responds to a GET request to /mostPopularItems(?howMany=n)(&offset=o)(...
MostSurprising
Responds to a GET request to /mostSurprising/[userID](?howMany=n)(?off...
PopularRepresentativeItems
Responds to a GET request to /popularRepresentativeItems . The result ...
Preference
Responds to a POST request to /pref/[userID]/[itemID] . The first line...
Recommend
Responds to a GET request to /recommend/[userID](?howMany=n)(&offset=o...
RecommendToAnonymous
Responds to a GET request to /recommendToAnonymous/[itemID1(=value1)](...
RecommendToMany
Responds to a GET request to /recommendToMany/[userID1](/[userID2]/......
RecommendWithContext
Responds to a GET request to /recommendWithContext/[userID]/([itemID1(...
Similarity
Responds to a GET request to /similarity/[itemID1](/[itemID2]/...)(?ho...
SimilarityToItem
Responds to a GET request to /similarityToItem/[toItemID]/[itemID1](/[...
com.cloudera.oryx.app.serving.als.model
ALSServingModel
Contains all data structures needed to serve real-time requests for an ...
ALSServingModelManager
A com.cloudera.oryx.api.serving.ServingModelManager that manages and pr...
LocalitySensitiveHash
TopNConsumer
com.cloudera.oryx.app.serving.classreg
Predict
Responds to a GET request to /predict/[datum] , or a POST to /predict ...
Train
Responds to POST request to /train . The input is one or more data poi...
com.cloudera.oryx.app.serving.classreg.model
ClassificationRegressionServingModel
Implementations are ServingModel s that specifically support classifica...
com.cloudera.oryx.app.serving.clustering
Add
Responds to POST request to /add . The input is one or more data point...
Assign
Responds to a GET request to /assign/[datum] , or a POST to /assign co...
com.cloudera.oryx.app.serving.clustering.model
ClusteringServingModel
Implementations are ServingModel s that specifically support clustering...
com.cloudera.oryx.app.serving.kmeans
Console
k-means app Serving Layer console.
DistanceToNearest
Responds to a GET request to /distanceToNearest/[datum] . The inputs i...
com.cloudera.oryx.app.serving.kmeans.model
KMeansServingModel
Contains all data structures needed to serve queries for a k-means clus...
KMeansServingModelManager
A com.cloudera.oryx.api.serving.ServingModelManager that manages and pr...
com.cloudera.oryx.app.serving.rdf
ClassificationDistribution
Responds to a GET request to /classificationDistribution/[datum] . Lik...
Console
Random decision forest app Serving Layer console.
FeatureImportance
Responds to a GET request to /feature/importance or /feature/importanc...
com.cloudera.oryx.app.serving.rdf.model
RDFServingModel
Contains all data structures needed to serve queries for a random decis...
RDFServingModelManager
A com.cloudera.oryx.api.serving.ServingModelManager that manages and pr...
com.cloudera.oryx.app.speed
com.cloudera.oryx.app.speed.als
ALSSpeedModel
Contains all data structures needed to create near-real-time updates fo...
ALSSpeedModelManager
Implementation of com.cloudera.oryx.api.speed.SpeedModelManager that ma...
UserItemStrength
Represents a user ID, item ID and a strength of interaction between them.
com.cloudera.oryx.app.speed.kmeans
KMeansSpeedModel
Contains all data structures needed to create near-real-time updates fo...
KMeansSpeedModelManager
Implementation of com.cloudera.oryx.api.speed.SpeedModelManager that ma...
com.cloudera.oryx.app.speed.rdf
RDFSpeedModel
Contains all data structures needed to create near-real-time updates fo...
RDFSpeedModelManager
Implementation of com.cloudera.oryx.api.speed.SpeedModelManager that ma...
com.cloudera.oryx.batch
Main
Runs BatchLayer from the command line. It will use configuration as loa...
com.cloudera.oryx.common
com.cloudera.oryx.common.collection
CloseableIterator
Implementations are Iterator s that are also Closeable .
Pair
Encapsulates a pair of objects.
Pairs
Pair -related utilities.
com.cloudera.oryx.common.io
IOUtils
I/O-related utility methods.
com.cloudera.oryx.common.lang
AutoLock
Makes a Lock into an AutoCloseable for use with try-with-resources: Loc...
AutoReadWriteLock
Makes a ReadWriteLock that can return AutoLock s and exposes #autoReadL...
ClassUtils
Class -related utility methods.
ExecUtils
Utility methods for executing tasks in parallel, possibly returning a r...
JVMUtils
JVM-related utility methods.
LoggingCallable
A Callable that logs errors thrown from #call() . Useful in cases where...
OryxShutdownHook
Intended for use with Runtime#addShutdownHook(Thread) or similar mechan...
RateLimitCheck
A utility that exposes a #test() method which returns true first, and t...
ToDoubleObjDoubleBiFunction
Analogous to both java.util.function.ToDoubleBiFunction and java.util.f...
com.cloudera.oryx.common.math
DoubleWeightedMean
A weighted mean implementation for floating-point weights, following t...
LinearSystemSolver
An implementation based on RRQRDecomposition from Commons Math.
SingularMatrixSolverException
Throws when a system can't be solved because the input matrix is singul...
Solver
Encapsulates a DecompositionSolver from Commons Math.
VectorMath
Utility class with simple vector-related operations.
com.cloudera.oryx.common.pmml
PMMLUtils
PMML-related utility methods.
com.cloudera.oryx.common.random
RandomManager
Manages random number generation. Allows resetting RNGs to a known stat...
com.cloudera.oryx.common.settings
ConfigToProperties
Utility that outputs all configuration as key-value pairs (as in a .pro...
ConfigUtils
Utilities for retrieving Config instances.
com.cloudera.oryx.common.text
TextUtils
Text and parsing related utility methods.
com.cloudera.oryx.example
com.cloudera.oryx.example.batch
ExampleBatchLayerUpdate
Input keys are ignored. Values are treated as lines of space-separated ...
com.cloudera.oryx.example.serving
Add
Responds to a POST request to /add/[line] . Adds a new line of input fo...
Distinct
Responds to a GET request to /distinct . Returns all distinct words and...
ExampleServingModel
ServingModel produced by ExampleServingModelManager .
ExampleServingModelManager
Reads models and updates produced by the Batch Layer and Speed Layer. M...
com.cloudera.oryx.example.speed
ExampleSpeedModelManager
Also counts and emits counts of number of distinct words that occur wit...
com.cloudera.oryx.kafka
com.cloudera.oryx.kafka.util
ConsumeDataIterator
An iterator over records in a Kafka topic.
KafkaUtils
Kafka-related utility methods.
com.cloudera.oryx.lambda
A
AbstractSparkLayer
Encapsulates commonality between Spark-based layer processes, com.cloud...
DeleteOldDataFn
Function that deletes old data, if applicable, at each batch interval.
HadoopUtils
Hadoop-related utility methods.
TopicProducerImpl
Wraps access to a Kafka message topic Producer .
UpdateOffsetsFn
Function that reads offset range from latest RDD in a streaming job, an...
com.cloudera.oryx.lambda.batch
BatchLayer
Main entry point for Oryx Batch Layer.
BatchUpdateFunction
Framework for executing the batch layer update, and storing data to per...
SaveToHDFSFunction
Function that saves RDDs to HDFS -- only if they're non empty, to preve...
ScalaBatchLayerUpdateAdapter
Adapts a ScalaBatchLayerUpdate to be a Java BatchLayerUpdate .
ValueToWritableFunction
Translates a key and message value object into Writable s encapsulating...
ValueWritableConverter
Utility class that automatically converts a value object to and from a ...
WritableToValueFunction
Translates a key and message in Writable s format to value objects.
com.cloudera.oryx.lambda.serving
CSVMessageBodyWriter
A MessageBodyWriter that can produce CSV ( text/csv ). If given an Iter...
ErrorResource
Constructs a simple HTML error page from error info in the request. Thi...
InMemoryRealm
Adapted from Tomcat's org.apache.catalina.realm.MemoryRealm . This impl...
ModelManagerListener
ServletContextListener that initializes a ServingModelManager at webap...
OryxApplication
The single JAX-RS app for the serving-layer.
OryxExceptionMapper
Maps OryxServingException types to an HTTP Response .
ScalaServingModelManagerAdapter
Adapts a ScalaServingModelManager to be a Java ServingModelManager .
ServingLayer
Top-level implementation of the Serving Layer process.
TopicProducerImpl
Wraps access to a Kafka message topic Producer .
com.cloudera.oryx.lambda.speed
ScalaSpeedModelManagerAdapter
Adapts a ScalaSpeedModelManager to be a Java SpeedModelManager .
SpeedLayer
Main entry point for Oryx Speed Layer.
SpeedLayerUpdate
Main Spark Streaming function for the speed layer that collects and pub...
com.cloudera.oryx.ml
A
MLUpdate
A specialization of BatchLayerUpdate for machine learning-orientedupdat...
com.cloudera.oryx.ml.param
ContinuousAround
ContinuousRange
DiscreteAround
DiscreteRange
GridSearch
HyperParamValues
Encapsulates a range or set of values for a hyperparameter, from which ...
HyperParams
Utility methods related to expressing and selecting hyperparameter valu...
RandomSearch
Unordered
com.cloudera.oryx.serving
Main
Runs ServingLayer from the command line. It will use configuration as l...
com.cloudera.oryx.speed
Main
Runs SpeedLayer from the command line. It will use configuration as loa...