Name

adams.flow.transformer.Cleaner

Synopsis

In case of Instances objects, 'unclean' Instance objects get removed. When receiving an Instance object, a note is attached.
The following order is used to obtain the model (when using AUTO):
1. model file present?
2. source actor present?
3. storage item present?
4. The cleaner is instantiated from the provided definition.

Additional information

Flow input/output:
- input: adams.flow.container.CleaningContainer, weka.core.Instance, weka.core.Instances
- output: adams.flow.container.CleaningContainer

Container information:
- adams.flow.container.CleaningContainer:
   - Instance: data row; weka.core.Instance
   - Instances: dataset; weka.core.Instances
   - Checks: checks; adams.data.spreadsheet.SpreadSheet
   - Cleaner: cleaner; adams.data.cleaner.instance.AbstractCleaner

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	Cleaner

  
  
• 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

  
  
• cleaner
  

  The Cleaner to use to clean Instances.

  command-line	-cleaner <adams.data.cleaner.instance.AbstractCleaner>
  default	adams.data.cleaner.instance.IQRCleaner -pre-filter weka.filters.AllFilter -filter \"weka.filters.unsupervised.attribute.InterquartileRange -R first-last -O 3.0 -E 6.0\"

  
  
• 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

  
  
• cleanerDetailsOutput
  

  The file to save the cleaner details to after training, in case the cleaner implements the adams.data.cleaner.CleanerDetails interface; ignored if pointing to a directory.

  command-line	-cleaner-details-output <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• preferJobRunner
  

  If enabled, tries to offload the processing onto a adams.flow.standalone.JobRunnerInstance; applies only to training.

  command-line	-prefer-jobrunner <boolean>
  default	false