/*
* RapidMiner
*
* Copyright (C) 2001-2011 by Rapid-I and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapid-i.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.operator.validation;
import java.util.List;
import com.rapidminer.example.ExampleSet;
import com.rapidminer.example.set.SplittedExampleSet;
import com.rapidminer.operator.OperatorCapability;
import com.rapidminer.operator.OperatorDescription;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.operator.OperatorVersion;
import com.rapidminer.operator.UserError;
import com.rapidminer.operator.ports.metadata.AttributeMetaData;
import com.rapidminer.operator.ports.metadata.CapabilityPrecondition;
import com.rapidminer.operator.ports.metadata.MDInteger;
import com.rapidminer.operator.ports.metadata.Precondition;
import com.rapidminer.operator.ports.quickfix.ParameterSettingQuickFix;
import com.rapidminer.operator.ports.quickfix.QuickFix;
import com.rapidminer.operator.visualization.ProcessLogOperator;
import com.rapidminer.parameter.ParameterType;
import com.rapidminer.parameter.ParameterTypeCategory;
import com.rapidminer.parameter.ParameterTypeDouble;
import com.rapidminer.parameter.ParameterTypeInt;
import com.rapidminer.parameter.UndefinedParameterError;
import com.rapidminer.parameter.conditions.EqualTypeCondition;
import com.rapidminer.tools.RandomGenerator;
/**
* <p>
* A FixedSplitValidationChain splits up the example set at a fixed point into a
* training and test set and evaluates the model (linear sampling). For
* non-linear sampling methods, i.e. the data is shuffled, the specified amounts
* of data are used as training and test set. The sum of both must be smaller
* than the input example set size.
* </p>
*
* <p>
* At least either the training set size must be specified (rest is used for
* testing) or the test set size must be specified (rest is used for training).
* If both are specified, the rest is not used at all.
* </p>
*
* <p>
* The first inner operator must accept an
* {@link com.rapidminer.example.ExampleSet} while the second must accept an
* {@link com.rapidminer.example.ExampleSet} and the output of the first (which
* in most cases is a {@link com.rapidminer.operator.Model}) and must produce
* a {@link com.rapidminer.operator.performance.PerformanceVector}.
* </p>
*
* <p>This validation operator provides several values which can be logged
* by means of a {@link ProcessLogOperator}. All performance estimation operators
* of RapidMiner provide access to the average values calculated during the estimation.
* Since the operator cannot ensure the names of the delivered criteria, the
* ProcessLog operator can access the values via the generic value names:</p>
* <ul>
* <li>performance: the value for the main criterion calculated by this validation operator</li>
* <li>performance1: the value of the first criterion of the performance vector calculated</li>
* <li>performance2: the value of the second criterion of the performance vector calculated</li>
* <li>performance3: the value of the third criterion of the performance vector calculated</li>
* <li>for the main criterion, also the variance and the standard deviation can be
* accessed where applicable.</li>
* </ul>
*
* @author Simon Fischer, Ingo Mierswa
*/
public class SplitValidationOperator extends ValidationChain {
public static final String PARAMETER_SPLIT = "split";
public static final String[] SPLIT_MODES = { "absolute" , "relative" };
public static final int SPLIT_ABSOLUTE = 0;
public static final int SPLIT_RELATIVE = 1;
public static final String PARAMETER_SPLIT_RATIO = "split_ratio";
public static final String PARAMETER_TRAINING_SET_SIZE = "training_set_size";
public static final String PARAMETER_TEST_SET_SIZE = "test_set_size";
public static final String PARAMETER_SAMPLING_TYPE = "sampling_type";
public SplitValidationOperator(OperatorDescription description) {
super(description);
}
@Override
protected Precondition getCapabilityPrecondition() {
return new CapabilityPrecondition(this, trainingSetInput) {
@Override
protected List<QuickFix> getFixesForRegressionWhenClassificationSupported(AttributeMetaData labelMD) {
List<QuickFix> fixes = super.getFixesForRegressionWhenClassificationSupported(labelMD);
fixes.add(0, new ParameterSettingQuickFix(SplitValidationOperator.this, PARAMETER_SAMPLING_TYPE, SplittedExampleSet.SHUFFLED_SAMPLING + "", "switch_to_shuffled_sampling"));
return fixes;
}
};
}
@Override
public void estimatePerformance(ExampleSet inputSet) throws OperatorException {
SplittedExampleSet eSet = null;
switch (getParameterAsInt(PARAMETER_SPLIT)) {
case SPLIT_RELATIVE:
double splitRatio = getParameterAsDouble(PARAMETER_SPLIT_RATIO);
eSet = new SplittedExampleSet(inputSet, splitRatio, getParameterAsInt(PARAMETER_SAMPLING_TYPE), getParameterAsBoolean(RandomGenerator.PARAMETER_USE_LOCAL_RANDOM_SEED), getParameterAsInt(RandomGenerator.PARAMETER_LOCAL_RANDOM_SEED), getCompatibilityLevel().isAtMost(SplittedExampleSet.VERSION_SAMPLING_CHANGED));
break;
case SPLIT_ABSOLUTE: {
int trainingSetSize = getParameterAsInt(PARAMETER_TRAINING_SET_SIZE);
int testSetSize = getParameterAsInt(PARAMETER_TEST_SET_SIZE);
int inputSetSize = inputSet.size();
if (inputSetSize < trainingSetSize + testSetSize) {
throw new UserError(this, 110, (trainingSetSize + testSetSize) + " (" + trainingSetSize + " for training, " + testSetSize + " for testing)");
}
int rest = inputSetSize - (trainingSetSize + testSetSize);
if ((trainingSetSize < 1) && (testSetSize < 1)) {
throw new UserError(this, 116, "training_set_size / test_set_size", "either training_set_size or test_set_size or both must be greater than 1.");
} else if (testSetSize < 1) {
rest = 0;
testSetSize = inputSetSize - trainingSetSize;
} else if (trainingSetSize < 1) {
rest = 0;
trainingSetSize = inputSetSize - testSetSize;
}
log("Using " + trainingSetSize + " examples for learning and " + testSetSize + " examples for testing. " + rest + " examples are not used.");
double[] ratios = new double[] { (double) trainingSetSize / (double) inputSetSize, (double) testSetSize / (double) inputSetSize, (double) rest / (double) inputSetSize };
eSet = new SplittedExampleSet(inputSet, ratios, getParameterAsInt(PARAMETER_SAMPLING_TYPE), getParameterAsBoolean(RandomGenerator.PARAMETER_USE_LOCAL_RANDOM_SEED), getParameterAsInt(RandomGenerator.PARAMETER_LOCAL_RANDOM_SEED), getCompatibilityLevel().isAtMost(SplittedExampleSet.VERSION_SAMPLING_CHANGED));
break;
}
}
eSet.selectSingleSubset(0);
learn(eSet);
eSet.selectSingleSubset(1);
evaluate(eSet);
}
@Override
protected MDInteger getTrainingSetSize(MDInteger originalSize) throws UndefinedParameterError {
switch (getParameterAsInt(PARAMETER_SPLIT)) {
case SPLIT_RELATIVE:
return originalSize.multiply(getParameterAsDouble(PARAMETER_SPLIT_RATIO));
case SPLIT_ABSOLUTE:
return new MDInteger(getParameterAsInt(PARAMETER_TRAINING_SET_SIZE));
default:
return new MDInteger();
}
}
@Override
protected MDInteger getTestSetSize(MDInteger originalSize) throws UndefinedParameterError {
switch (getParameterAsInt(PARAMETER_SPLIT)) {
case SPLIT_RELATIVE:
return originalSize.multiply(1.0d - getParameterAsDouble(PARAMETER_SPLIT_RATIO));
case SPLIT_ABSOLUTE:
return new MDInteger(getParameterAsInt(PARAMETER_TEST_SET_SIZE));
default:
return new MDInteger();
}
}
@Override
public List<ParameterType> getParameterTypes() {
List<ParameterType> types = super.getParameterTypes();
ParameterType type = new ParameterTypeCategory(PARAMETER_SPLIT, "Specifies how the example set should be splitted.", SPLIT_MODES, SPLIT_RELATIVE);
type.setExpert(false);
types.add(type);
type = new ParameterTypeDouble(PARAMETER_SPLIT_RATIO, "Relative size of the training set", 0.0d, 1.0d, 0.7d);
type.registerDependencyCondition(new EqualTypeCondition(this, PARAMETER_SPLIT, SPLIT_MODES, true, SPLIT_RELATIVE));
type.setExpert(false);
types.add(type);
type = new ParameterTypeInt(PARAMETER_TRAINING_SET_SIZE, "Absolute size required for the training set (-1: use rest for training)", -1, Integer.MAX_VALUE, 100);
type.registerDependencyCondition(new EqualTypeCondition(this, PARAMETER_SPLIT, SPLIT_MODES, true, SPLIT_ABSOLUTE));
type.setExpert(false);
types.add(type);
type = new ParameterTypeInt(PARAMETER_TEST_SET_SIZE, "Absolute size required for the test set (-1: use rest for testing)", -1, Integer.MAX_VALUE, -1);
type.registerDependencyCondition(new EqualTypeCondition(this, PARAMETER_SPLIT, SPLIT_MODES, true, SPLIT_ABSOLUTE));
type.setExpert(false);
types.add(type);
types.add(new ParameterTypeCategory(PARAMETER_SAMPLING_TYPE, "Defines the sampling type of the cross validation (linear = consecutive subsets, shuffled = random subsets, stratified = random subsets with class distribution kept constant)", SplittedExampleSet.SAMPLING_NAMES, SplittedExampleSet.SHUFFLED_SAMPLING, false));
types.addAll(RandomGenerator.getRandomGeneratorParameters(this));
return types;
}
@Override
public OperatorVersion[] getIncompatibleVersionChanges() {
return new OperatorVersion[] { SplittedExampleSet.VERSION_SAMPLING_CHANGED };
}
@Override
public boolean supportsCapability(OperatorCapability capability) {
switch (capability) {
case NO_LABEL:
return false;
case NUMERICAL_LABEL:
try {
return getParameterAsInt(PARAMETER_SAMPLING_TYPE) != SplittedExampleSet.STRATIFIED_SAMPLING;
} catch (UndefinedParameterError e) {
return false;
}
default:
return true;
}
}
}