Package org.apache.spark.ml

Class Model<M extends Model<M>>

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

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

Type Parameters:

M - model type

All Implemented Interfaces:

Serializable, org.apache.spark.internal.Logging, Params, Identifiable

Direct Known Subclasses:

ALSModel, BisectingKMeansModel, BucketedRandomProjectionLSHModel, Bucketizer, ChiSqSelectorModel, CountVectorizerModel, CrossValidatorModel, FPGrowthModel, GaussianMixtureModel, IDFModel, ImputerModel, IsotonicRegressionModel, KMeansModel, LDAModel, MaxAbsScalerModel, MinHashLSHModel, MinMaxScalerModel, OneHotEncoderModel, OneVsRestModel, PCAModel, PipelineModel, PredictionModel, RFormulaModel, RobustScalerModel, StandardScalerModel, StringIndexerModel, TargetEncoderModel, TrainValidationSplitModel, UnivariateFeatureSelectorModel, VarianceThresholdSelectorModel, VectorIndexerModel, Word2VecModel

public abstract class Model<M extends Model<M>>
extends Transformer

A fitted model, i.e., a Transformer produced by an Estimator.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging

org.apache.spark.internal.Logging.LogStringContext, org.apache.spark.internal.Logging.SparkShellLoggingFilter

Constructor Summary

Constructors

Constructor	Description
Model()

Method Summary

Modifier and Type	Method	Description
abstract M	copy(ParamMap extra)	Creates a copy of this instance with the same UID and some extra params.
boolean	hasParent()	Indicates whether this Model has a corresponding parent.
Estimator<M>	parent()	The parent estimator that produced this model.
M	setParent(Estimator<M> parent)	Sets the parent of this model (Java API).

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

transform, transform, transform, transform

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

params, transformSchema

Methods inherited from class java.lang.Object

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

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

toString, uid

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

initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, isTraceEnabled, log, logBasedOnLevel, logDebug, logDebug, logDebug, logDebug, logError, logError, logError, logError, logInfo, logInfo, logInfo, logInfo, logName, LogStringContext, logTrace, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, logWarning, MDC, org$apache$spark$internal$Logging$$log_, org$apache$spark$internal$Logging$$log__$eq, withLogContext

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

clear, copyValues, defaultCopy, estimateMatadataSize, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, onParamChange, set, set, set, setDefault, setDefault, shouldOwn

Constructor Details

Model

public Model()

Method Details

copy

public abstract M 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 Transformer

Parameters:

extra - (undocumented)

Returns:

(undocumented)

hasParent

public boolean hasParent()

Indicates whether this Model has a corresponding parent.

parent

public Estimator<M> parent()

The parent estimator that produced this model.

Returns:

(undocumented)

Note:

For ensembles' component Models, this value can be null.

setParent

public M setParent(Estimator<M> parent)

Sets the parent of this model (Java API).

Parameters:

parent - (undocumented)

Returns:

(undocumented)