class AssociationModel extends Model with HasWrappedAssociationAttributes
The Association Rule model represents rules where some set of items is associated to another set of items. For example a rule can express that a certain product or set of products is often bought in combination with a certain set of other products, also known as Market Basket Analysis. An Association Rule model typically has two variables: one for grouping records together into transactions (usageType="group") and another that uniquely identifies each record (usageType="active"). Alternatively, association rule models can be built on regular data, where each category of each categorical field is an item. Yet another possible format of data is a table with true/false values, where only the fields having true value in a record are considered valid items.
An Association Rule model consists of four major parts: - Model attributes - Items - ItemSets - AssociationRules
- Alphabetic
- By Inheritance
- AssociationModel
- HasWrappedAssociationAttributes
- HasAssociationAttributes
- Model
- PmmlElement
- Serializable
- HasExtensions
- HasModelVerification
- Predictable
- HasTargetFields
- ModelLocation
- FieldScope
- HasField
- HasLocalTransformations
- HasTargets
- HasModelExplanation
- HasModelStats
- HasOutput
- HasMiningSchema
- HasWrappedModelAttributes
- HasModelAttributes
- HasVersion
- HasParent
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AssociationModel(parent: Model, attributes: AssociationAttributes, miningSchema: MiningSchema, items: Array[Item], itemsets: Array[Itemset], associationRules: Array[AssociationRule], output: Option[Output] = None, targets: Option[Targets] = None, localTransformations: Option[LocalTransformations] = None, modelStats: Option[ModelStats] = None, modelExplanation: Option[ModelExplanation] = None, modelVerification: Option[ModelVerification] = None, extensions: Seq[Extension] = immutable.Seq.empty)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val activeField: Field
- val activeFields: Array[Field]
- val activeNames: Array[String]
- def algorithmName: Option[String]
The algorithm name is free-type and can be any description for the specific algorithm that produced the model.
The algorithm name is free-type and can be any description for the specific algorithm that produced the model. This attribute is for information only.
- Definition Classes
- HasWrappedModelAttributes → HasModelAttributes
- def anyMissing(series: Series): Boolean
Returns true if there are any missing values of all input fields in the specified series.
Returns true if there are any missing values of all input fields in the specified series.
- Attributes
- protected
- Definition Classes
- Model
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val associationRules: Array[AssociationRule]
- val attributes: AssociationAttributes
Common attributes of this model
Common attributes of this model
- Definition Classes
- AssociationModel → HasWrappedAssociationAttributes → HasWrappedModelAttributes
- def avgNumberOfItemsPerTA: Option[Double]
The average number of items contained in a transaction.
The average number of items contained in a transaction.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def candidateOutputFields: Array[OutputField]
- Definition Classes
- HasOutput
- def candidateOutputSchema: StructType
The schema of candidate outputs.
The schema of candidate outputs.
- Definition Classes
- Model
- def classes(name: String): Array[Any]
Returns class labels of the specified target.
Returns class labels of the specified target.
- Definition Classes
- Model
- lazy val classes: Array[Any]
The class labels in a classification model.
The class labels in a classification model.
- Definition Classes
- Model
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def combineOutputFields(listA: Array[OutputField], listB: Array[OutputField]): Array[OutputField]
- Definition Classes
- HasOutput
- def containInterResults: Boolean
- Definition Classes
- HasOutput
- def createOutputs(): AssociationOutputs
Creates an object of subclass of ModelOutputs that is for writing into an output series.
Creates an object of subclass of ModelOutputs that is for writing into an output series.
- Definition Classes
- AssociationModel → Model
- val customOutputFields: Array[OutputField]
User-defined custom output fields, both the internal output of PMML and predefined output are ignored when the field is specified.
User-defined custom output fields, both the internal output of PMML and predefined output are ignored when the field is specified.
- Definition Classes
- HasOutput
- def dVersion: Double
Returns PMML version as a double value
Returns PMML version as a double value
- Definition Classes
- HasVersion
- def dataDictionary: DataDictionary
The data dictionary of this model.
The data dictionary of this model.
- Definition Classes
- Model
- def defaultOutputFields: Array[OutputField]
Returns all candidates output fields of this model when there is no output specified explicitly.
- def encode(series: Series): DSeries
Encodes the input series.
Encodes the input series.
- Attributes
- protected
- Definition Classes
- Model
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val extensions: Seq[Extension]
- Definition Classes
- AssociationModel → HasExtensions
- def field(name: String): Field
Returns the field of a given name.
Returns the field of a given name.
- Definition Classes
- HasField
- Exceptions thrown
FieldNotFoundExceptionif a field with the given name does not exist
- def fieldsOfUsageType(typ: UsageType): Array[Field]
Get fields by its usage type: 'active', 'target', 'predicted', 'group' and so on
Get fields by its usage type: 'active', 'target', 'predicted', 'group' and so on
- Definition Classes
- Model
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def functionName: MiningFunction
Describe the kind of mining model, e.g., whether it is intended to be used for clustering or for classification.
Describe the kind of mining model, e.g., whether it is intended to be used for clustering or for classification.
- Definition Classes
- HasWrappedModelAttributes → HasModelAttributes
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(name: String): Option[Field]
Returns the field of a given name, None if a field with the given name does not exist.
- val groupField: Field
- def hasExtensions: Boolean
- Definition Classes
- HasExtensions
- def hasTarget: Boolean
- Definition Classes
- HasTargetFields
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def header: Header
The header of this model.
The header of this model.
- Definition Classes
- Model
- lazy val implicitInputDerivedFields: Array[Field]
Implicit referenced derived fields for the sub-model except ones defined in the mining schema.
Implicit referenced derived fields for the sub-model except ones defined in the mining schema.
- Definition Classes
- Model
- def importances: Map[String, Double]
Returns importances of predictors.
Returns importances of predictors.
- Definition Classes
- Model
- def inferClasses: Array[Any]
The sub-classes can override this method to provide classes of target inside model.
The sub-classes can override this method to provide classes of target inside model.
- Definition Classes
- Model
- lazy val inputDerivedFields: Array[Field]
Referenced derived fields.
Referenced derived fields.
- Definition Classes
- Model
- lazy val inputFields: Array[Field]
All input fields in an array.
All input fields in an array.
- Definition Classes
- Model
- lazy val inputNames: Array[String]
All input names in an array.
All input names in an array.
- Definition Classes
- Model
- lazy val inputSchema: StructType
The schema of inputs.
The schema of inputs.
- Definition Classes
- Model
- def isAssociationRules: Boolean
Tests if this is a association rules model.
Tests if this is a association rules model.
- Definition Classes
- HasModelAttributes
- def isBinary: Boolean
Tests if the target is a binary field
Tests if the target is a binary field
- Definition Classes
- Model
- def isClassification(name: String): Boolean
Tests if this is a classification model of the specified target, it's applicable for multiple targets.
Tests if this is a classification model of the specified target, it's applicable for multiple targets.
- Definition Classes
- Model
- def isClassification: Boolean
Tests if this is a classification model.
Tests if this is a classification model.
- Definition Classes
- Model → HasModelAttributes
- def isClustering: Boolean
Tests if this is a clustering model.
Tests if this is a clustering model.
- Definition Classes
- HasModelAttributes
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isMixed: Boolean
Tests if this is a mixed model.
Tests if this is a mixed model.
- Definition Classes
- HasModelAttributes
- def isOrdinal: Boolean
Tests if the target is an ordinal field
Tests if the target is an ordinal field
- Definition Classes
- Model
- def isPredictionOnly: Boolean
- Definition Classes
- HasOutput
- def isRegression(name: String): Boolean
Tests if this is a regression model of the specified target, it's applicable for multiple targets.
Tests if this is a regression model of the specified target, it's applicable for multiple targets.
- Definition Classes
- Model
- def isRegression: Boolean
Tests if this is a regression model.
Tests if this is a regression model.
- Definition Classes
- Model → HasModelAttributes
- def isScorable: Boolean
Indicates if the model is valid for scoring.
Indicates if the model is valid for scoring. If this attribute is true or if it is missing, then the model should be processed normally. However, if the attribute is false, then the model producer has indicated that this model is intended for information purposes only and should not be used to generate results.
- Definition Classes
- HasWrappedModelAttributes → HasModelAttributes
- def isSequences: Boolean
Tests if this is a sequences model.
Tests if this is a sequences model.
- Definition Classes
- HasModelAttributes
- def isSubModel: Boolean
- Definition Classes
- ModelLocation
- def isTimeSeries: Boolean
Tests if this is a time series model.
Tests if this is a time series model.
- Definition Classes
- HasModelAttributes
- def isTopLevelModel: Boolean
- Definition Classes
- ModelLocation
- val items: Array[Item]
- val itemsets: Array[Itemset]
- def lengthLimit: Option[Int]
The maximum number of items contained in a rule which was used to limit the number of rules.
The maximum number of items contained in a rule which was used to limit the number of rules.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- val localTransformations: Option[LocalTransformations]
The optional local transformations.
The optional local transformations.
- Definition Classes
- AssociationModel → HasLocalTransformations
- def maxNumberOfItemsPerTA: Option[Int]
The number of items contained in the largest transaction.
The number of items contained in the largest transaction.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def minimumConfidence: Double
The minimum confidence value satisfied by all rules.
The minimum confidence value satisfied by all rules. Confidence is calculated as (support (rule) / support(antecedent)).
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def minimumSupport: Double
The minimum relative support value (#supporting transactions / #total transactions) satisfied by all rules.
The minimum relative support value (#supporting transactions / #total transactions) satisfied by all rules.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- val miningSchema: MiningSchema
- Definition Classes
- AssociationModel → HasMiningSchema
- def modelElement: ModelElement
Model element type.
Model element type.
- Definition Classes
- AssociationModel → Model
- val modelExplanation: Option[ModelExplanation]
- Definition Classes
- AssociationModel → HasModelExplanation
- def modelName: Option[String]
Identifies the model with a unique name in the context of the PMML file.
Identifies the model with a unique name in the context of the PMML file. This attribute is not required. Consumers of PMML models are free to manage the names of the models at their discretion.
- Definition Classes
- HasWrappedModelAttributes → HasModelAttributes
- val modelStats: Option[ModelStats]
- Definition Classes
- AssociationModel → HasModelStats
- val modelVerification: Option[ModelVerification]
- Definition Classes
- AssociationModel → HasModelVerification
- def multiTargets: Boolean
- Definition Classes
- HasTargetFields
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- lazy val nullSeries: Series
A series with all null values is returned when can not produce a result.
A series with all null values is returned when can not produce a result.
- Definition Classes
- Model
- def numClasses(name: String): Int
Returns the number of class labels of the specified target.
Returns the number of class labels of the specified target.
- Definition Classes
- Model
- lazy val numClasses: Int
The number of class labels in a classification model.
The number of class labels in a classification model.
- Definition Classes
- Model
- def numberOfItems: Int
The number of different items contained in the input data.
The number of different items contained in the input data. This number may be greater than or equal to the number of items contained in the model. The value will be greater if any items in the input data are excluded from the model, as a consequence of not being referenced by the model.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def numberOfItemsets: Int
The number of itemsets contained in the model.
The number of itemsets contained in the model.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def numberOfRules: Int
The number of rules contained in the model.
The number of rules contained in the model.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def numberOfTransactions: Int
The number of transactions contained in the input data.
The number of transactions contained in the input data.
- Definition Classes
- HasWrappedAssociationAttributes → HasAssociationAttributes
- def opType(name: String): OpType
Returns optype of the specified target.
Returns optype of the specified target.
- Definition Classes
- Model
- lazy val opType: OpType
When Target specifies optype then it overrides the optype attribute in a corresponding MiningField, if it exists.
When Target specifies optype then it overrides the optype attribute in a corresponding MiningField, if it exists. If the target does not specify optype then the MiningField is used as default. And, in turn, if the MiningField does not specify an optype, it is taken from the corresponding DataField. In other words, a MiningField overrides a DataField, and a Target overrides a MiningField.
- Definition Classes
- Model
- val output: Option[Output]
- Definition Classes
- AssociationModel → HasOutput
- def outputFields: Array[OutputField]
- Definition Classes
- HasOutput
- def outputIndex(feature: ResultFeature, value: Option[Any] = None): Int
- Definition Classes
- HasOutput
- def outputNames: Array[String]
- Definition Classes
- HasOutput
- def outputSchema: StructType
The schema of final outputs.
The schema of final outputs.
- Definition Classes
- Model
- var parent: Model
The parent model.
The parent model.
- Definition Classes
- AssociationModel → HasParent
- def postClassification(name: String = null): (Any, Map[Any, Double])
- Attributes
- protected
- Definition Classes
- Model
- def postPredictedValue(outputs: MutablePredictedValue, name: String = null): MutablePredictedValue
- Attributes
- protected
- Definition Classes
- Model
- def postRegression(predictedValue: Any, name: String = null): Any
- Attributes
- protected
- Definition Classes
- Model
- def predict(values: Series): Series
Predicts values for a given data series.
Predicts values for a given data series.
- Definition Classes
- AssociationModel → Model → Predictable
- def predict(it: Iterator[Series]): Iterator[Series]
- Definition Classes
- Model
- def predict(json: String): String
Predicts one or multiple records in json format, there are two formats supported:
Predicts one or multiple records in json format, there are two formats supported:
- ‘records’ : list like [{column -> value}, … , {column -> value}] - ‘split’ : dict like {‘columns’ -> [columns], ‘data’ -> [values]}
- json
Records in json
- returns
Results in json
- Definition Classes
- Model
- def predict(values: List[Any]): List[Any]
- Definition Classes
- Model
- def predict[T](values: Array[T]): Array[Any]
Predicts values for a given Array, and the order of those values is supposed as same as the input fields list
Predicts values for a given Array, and the order of those values is supposed as same as the input fields list
- Definition Classes
- Model
- def predict(values: (String, Any)*): Seq[(String, Any)]
Predicts values for a given list of key/value pairs.
Predicts values for a given list of key/value pairs.
- Definition Classes
- Model
- def predict(values: Map[String, Any]): Map[String, Any]
Predicts values for a given data map of Java.
Predicts values for a given data map of Java.
- Definition Classes
- Model
- def predict(values: Map[String, Any]): Map[String, Any]
Predicts values for a given data map.
Predicts values for a given data map.
- Definition Classes
- Model
- lazy val predictedValueIndex: Int
- Definition Classes
- HasOutput
- def prepare(series: Series): (Series, Boolean)
Pre-process the input series.
Pre-process the input series.
- Attributes
- protected
- Definition Classes
- Model
- def probabilitiesSupported: Boolean
Tests if probabilities of categories of target can be produced by this model.
Tests if probabilities of categories of target can be produced by this model.
- Definition Classes
- Model
- def result(series: Series, modelOutputs: ModelOutputs, fields: Array[OutputField] = Array.empty): Series
- Attributes
- protected
- Definition Classes
- Model
- def setOutputFields(outputFields: Array[OutputField]): AssociationModel.this.type
- Definition Classes
- HasOutput
- def setParent(parent: Model): AssociationModel.this.type
- Definition Classes
- HasParent
- def setSupplementOutput(value: Boolean): AssociationModel.this.type
- Definition Classes
- HasOutput
- def singleTarget: Boolean
- Definition Classes
- HasTargetFields
- def size: Int
- Definition Classes
- HasTargetFields
- val supplementOutput: Boolean
A flag for whether to return those predefined output fields not exist in the output element explicitly.
A flag for whether to return those predefined output fields not exist in the output element explicitly.
- Definition Classes
- HasOutput
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- lazy val targetClasses: Map[String, Array[Any]]
The class labels of all categorical targets.
The class labels of all categorical targets.
- Definition Classes
- Model
- lazy val targetField: Field
The first target field for the supervised model.
The first target field for the supervised model.
- Definition Classes
- Model
- lazy val targetFields: Array[Field]
All target fields in an array.
All target fields in an array. Multiple target fields are allowed. It depends on the kind of the model whether prediction of multiple fields is supported.
- Definition Classes
- Model
- def targetFieldsOfResidual: Array[Field]
Returns targets that are residual values to be computed, the input data must include target values.
Returns targets that are residual values to be computed, the input data must include target values.
- Definition Classes
- HasOutput
- def targetName: String
Name of the first target for the supervised model.
Name of the first target for the supervised model.
- Definition Classes
- HasTargetFields
- lazy val targetNames: Array[String]
All target names in an array.
All target names in an array.
- Definition Classes
- Model → HasTargetFields
- def targetNamesOfResidual: Array[String]
- Definition Classes
- HasOutput
- val targets: Option[Targets]
- Definition Classes
- AssociationModel → HasTargets
- def toString(): String
- Definition Classes
- AnyRef → Any
- def topCriteria: Map[(Algorithm, RankBasis, RankOrder), Int]
- def transformationDictionary: Option[TransformationDictionary]
The optional transformation dictionary.
The optional transformation dictionary.
- Definition Classes
- Model
- def unionCandidateOutputFields: Array[OutputField]
- Definition Classes
- HasOutput
- def unionOutputFields: Array[OutputField]
- Definition Classes
- HasOutput
- lazy val usedFields: Array[Field]
Setup indices to retrieve data from series faster by index instead of name, the index is immutable when model is built because the model object could run in multiple threads, so it's important make sure the model object is totally immutable.
Setup indices to retrieve data from series faster by index instead of name, the index is immutable when model is built because the model object could run in multiple threads, so it's important make sure the model object is totally immutable.
Setup indices of targets that are usually not used by the scoring process, they are only used when residual values to be computed.
- Definition Classes
- Model
- lazy val usedSchema: StructType
The schema of used fields.
The schema of used fields.
- Definition Classes
- Model
- def version: String
PMML version.
PMML version.
- Definition Classes
- HasVersion
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()