Name

adams.flow.transformer.ConfusionMatrix

Synopsis

Generates a confusion matrix from the specified actual and predicted columns containing class labels.
Can take a probability column (of prediction) into account for generating weighted counts.

Additional information

Flow input/output:
- input: adams.data.spreadsheet.SpreadSheet
- output: adams.data.spreadsheet.SpreadSheet

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	ConfusionMatrix

  
  
• 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

  
  
• actualColumn
  

  The column with the actual labels.

  command-line	-actual-column <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default	1
  example	An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• actualPrefix
  

  The prefix for the actual labels.

  command-line	-actual-prefix <java.lang.String>
  default	a:

  
  
• predictedColumn
  

  The column with the predicted labels.

  command-line	-predicted-column <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default	2
  example	An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• predictedPrefix
  

  The prefix for the predicted labels.

  command-line	-predicted-prefix <java.lang.String>
  default	p:

  
  
• probabilityColumn
  

  The (optional) column with the probabilities; if not available probability of 1 is assumed.

  command-line	-probability-column <adams.data.spreadsheet.SpreadSheetColumnIndex>
  default
  example	An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• matrixValues
  

  The type of values to generate.

  command-line	-matrix-values <COUNTS|PERCENTAGES|PERCENTAGES_PER_ROW>
  default	COUNTS

  
  
• classLabels
  

  The class labels to use for enforcing order other than alphabetical.

  command-line	-class-labels <adams.core.base.BaseString> [-class-labels ...]
  default

  
  
• enumerateLabels
  

  If enable, enumerates the labels in the matrix and outputs a second spreadsheet with index/label relation.

  command-line	-enumerate-labels <boolean>
  default	false

  
  
• combineLabelColumns
  

  If enable, combines the label columns of the label key matrix when enumerating the labels (if act/pred labels are the same).

  command-line	-combine-label-columns <boolean>
  default	false