Package adams.flow.transformer

Class WekaTestSetClustererEvaluator

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WekaTestSetClustererEvaluator
extends AbstractTransformer
    Evaluates a trained clusterer (obtained from input) on the dataset obtained from the callable actor.
    If a class attribute is set, a classes-to-clusters evaluation is performed automatically

    Input/output:
    - accepts:
       weka.clusterers.Clusterer
       adams.flow.container.WekaModelContainer
    - generates:
       adams.flow.container.WekaClusterEvaluationContainer


    Container information:
    - adams.flow.container.WekaModelContainer: Model, Header, Dataset
    - adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaTestSetClustererEvaluator
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -testset <adams.flow.core.CallableActorReference> (property: testset)
    The callable actor to use for obtaining the test set.
    default: Testset
 
    -output-model <boolean> (property: outputModel)
    If enabled, the clusterer model is output as well.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_OutputModel

        protected boolean m_OutputModel
        whether to output the model as well.

    • Constructor Detail

      • WekaTestSetClustererEvaluator

        public WekaTestSetClustererEvaluator()

    • Method Detail

      • setTestset

        public void setTestset​(CallableActorReference value)
        Sets the name of the callable clusterer to use.
        Parameters:
        value - the name

      • getTestset

        public CallableActorReference getTestset()
        Returns the name of the callable clusterer in use.
        Returns:
        the name

      • testsetTipText

        public String testsetTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOutputModel

        public void setOutputModel​(boolean value)
        Sets whether to output the clusterer model as well.
        Parameters:
        value - true if to output model

      • getOutputModel

        public boolean getOutputModel()
        Returns whether to output the clusterer model as well.
        Returns:
        true if model is output

      • outputModelTipText

        public String outputModelTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        weka.clusterers.Clusterer.class, adams.flow.container.WekaModelContainer.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        String.class or weka.clusterers.Evaluation.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message