Class CrossValidationFoldMaker

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, BeanCommon, DataSourceListener, EventConstraints, StructureProducer, TestSetListener, TestSetProducer, TrainingSetListener, TrainingSetProducer, UserRequestAcceptor, Visible

Bean for splitting instances into training ant test sets according to a cross validation
Version:
$Revision: 10220 $
Author:
Mark Hall
See Also:
  • Constructor Details

    • CrossValidationFoldMaker

      public CrossValidationFoldMaker()
  • Method Details

    • getStructure

      public Instances getStructure(String eventName)
      Get the structure of the output encapsulated in the named event. If the structure can't be determined in advance of seeing input, or this StructureProducer does not generate the named event, null should be returned.
      Specified by:
      getStructure in interface StructureProducer
      Parameters:
      eventName - the name of the output event that encapsulates the requested output.
      Returns:
      the structure of the output encapsulated in the named event or null if it can't be determined in advance of seeing input or the named event is not generated by this StructureProduce.
    • connectionNotification

      public void connectionNotification(String eventName, Object source)
      Notify this object that it has been registered as a listener with a source with respect to the supplied event name
      Specified by:
      connectionNotification in interface BeanCommon
      Overrides:
      connectionNotification in class AbstractTrainAndTestSetProducer
      Parameters:
      eventName - the event
      source - the source with which this object has been registered as a listener
    • disconnectionNotification

      public void disconnectionNotification(String eventName, Object source)
      Notify this object that it has been deregistered as a listener with a source with respect to the supplied event name
      Specified by:
      disconnectionNotification in interface BeanCommon
      Overrides:
      disconnectionNotification in class AbstractTrainAndTestSetProducer
      Parameters:
      eventName - the event
      source - the source with which this object has been registered as a listener
    • setCustomName

      public void setCustomName(String name)
      Set a custom (descriptive) name for this bean
      Specified by:
      setCustomName in interface BeanCommon
      Parameters:
      name - the name to use
    • getCustomName

      public String getCustomName()
      Get the custom (descriptive) name for this bean (if one has been set)
      Specified by:
      getCustomName in interface BeanCommon
      Returns:
      the custom name (or the default name)
    • globalInfo

      public String globalInfo()
      Global info for this bean
      Returns:
      a String value
    • acceptTrainingSet

      public void acceptTrainingSet(TrainingSetEvent e)
      Accept a training set
      Specified by:
      acceptTrainingSet in interface TrainingSetListener
      Parameters:
      e - a TrainingSetEvent value
    • acceptTestSet

      public void acceptTestSet(TestSetEvent e)
      Accept a test set
      Specified by:
      acceptTestSet in interface TestSetListener
      Parameters:
      e - a TestSetEvent value
    • acceptDataSet

      public void acceptDataSet(DataSetEvent e)
      Accept a data set
      Specified by:
      acceptDataSet in interface DataSourceListener
      Specified by:
      acceptDataSet in class AbstractTrainAndTestSetProducer
      Parameters:
      e - a DataSetEvent value
    • setFolds

      public void setFolds(int numFolds)
      Set the number of folds for the cross validation
      Parameters:
      numFolds - an int value
    • getFolds

      public int getFolds()
      Get the currently set number of folds
      Returns:
      an int value
    • foldsTipText

      public String foldsTipText()
      Tip text for this property
      Returns:
      a String value
    • setSeed

      public void setSeed(int randomSeed)
      Set the seed
      Parameters:
      randomSeed - an int value
    • getSeed

      public int getSeed()
      Get the currently set seed
      Returns:
      an int value
    • seedTipText

      public String seedTipText()
      Tip text for this property
      Returns:
      a String value
    • getPreserveOrder

      public boolean getPreserveOrder()
      Returns true if the order of the incoming instances is to be preserved under cross-validation (no randomization or stratification is done in this case).
      Returns:
      true if the order of the incoming instances is to be preserved.
    • setPreserveOrder

      public void setPreserveOrder(boolean p)
      Sets whether the order of the incoming instances is to be preserved under cross-validation (no randomization or stratification is done in this case).
      Parameters:
      p - true if the order is to be preserved.
    • isBusy

      public boolean isBusy()
      Returns true if. at this time, the bean is busy with some (i.e. perhaps a worker thread is performing some calculation).
      Specified by:
      isBusy in interface BeanCommon
      Returns:
      true if the bean is busy.
    • stop

      public void stop()
      Stop any action
      Specified by:
      stop in interface BeanCommon
      Specified by:
      stop in class AbstractTrainAndTestSetProducer
    • enumerateRequests

      public Enumeration<String> enumerateRequests()
      Return an enumeration of user requests
      Specified by:
      enumerateRequests in interface UserRequestAcceptor
      Returns:
      an Enumeration value
    • performRequest

      public void performRequest(String request)
      Perform the named request
      Specified by:
      performRequest in interface UserRequestAcceptor
      Parameters:
      request - a String value
      Throws:
      IllegalArgumentException - if an error occurs
    • eventGeneratable

      public boolean eventGeneratable(String eventName)
      Returns true, if at the current time, the named event could be generated. Assumes that the supplied event name is an event that could be generated by this bean
      Specified by:
      eventGeneratable in interface EventConstraints
      Parameters:
      eventName - the name of the event in question
      Returns:
      true if the named event could be generated at this point in time