ambit2.model

Interface IModelDefinition<ID,Features,ResultType extends Comparable<?>>

All Known Implementing Classes:

AbstractModel, AbstractSimilarityModel, NearestNeighborsSimilarity, NNAtomEnvironmentSimilarity, NNFingerprintSimilarity

public interface IModelDefinition<ID,Features,ResultType extends Comparable<?>>

Defines a model, derived from objects of type FeatureType

Author:

nina

Method Summary

Modifier and Type	Method and Description
IAttributeSelection<Features>	getAttributeSelection()
Object	getParameter(Object name)
boolean	isBuilt()
void	learn(IDataset<ID,Features,ResultType> dataset)
ResultType	learn(ID id, Features features, ResultType observed, ResultType predicted)
void	predict(IDataset<ID,Features,ResultType> dataset, IModelStatistics<ResultType> stats)
ResultType	predict(ID id, Features features, ResultType observed, ResultType predicted, IModelStatistics<ResultType> stats)
void	setAttributeSelection(IAttributeSelection<Features> attributeSelection)
void	setParameter(Object name, Object value)

Method Detail

getParameter

Object getParameter(Object name)

setParameter

void setParameter(Object name,
                  Object value)

isBuilt

boolean isBuilt()

learn

void learn(IDataset<ID,Features,ResultType> dataset)
    throws net.idea.modbcum.i.exceptions.AmbitException,
           UnsupportedOperationException

Throws:

net.idea.modbcum.i.exceptions.AmbitException

UnsupportedOperationException

learn

ResultType learn(ID id,
                 Features features,
                 ResultType observed,
                 ResultType predicted)
          throws net.idea.modbcum.i.exceptions.AmbitException,
                 UnsupportedOperationException

Throws:

net.idea.modbcum.i.exceptions.AmbitException

UnsupportedOperationException

predict

void predict(IDataset<ID,Features,ResultType> dataset,
             IModelStatistics<ResultType> stats)
      throws net.idea.modbcum.i.exceptions.AmbitException

Throws:

net.idea.modbcum.i.exceptions.AmbitException

predict

ResultType predict(ID id,
                   Features features,
                   ResultType observed,
                   ResultType predicted,
                   IModelStatistics<ResultType> stats)
            throws net.idea.modbcum.i.exceptions.AmbitException

Throws:

net.idea.modbcum.i.exceptions.AmbitException

getAttributeSelection

IAttributeSelection<Features> getAttributeSelection()

setAttributeSelection

void setAttributeSelection(IAttributeSelection<Features> attributeSelection)