Packages

c

org.pmml4s.model

SupportVectorMachineModel

class SupportVectorMachineModel extends Model with HasWrappedSupportVectorMachineAttributes

Support Vector Machine models for classification and regression are considered. A Support Vector Machine is a function f which is defined in the space spanned by the kernel basis functions K(x,xi) of the support vectors xi: f(x) = Sum_(i=1)n αi*K(x,xi) + b.

Here n is the number of all support vectors, αi are the basis coefficients and b is the absolute coefficient. In an equivalent interpretation, n could also be considered as the total number of all training vectors xi. Then the support vectors are the subset of all those vectors xi whose coefficients αi are greater than zero. The term Support Vector (SV) has also a geometrical interpretation because these vectors really support the discrimination function f(x) = 0 in the mechanical interpretation.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SupportVectorMachineModel
  2. HasWrappedSupportVectorMachineAttributes
  3. HasSupportVectorMachineAttributes
  4. Model
  5. PmmlElement
  6. Serializable
  7. HasExtensions
  8. HasModelVerification
  9. Predictable
  10. HasTargetFields
  11. ModelLocation
  12. FieldScope
  13. HasField
  14. HasLocalTransformations
  15. HasTargets
  16. HasModelExplanation
  17. HasModelStats
  18. HasOutput
  19. HasMiningSchema
  20. HasWrappedModelAttributes
  21. HasModelAttributes
  22. HasVersion
  23. HasParent
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SupportVectorMachineModel(parent: Model, attributes: SupportVectorMachineAttributes, miningSchema: MiningSchema, kernelType: KernelType, vectorDictionary: VectorDictionary, supportVectorMachines: Array[SupportVectorMachine], 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val NullOutputsPair: (Series, ModelOutputs)
    Attributes
    protected
    Definition Classes
    Model
  5. 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
    HasWrappedModelAttributesHasModelAttributes
  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val attributes: SupportVectorMachineAttributes

    Common attributes of this model

  9. def candidateOutputFields: Array[OutputField]
    Definition Classes
    HasOutput
  10. def candidateOutputSchema: StructType

    The schema of candidate outputs.

    The schema of candidate outputs.

    Definition Classes
    Model
  11. def classes(name: String): Array[DataVal]

    Returns class labels of the specified target.

    Returns class labels of the specified target.

    Definition Classes
    Model
  12. lazy val classes: Array[DataVal]

    The class labels in a classification model.

    The class labels in a classification model.

    Definition Classes
    Model
  13. def classificationMethod: SVMClassificationMethod

    Defines which method is to be used in case of multi-class classification tasks.

    Defines which method is to be used in case of multi-class classification tasks. It can be either OneAgainstAll or OneAgainstOne. This attribute is not required for binary classification or regression.

    Definition Classes
    HasWrappedSupportVectorMachineAttributesHasSupportVectorMachineAttributes
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  15. def combineOutputFields(listA: Array[OutputField], listB: Array[OutputField]): Array[OutputField]
    Definition Classes
    HasOutput
  16. def containInterResults: Boolean
    Definition Classes
    HasOutput
  17. def createOutputs(): SVMOutputs

    Creates an object of SVMOutputs that is for writing into an output series.

    Creates an object of SVMOutputs that is for writing into an output series.

    Definition Classes
    SupportVectorMachineModelModel
  18. 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
  19. def dVersion: Double

    Returns PMML version as a double value

    Returns PMML version as a double value

    Definition Classes
    HasVersion
  20. def dataDictionary: DataDictionary

    The data dictionary of this model.

    The data dictionary of this model.

    Definition Classes
    Model
  21. def defaultOutputFields: Array[OutputField]

    Returns all candidates output fields of this model when there is no output specified explicitly.

    Returns all candidates output fields of this model when there is no output specified explicitly.

    Definition Classes
    Model
  22. def encode(series: Series): DSeries

    Encodes the input series.

    Encodes the input series.

    Attributes
    protected
    Definition Classes
    Model
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. val extensions: Seq[Extension]
  26. def field(name: String): Field

    Returns the field of a given name.

    Returns the field of a given name.

    Definition Classes
    HasField
    Exceptions thrown

    FieldNotFoundException if a field with the given name does not exist

  27. 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
  28. 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
    HasWrappedModelAttributesHasModelAttributes
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  30. def getField(name: String): Option[Field]

    Returns the field of a given name, None if a field with the given name does not exist.

    Returns the field of a given name, None if a field with the given name does not exist.

    Definition Classes
    ModelHasField
  31. def hasExtensions: Boolean
    Definition Classes
    HasExtensions
  32. def hasTarget: Boolean
    Definition Classes
    HasTargetFields
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  34. def header: Header

    The header of this model.

    The header of this model.

    Definition Classes
    Model
  35. 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
  36. def importances: Map[String, Double]

    Returns importances of predictors.

    Returns importances of predictors.

    Definition Classes
    Model
  37. def inferClasses: Array[DataVal]

    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
  38. lazy val inputDerivedFields: Array[Field]

    Referenced derived fields.

    Referenced derived fields.

    Definition Classes
    Model
  39. lazy val inputFields: Array[Field]

    All input fields in an array.

    All input fields in an array.

    Definition Classes
    Model
  40. lazy val inputNames: Array[String]

    All input names in an array.

    All input names in an array.

    Definition Classes
    Model
  41. lazy val inputSchema: StructType

    The schema of inputs.

    The schema of inputs.

    Definition Classes
    Model
  42. def isAssociationRules: Boolean

    Tests if this is a association rules model.

    Tests if this is a association rules model.

    Definition Classes
    HasModelAttributes
  43. def isBinary: Boolean

    Tests if the target is a binary field

    Tests if the target is a binary field

    Definition Classes
    Model
  44. 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
  45. def isClassification: Boolean

    Tests if this is a classification model.

    Tests if this is a classification model.

    Definition Classes
    ModelHasModelAttributes
  46. def isClustering: Boolean

    Tests if this is a clustering model.

    Tests if this is a clustering model.

    Definition Classes
    HasModelAttributes
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. def isMixed: Boolean

    Tests if this is a mixed model.

    Tests if this is a mixed model.

    Definition Classes
    HasModelAttributes
  49. def isOrdinal: Boolean

    Tests if the target is an ordinal field

    Tests if the target is an ordinal field

    Definition Classes
    Model
  50. def isPredictionOnly: Boolean
    Definition Classes
    HasOutput
  51. 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
  52. def isRegression: Boolean

    Tests if this is a regression model.

    Tests if this is a regression model.

    Definition Classes
    ModelHasModelAttributes
  53. 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
    HasWrappedModelAttributesHasModelAttributes
  54. def isSequences: Boolean

    Tests if this is a sequences model.

    Tests if this is a sequences model.

    Definition Classes
    HasModelAttributes
  55. val isSubModel: Boolean
    Definition Classes
    ModelLocation
  56. def isTimeSeries: Boolean

    Tests if this is a time series model.

    Tests if this is a time series model.

    Definition Classes
    HasModelAttributes
  57. val isTopLevelModel: Boolean
    Definition Classes
    ModelLocation
  58. val kernelType: KernelType
  59. val localTransformations: Option[LocalTransformations]

    The optional local transformations.

    The optional local transformations.

    Definition Classes
    SupportVectorMachineModelHasLocalTransformations
  60. def maxWins: Boolean

    Used for classification models only.

    Used for classification models only. It determines if the target category corresponding to the highest value of a Support Vector machine is the winner. Default value is false, meaning the target category with the lowest SVM value wins, consistent with previous PMML versions. This attribute also affects the comparisons with threshold value, see below for details.

    Definition Classes
    HasWrappedSupportVectorMachineAttributesHasSupportVectorMachineAttributes
  61. val miningSchema: MiningSchema
  62. def modelElement: ModelElement

    Model element type.

    Model element type.

    Definition Classes
    SupportVectorMachineModelModel
  63. val modelExplanation: Option[ModelExplanation]
  64. 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
    HasWrappedModelAttributesHasModelAttributes
  65. val modelStats: Option[ModelStats]
  66. val modelVerification: Option[ModelVerification]
  67. def multiTargets: Boolean
    Definition Classes
    HasTargetFields
  68. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  69. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  70. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  71. 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
  72. 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
  73. 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
  74. def opType(name: String): OpType

    Returns optype of the specified target.

    Returns optype of the specified target.

    Definition Classes
    Model
  75. 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
  76. val output: Option[Output]
    Definition Classes
    SupportVectorMachineModelHasOutput
  77. def outputFields: Array[OutputField]
    Definition Classes
    HasOutput
  78. def outputIndex(feature: ResultFeature, value: Option[Any] = None): Int
    Definition Classes
    HasOutput
  79. def outputNames: Array[String]
    Definition Classes
    HasOutput
  80. def outputSchema: StructType

    The schema of final outputs.

    The schema of final outputs.

    Definition Classes
    Model
  81. var parent: Model

    The parent model.

    The parent model.

    Definition Classes
    SupportVectorMachineModelHasParent
  82. def postClassification(name: String = null): (DataVal, Map[DataVal, Double])
    Attributes
    protected
    Definition Classes
    Model
  83. def postPredictedValue(outputs: MutablePredictedValue, name: String = null): MutablePredictedValue
    Attributes
    protected
    Definition Classes
    Model
  84. def postRegression(predictedValue: DataVal, name: String = null): DataVal
    Attributes
    protected
    Definition Classes
    Model
  85. def predict(values: Series): Series

    Predicts values for a given data series.

    Predicts values for a given data series.

    values

    An input data series

    returns

    An output data series

    Definition Classes
    SupportVectorMachineModelModelPredictable
  86. def predict(it: Iterator[Series]): Iterator[Series]
    Definition Classes
    Model
  87. 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
  88. def predict(values: List[Any]): List[Any]
    Definition Classes
    Model
  89. 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
  90. 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
  91. 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
  92. 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
  93. lazy val predictedValueIndex: Int
    Definition Classes
    HasOutput
  94. def prepare(series: Series): (Series, Boolean)

    Pre-process the input series.

    Pre-process the input series.

    Attributes
    protected
    Definition Classes
    Model
  95. 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
    SupportVectorMachineModelModel
  96. def result(series: Series, modelOutputs: ModelOutputs, fields: Array[OutputField] = Array.empty): Series
    Attributes
    protected
    Definition Classes
    Model
  97. def score(values: Series, modelOutputs: Option[ModelOutputs] = None): (Series, ModelOutputs)

    Predicts value for a given data series

    Predicts value for a given data series

    values

    An input data series

    modelOutputs

    An input model outputs that can hold all results, it will be ignored if its type doesn't match the current model.

    returns

    An object of model outputs

    Definition Classes
    Model
  98. def setOutputFields(outputFields: Array[OutputField]): SupportVectorMachineModel.this.type
    Definition Classes
    HasOutput
  99. def setParent(parent: Model): SupportVectorMachineModel.this.type
    Definition Classes
    HasParent
  100. def setSupplementOutput(value: Boolean): SupportVectorMachineModel.this.type
    Definition Classes
    HasOutput
  101. def singleTarget: Boolean
    Definition Classes
    HasTargetFields
  102. def size: Int
    Definition Classes
    HasTargetFields
  103. 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
  104. val supportVectorMachines: Array[SupportVectorMachine]
  105. def svmRepresentation: SVMRepresentation

    Defines whether the SVM function is defined via support vectors or via the coefficients of the hyperplane for the case of linear kernel functions.

    Defines whether the SVM function is defined via support vectors or via the coefficients of the hyperplane for the case of linear kernel functions.

    Definition Classes
    HasWrappedSupportVectorMachineAttributesHasSupportVectorMachineAttributes
  106. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  107. lazy val targetClasses: Map[String, Array[DataVal]]

    The class labels of all categorical targets.

    The class labels of all categorical targets.

    Definition Classes
    Model
  108. lazy val targetField: Field

    The first target field for the supervised model.

    The first target field for the supervised model.

    Definition Classes
    Model
  109. 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
  110. 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
  111. def targetName: String

    Name of the first target for the supervised model.

    Name of the first target for the supervised model.

    Definition Classes
    HasTargetFields
  112. lazy val targetNames: Array[String]

    All target names in an array.

    All target names in an array.

    Definition Classes
    ModelHasTargetFields
  113. def targetNamesOfResidual: Array[String]
    Definition Classes
    HasOutput
  114. val targets: Option[Targets]
  115. def threshold: Double

    Defines a discrimination boundary to be used in case of binary classification or whenever attribute classificationMethod is defined as OneAgainstOne for multi-class classification tasks.

    Defines a discrimination boundary to be used in case of binary classification or whenever attribute classificationMethod is defined as OneAgainstOne for multi-class classification tasks.

    Definition Classes
    HasWrappedSupportVectorMachineAttributesHasSupportVectorMachineAttributes
  116. def toString(): String
    Definition Classes
    AnyRef → Any
  117. def transformationDictionary: Option[TransformationDictionary]

    The optional transformation dictionary.

    The optional transformation dictionary.

    Definition Classes
    Model
  118. def unionCandidateOutputFields: Array[OutputField]
    Definition Classes
    HasOutput
  119. def unionOutputFields: Array[OutputField]
    Definition Classes
    HasOutput
  120. 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
  121. lazy val usedSchema: StructType

    The schema of used fields.

    The schema of used fields.

    Definition Classes
    Model
  122. val vectorDictionary: VectorDictionary
  123. def version: String

    PMML version.

    PMML version.

    Definition Classes
    HasVersion
  124. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  125. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  126. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Model

Inherited from PmmlElement

Inherited from Serializable

Inherited from HasExtensions

Inherited from HasModelVerification

Inherited from Predictable

Inherited from HasTargetFields

Inherited from ModelLocation

Inherited from FieldScope

Inherited from HasField

Inherited from HasTargets

Inherited from HasModelExplanation

Inherited from HasModelStats

Inherited from HasOutput

Inherited from HasMiningSchema

Inherited from HasModelAttributes

Inherited from HasVersion

Inherited from HasParent

Inherited from AnyRef

Inherited from Any

Ungrouped