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<FeaturesType,M>

org.apache.spark.ml.classification.ClassificationModel<FeaturesType,M>

org.apache.spark.ml.classification.ProbabilisticClassificationModel<Vector,MultilayerPerceptronClassificationModel>

org.apache.spark.ml.classification.MultilayerPerceptronClassificationModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable, MLWritable

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

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 the weights of layers

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Params	clear(Param<?> param)
MultilayerPerceptronClassificationModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static String	explainParam(Param<?> param)
static String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static Param<String>	featuresCol()
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static String	getFeaturesCol()
static String	getLabelCol()
static <T> T	getOrDefault(Param<T> param)
static Param<Object>	getParam(String paramName)
static String	getPredictionCol()
static String	getProbabilityCol()
static String	getRawPredictionCol()
static double[]	getThresholds()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static boolean	hasParent()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static Param<String>	labelCol()
int[]	layers()
static MultilayerPerceptronClassificationModel	load(String path)
int	numClasses()
int	numFeatures()
static Param<?>[]	params()
static void	parent_$eq(Estimator<M> x$1)
static Estimator<M>	parent()
static Param<String>	predictionCol()
static Param<String>	probabilityCol()
static Param<String>	rawPredictionCol()
static MLReader<MultilayerPerceptronClassificationModel>	read()
static void	save(String path)
static <T> Params	set(Param<T> param, T value)
static M	setFeaturesCol(String value)
static M	setParent(Estimator<M> parent)
static M	setPredictionCol(String value)
static M	setProbabilityCol(String value)
static M	setRawPredictionCol(String value)
static M	setThresholds(double[] value)
static DoubleArrayParam	thresholds()
static String	toString()
static Dataset<Row>	transform(Dataset<?> dataset)
static Dataset<Row>	transform(Dataset<?> dataset, ParamMap paramMap)
static Dataset<Row>	transform(Dataset<?> dataset, ParamPair<?> firstParamPair, ParamPair<?>... otherParamPairs)
static Dataset<Row>	transform(Dataset<?> dataset, ParamPair<?> firstParamPair, scala.collection.Seq<ParamPair<?>> otherParamPairs)
static StructType	transformSchema(StructType schema)
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType)
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType) Validates and transforms the input schema with the provided param map.
Vector	weights()
MLWriter	write() Returns an MLWriter instance for this ML instance.

Methods inherited from class org.apache.spark.ml.classification.ProbabilisticClassificationModel

normalizeToProbabilitiesInPlace, setProbabilityCol, setThresholds, transform

Methods inherited from class org.apache.spark.ml.classification.ClassificationModel

setRawPredictionCol

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

setFeaturesCol, setPredictionCol, 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.util.MLWritable

save

Methods inherited from interface org.apache.spark.ml.param.shared.HasRawPredictionCol

getRawPredictionCol, rawPredictionCol

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

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

toString

Methods inherited from interface org.apache.spark.ml.param.shared.HasProbabilityCol

getProbabilityCol, probabilityCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasThresholds

getThresholds, thresholds

Methods inherited from interface org.apache.spark.ml.param.shared.HasLabelCol

getLabelCol, labelCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasFeaturesCol

featuresCol, getFeaturesCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasPredictionCol

getPredictionCol, predictionCol

Methods inherited from interface org.apache.spark.internal.Logging

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

Method Detail

read

public static MLReader<MultilayerPerceptronClassificationModel> read()

load

public static MultilayerPerceptronClassificationModel load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

explainParam

public static String explainParam(Param<?> param)

explainParams

public static String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(String paramName)

getParam

public static Param<Object> getParam(String paramName)

set

public static final <T> Params set(Param<T> param,
                                   T value)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

transform

public static Dataset<Row> transform(Dataset<?> dataset,
                                     ParamPair<?> firstParamPair,
                                     scala.collection.Seq<ParamPair<?>> otherParamPairs)

transform

public static Dataset<Row> transform(Dataset<?> dataset,
                                     ParamMap paramMap)

transform

public static Dataset<Row> transform(Dataset<?> dataset,
                                     ParamPair<?> firstParamPair,
                                     ParamPair<?>... otherParamPairs)

parent

public static Estimator<M> parent()

parent_$eq

public static void parent_$eq(Estimator<M> x$1)

setParent

public static M setParent(Estimator<M> parent)

hasParent

public static boolean hasParent()

labelCol

public static final Param<String> labelCol()

getLabelCol

public static final String getLabelCol()

featuresCol

public static final Param<String> featuresCol()

getFeaturesCol

public static final String getFeaturesCol()

predictionCol

public static final Param<String> predictionCol()

getPredictionCol

public static final String getPredictionCol()

setFeaturesCol

public static M setFeaturesCol(String value)

setPredictionCol

public static M setPredictionCol(String value)

transformSchema

public static StructType transformSchema(StructType schema)

rawPredictionCol

public static final Param<String> rawPredictionCol()

getRawPredictionCol

public static final String getRawPredictionCol()

setRawPredictionCol

public static M setRawPredictionCol(String value)

probabilityCol

public static final Param<String> probabilityCol()

getProbabilityCol

public static final String getProbabilityCol()

thresholds

public static final DoubleArrayParam thresholds()

getThresholds

public static double[] getThresholds()

setProbabilityCol

public static M setProbabilityCol(String value)

setThresholds

public static M setThresholds(double[] value)

transform

public static Dataset<Row> transform(Dataset<?> dataset)

save

public static void save(String path)
                 throws java.io.IOException

Throws:

java.io.IOException

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

Specified by:

uid in class ProbabilisticClassificationModel<Vector,MultilayerPerceptronClassificationModel>

Returns:

(undocumented)

layers

public int[] layers()

weights

public Vector weights()

numFeatures

public int numFeatures()

Overrides:

numFeatures in class ProbabilisticClassificationModel<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. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class ProbabilisticClassificationModel<Vector,MultilayerPerceptronClassificationModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

numClasses

public int numClasses()

Specified by:

numClasses in class ProbabilisticClassificationModel<Vector,MultilayerPerceptronClassificationModel>

validateAndTransformSchema

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

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