Oryx Architecture Diagrams | documentation produced by SourceSpy

Entry Points/Methods

Entry Points/Methods
Java Main Method
class com.cloudera.oryx.app.traffic.TrafficUtil
Simple utility class for sending traffic to an Oryx cluster for an extended period of time. Requi...
main(args)
class com.cloudera.oryx.batch.Main
Runs BatchLayer from the command line. It will use configuration as loadedby TypeSafe Config's Co...
main(args)
class com.cloudera.oryx.common.settings.ConfigToProperties
Utility that outputs all configuration as key-value pairs (as in a .properties file) to stdout.
main(args)
class com.cloudera.oryx.kafka.util.LocalKafkaBroker
Runs a local instance of the Kafka broker. Useful for testing.
main(args)
class com.cloudera.oryx.kafka.util.LocalZKServer
This class contains code copied from Zookeeper's QuorumPeerMain and ZooKeeperServerMain. It runs ...
main(args)
class com.cloudera.oryx.serving.Main
Runs ServingLayer from the command line. It will use configuration as loadedby TypeSafe Config's ...
main(args)
class com.cloudera.oryx.speed.Main
Runs SpeedLayer from the command line. It will use configuration as loadedby TypeSafe Config's Co...
main(args)
JavaX RESTful Service
class com.cloudera.oryx.app.serving.AbstractConsoleResource
Superclass of web resources that contain a small console for a Serving Layer application. It appl...
getHTML(response)
class com.cloudera.oryx.app.serving.Ready
Responds to a HEAD or GET request to /ready and returns Response.Status#OK or Response.Status#SE...
get()
class com.cloudera.oryx.app.serving.als.AllItemIDs
Responds to a GET request to /item/allIDs . CSV output consists of one ID per line. JSON output ...
get()
class com.cloudera.oryx.app.serving.als.AllUserIDs
Responds to a GET request to /user/allIDs . CSV output consists of one ID per line. JSON output ...
get()
class com.cloudera.oryx.app.serving.als.Because
Responds to a GET request to /because/[userID]/[itemID](?howMany=n)(&offset=o) . Results are ite...
get(userID,itemID,howMany,offset)
class com.cloudera.oryx.app.serving.als.Estimate
Responds to a GET request to /estimate/[userID]/[itemID] . The results are opaque values which e...
get(userID,pathSegmentsList)
class com.cloudera.oryx.app.serving.als.EstimateForAnonymous
Responds to a GET request to /estimateForAnonymous/[toItemID]/[itemID1(=value1)](/[itemID2(=valu...
get(toItemID,pathSegments)
class com.cloudera.oryx.app.serving.als.Ingest
Responds to a POST to /ingest . For each line in the request body, a line of CSV text is written...
post(reader)
post(request)
class com.cloudera.oryx.app.serving.als.KnownItems
Responds to a GET request to /knownItems/[userID] . CSV output consists of one ID per line. JSON...
get(userID)
class com.cloudera.oryx.app.serving.als.MostActiveUsers
Responds to a GET request to /mostActiveUsers(?howMany=n)(&offset=o)(&rescorerParams=...) Result...
get(howMany,offset,rescorerParams)
class com.cloudera.oryx.app.serving.als.MostPopularItems
Responds to a GET request to /mostPopularItems(?howMany=n)(&offset=o)(&rescorerParams=...) Resul...
get(howMany,offset,rescorerParams)
class com.cloudera.oryx.app.serving.als.MostSurprising
Responds to a GET request to /mostSurprising/[userID](?howMany=n)(?offset=o) . This is like an a...
get(userID,howMany,offset)
class com.cloudera.oryx.app.serving.als.PopularRepresentativeItems
Responds to a GET request to /popularRepresentativeItems . The result is a list of items that is...
get()
class com.cloudera.oryx.app.serving.als.Preference
Responds to a POST request to /pref/[userID]/[itemID] . The first line of the request body is pa...
post(userID,itemID,reader)
class com.cloudera.oryx.app.serving.als.Recommend
Responds to a GET request to /recommend/[userID](?howMany=n)(&offset=o)(&considerKnownItems=c)(&...
get(userID,howMany,offset,considerKnownItems,rescorerParams)
class com.cloudera.oryx.app.serving.als.RecommendToAnonymous
Responds to a GET request to /recommendToAnonymous/[itemID1(=value1)](/[itemID2(=value2)]/...)(?...
get(pathSegments,howMany,offset,rescorerParams)
class com.cloudera.oryx.app.serving.als.RecommendToMany
Responds to a GET request to /recommendToMany/[userID1](/[userID2]/...)(?howMany=n)(&offset=o)(&...
get(pathSegmentsList,howMany,offset,considerKnownItems,rescorerParams)
class com.cloudera.oryx.app.serving.als.RecommendWithContext
Responds to a GET request to /recommendWithContext/[userID]/([itemID1(=value1)]/...)(?howMany=n)...
get(userID,pathSegments,howMany,offset,considerKnownItems,rescorerParams)
class com.cloudera.oryx.app.serving.als.Similarity
Responds to a GET request to /similarity/[itemID1](/[itemID2]/...)(?howMany=n)(&offset=o)(&resco...
get(pathSegmentsList,howMany,offset,rescorerParams)
class com.cloudera.oryx.app.serving.als.SimilarityToItem
Responds to a GET request to /similarityToItem/[toItemID]/[itemID1](/[itemID2]/...) . This compu...
get(toItemID,pathSegmentsList)
class com.cloudera.oryx.app.serving.classreg.Predict
Responds to a GET request to /predict/[datum] , or a POST to /predict containing several data po...
get(datum)
post(request)
post(reader)
class com.cloudera.oryx.app.serving.classreg.Train
Responds to POST request to /train . The input is one or more data points to train, one for each...
post(reader)
post(datum)
post(request)
class com.cloudera.oryx.app.serving.clustering.Add
Responds to POST request to /add . The input is one or more data points to add to the clustering...
post(request)
post(datum)
post(reader)
class com.cloudera.oryx.app.serving.clustering.Assign
Responds to a GET request to /assign/[datum] , or a POST to /assign containing several data poin...
get(datum)
post(request)
post(reader)
class com.cloudera.oryx.app.serving.kmeans.DistanceToNearest
Responds to a GET request to /distanceToNearest/[datum] . The inputs is a data point to cluster,...
get(datum)
class com.cloudera.oryx.app.serving.rdf.ClassificationDistribution
Responds to a GET request to /classificationDistribution/[datum] . Like com.cloudera.oryx.app.se...
get(datum)
class com.cloudera.oryx.app.serving.rdf.FeatureImportance
Responds to a GET request to /feature/importance or /feature/importance/[feature number] . In th...
getAllImportances()
getImportance(featureNumber)
class com.cloudera.oryx.example.serving.Add
Responds to a POST request to /add/[line] . Adds a new line of input for processing. Also respond...
add(line)
post(reader)
class com.cloudera.oryx.example.serving.Distinct
Responds to a GET request to /distinct . Returns all distinct words and their count. Responds to ...
get()
get(word)
class com.cloudera.oryx.lambda.serving.ErrorResource
Constructs a simple HTML error page from error info in the request. This is intended to be where ...
errorEmpty(request)
errorHTML(request)
errorText(request)
class com.cloudera.oryx.lambda.serving.HelloWorld
sayHello()