public interface ModelDetail
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlgorithmName()
Returns the name of the model builder algorithm.
|
java.lang.String |
getApplicationName()
Returns the name of the model builder application.
|
java.lang.String |
getApplicationVersion()
Returns the version of the model builder application.
|
java.util.Date |
getBuildDate()
Returns the date this model was built.
|
java.lang.String |
getCopyright()
Returns the model copyright.
|
DataModel |
getInputDataModel()
Returns the input data model required by the model.
|
java.lang.String |
getModelID()
Returns the model ID.
|
ModelType |
getModelType()
Returns the type of the model.
|
DataModel |
getOutputDataModel()
Returns the output data model produced by the model.
|
PMMLModelType |
getPMMLModelType()
For a model which is represented internally using PMML (one for which isPMMLModel() returns
true ),
this returns the PMML model type from the underlying PMML that was generated by the modeling algorithm. |
java.lang.String |
getPMMLText()
For a model which is represented internally using PMML (one for which isPMMLModel() returns
true ),
this returns a string representing the PMML generated from the model building algorithm. |
java.util.List<java.lang.String> |
getSplitColumnNames()
Returns the list of split column names if this is a split model or
null
for non-split models. |
int |
getSplitModelCount()
Returns the number of split models if this is a split model or 0 otherwise.
|
java.util.List<java.lang.Object> |
getSplitModelKey(int index)
Returns the values of the split fields at the specified index for split
models or
null for non-split models. |
java.lang.String |
getSplitModelPMMLText(int index)
Returns the PMML representation of the split model at the specified index for split
models or
null for non-split models or if the split model is not represented
as PMML. |
java.lang.String |
getUserName()
Returns the name of the account used to build the model.
|
boolean |
isOutputColumnAuxiliary(java.lang.String name)
Returns
true if the supplied column name is an auxiliary column
in the output data model or false . |
boolean |
isPMMLModel()
Returns
true if this model is represented internally using PMML, false otherwise. |
boolean |
isSplitModel()
Returns
true if this model is a split model, false otherwise. |
java.lang.String getApplicationName()
java.lang.String getApplicationVersion()
java.lang.String getAlgorithmName()
java.lang.String getCopyright()
java.lang.String getUserName()
java.util.Date getBuildDate()
DataModel getInputDataModel()
ModelingRole.IN
, even for fields
that had been specified as ModelingRole.BOTH
for association or sequence models.DataModel
DataModel getOutputDataModel()
ModelingRole.OUT
, even for fields
that had been specified as ModelingRole.BOTH
for association or sequence models.
It is also important to note that this is not same as the output column set produced
by the ModelApplier
that applies the
model to data. The transformer output column set will usually include
additional fields from the input and may include property settings that modify
the number or type of outputs produced (for example, a transformer that applies
a clustering model may produce the cluster ID as an integer or a string depending
on the property settings).
DataModel
,
ModelApplier
boolean isOutputColumnAuxiliary(java.lang.String name)
true
if the supplied column name is an auxiliary column
in the output data model or false
. An auxiliary output column is
a column that provides additional information about the output of the
model e.g., the confidence of the prediction or distance from the cluster
center.name
- the column nametrue
if the supplied column name is an auxiliary columnModelType getModelType()
PMMLModelType getPMMLModelType()
true
),
this returns the PMML model type from the underlying PMML that was generated by the modeling algorithm.
For a model which is not represented using PMML this returns null
.boolean isPMMLModel()
true
if this model is represented internally using PMML, false
otherwise.true
if this model is represented using PMMLgetPMMLText()
java.lang.String getPMMLText()
true
),
this returns a string representing the PMML generated from the model building algorithm. For non-PMML models, this returns null
.
When this returns null
, you may be able to obtain an alternative representation of the model as PMML using the
export function TaskRunner.exportModelToFile()
.null
isPMMLModel()
,
TaskRunner.exportModelToFile(com.spss.psapi.transform.ModelOutput, String, com.spss.psapi.core.FileFormat)
,
TaskRunner.exportModelToFile(com.spss.psapi.transform.Processor, String, com.spss.psapi.core.FileFormat)
java.lang.String getModelID()
boolean isSplitModel()
true
if this model is a split model, false
otherwise.true
if this model is a split modelint getSplitModelCount()
isSplitModel()
java.util.List<java.lang.String> getSplitColumnNames()
null
for non-split models.null
isSplitModel()
,
getSplitModelKey(int)
java.lang.String getSplitModelPMMLText(int index)
null
for non-split models or if the split model is not represented
as PMML.index
- the model indexnull
isSplitModel()
,
getSplitModelKey(int)
java.util.List<java.lang.Object> getSplitModelKey(int index)
null
for non-split models. When present, the values
are in the order specified by the split output columns.index
- the model indexnull
isSplitModel()
,
getSplitColumnNames()
,
getSplitModelPMMLText(int)
Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.