org.apache.spark.ml.classification

Class MultilayerPerceptronClassificationModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<M>

org.apache.spark.ml.PredictionModel<Vector,MultilayerPerceptronClassificationModel>

org.apache.spark.ml.classification.MultilayerPerceptronClassificationModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class MultilayerPerceptronClassificationModel
extends PredictionModel<Vector,MultilayerPerceptronClassificationModel>
implements scala.Serializable

:: Experimental :: Classification model based on the Multilayer Perceptron. Each layer has sigmoid activation function, output layer has softmax. param: uid uid param: layers array of layer sizes including input and output layers param: weights vector of initial weights for the model that consists of the weights of layers

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
MultilayerPerceptronClassificationModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Param<String>	featuresCol() Param for features column name.
String	getFeaturesCol()
String	getLabelCol()
String	getPredictionCol()
Param<String>	labelCol() Param for label column name.
int[]	layers()
int	numFeatures() Returns the number of features the model was trained on.
Param<String>	predictionCol() Param for prediction column name.
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType) Validates and transforms the input schema with the provided param map.
Vector	weights()

Methods inherited from class org.apache.spark.ml.PredictionModel

setFeaturesCol, setPredictionCol, transform, transformSchema

Methods inherited from class org.apache.spark.ml.Model

hasParent, parent, setParent

Methods inherited from class org.apache.spark.ml.Transformer

transform, transform, transform

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Method Detail

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

layers

public int[] layers()

weights

public Vector weights()

numFeatures

public int numFeatures()

Description copied from class: PredictionModel

Returns the number of features the model was trained on. If unknown, returns -1

Overrides:

numFeatures in class PredictionModel<Vector,MultilayerPerceptronClassificationModel>

copy

public MultilayerPerceptronClassificationModel copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly.

Specified by:

copy in interface Params

Specified by:

copy in class Model<MultilayerPerceptronClassificationModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema,
                                    boolean fitting,
                                    DataType featuresDataType)

Validates and transforms the input schema with the provided param map.

Parameters:

schema - input schema

fitting - whether this is in fitting

featuresDataType - SQL DataType for FeaturesType. E.g., VectorUDT for vector features.

Returns:

output schema

labelCol

public Param<String> labelCol()

Param for label column name.

Returns:

(undocumented)

getLabelCol

public String getLabelCol()

featuresCol

public Param<String> featuresCol()

Param for features column name.

Returns:

(undocumented)

getFeaturesCol

public String getFeaturesCol()

predictionCol

public Param<String> predictionCol()

Param for prediction column name.

Returns:

(undocumented)

getPredictionCol

public String getPredictionCol()