javax.datamining.supervised
Interface TestTask

All Superinterfaces:

MiningObject, Task

All Known Subinterfaces:

ClassificationTestTask, RegressionTestTask

public interface TestTask

extends Task

A TestTask is a common interface for all tasks that test a supervised model. Test is a mining operation that applies an input data whose cases have known classes to a supervised model to measure the goodness of the model built on the build data.

The need to test a model is only applicable in supervised learning. As such, the test task is in the supervised package.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Task

Method Summary

java.lang.String	getModelName() Returns the name of the model to be tested.
java.util.Map	getTestDataMap() Returns the attribute map for test input data.
java.lang.String	getTestDataName() Returns the name of the test data.
java.lang.String	getTestMetricsName() Returns the name of the test metrics to be created as the result of test task.
void	setModelName(java.lang.String modelName) Sets the name of the model to be tested.
void	setTestDataMap(java.util.Map testDataMap) Specifies a mppaing between physical attribute names in the test input data and signature attribute names with the model.
void	setTestDataName(java.lang.String testDataName) Sets the name of the test data.
void	setTestMetricsName(java.lang.String testMetricsName) Sets the name of the test metrics to be created as the result of test task.
VerificationReport	verify() Verifies if the mappings are valid.

Methods inherited from interface javax.datamining.base.Task

getExecutionHandle

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription

Method Detail

getModelName

public java.lang.String getModelName()

Returns the name of the model to be tested.

Returns:

String

getTestDataMap

public java.util.Map getTestDataMap()

Returns the attribute map for test input data. Returns null if no map has been provided.

Returns:

Map

getTestDataName

public java.lang.String getTestDataName()

Returns the name of the test data.

Returns:

String

getTestMetricsName

public java.lang.String getTestMetricsName()

Returns the name of the test metrics to be created as the result of test task.

Returns:

String

setModelName

public void setModelName(java.lang.String modelName)
                  throws JDMException

Sets the name of the model to be tested.

Parameters:

modelName - The name of the model to be tested.

Returns:

void

Throws:

JDMException

setTestDataMap

public void setTestDataMap(java.util.Map testDataMap)
                    throws JDMException

Specifies a mppaing between physical attribute names in the test input data and signature attribute names with the model. The key for the mapping is the physical attribute name.

If the physical data is transactional and no mapping is provided, the data is still mapped as transactional as long as the data contains at least two PhysicalAttributes with caseId and atttributeName roles.

In case of explicit mapping, the user would need to provide a java.util.Map object that contains mapping of physical attribute name to logical attribute name.

Parameters:

testDataMap - A map that contains the mapping between physical attribute names and signature attribute names for test data.

Returns:

void

Throws:

JDMException

setTestDataName

public void setTestDataName(java.lang.String testDataName)
                     throws JDMException

Sets the name of the test data.

Parameters:

testDataName - The name of the test data.

Returns:

void

Throws:

JDMException

setTestMetricsName

public void setTestMetricsName(java.lang.String testMetricsName)
                        throws JDMException

Sets the name of the test metrics to be created as the result of test task.

Parameters:

testMetricsName - The name of the test metrics.

Returns:

void

Throws:

JDMException

verify

public VerificationReport verify()

Verifies if the mappings are valid. Returns null if the mappings are valid. If the mappings are invalid, it returns an instance of VerificationReport that contains a vendor specific explanation.

Returns:

VerificationReport