Name

adams.flow.transformer.MOAClustering

Synopsis

Uses a serialized MOA model to cluster data being passed through.
The following order is used to obtain the model (when using AUTO):
1. model file present?
2. source actor present?
3. storage item present?
Optionally, the model can be updated with data being passed through.

Additional information

Flow input/output:
- input: com.yahoo.labs.samoa.instances.Instance
- output: adams.flow.container.MOAClusteringContainer

Container information:
- adams.flow.container.MOAClusteringContainer:
   - Instance: data row; com.yahoo.labs.samoa.instances.Instance
   - Cluster: cluster index (0-based); java.lang.Integer
   - Distribution: cluster distribution; array of double
   - LogDensity: log density; java.lang.Double
   - LogDensityPerCluster: log density per cluster; array of double
   - LogJointDensities: log joint densities; array of double

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	MOAClustering

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• modelLoadingType
  

  Determines how to load the model, in case of AUTO, first the model file is checked, then the callable actor and then the storage.

  command-line	-model-loading-type <AUTO|FILE|SOURCE_ACTOR|STORAGE>
  default	AUTO

  
  
• modelFile
  

  The file to load the model from, ignored if pointing to a directory.

  command-line	-model <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• modelActor
  

  The callable actor (source) to obtain the model from, ignored if not present.

  command-line	-model-actor <adams.flow.core.CallableActorReference>
  default

  
  
• modelStorage
  

  The storage item to obtain the model from, ignored if not present.

  command-line	-model-storage <adams.flow.control.StorageName>
  default	storage

  
  
• onTheFly
  

  If set to true, the model file is not required to be present at set up time (eg if built on the fly), only at execution time.

  command-line	-on-the-fly <boolean>
  default	false

  
  
• useModelResetVariable
  

  If enabled, chnages to the specified variable are monitored in order to reset the model, eg when a storage model changed.

  command-line	-use-model-reset-variable <boolean>
  default	false

  
  
• modelResetVariable
  

  The variable to monitor for changes in order to reset the model, eg when a storage model changed.

  command-line	-model-reset-variable <adams.core.VariableName>
  default	variable

  
  
• updateModel
  

  Whether to update the model with the Instance after making the prediction.

  command-line	-update-model <boolean>
  default	false