public class StandardScaler extends Estimator<StandardScalerModel> implements DefaultParamsWritable
The "unit std" is computed using the
corrected sample standard deviation
,
which is computed as the square root of the unbiased sample variance.
Constructor and Description |
---|
StandardScaler() |
StandardScaler(String uid) |
Modifier and Type | Method and Description |
---|---|
static Params |
clear(Param<?> param) |
StandardScaler |
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) |
StandardScalerModel |
fit(Dataset<?> dataset)
Fits a model to the input data.
|
static <T> scala.Option<T> |
get(Param<T> param) |
static <T> scala.Option<T> |
getDefault(Param<T> param) |
static String |
getInputCol() |
static <T> T |
getOrDefault(Param<T> param) |
static String |
getOutputCol() |
static Param<Object> |
getParam(String paramName) |
static boolean |
getWithMean() |
boolean |
getWithMean() |
static boolean |
getWithStd() |
boolean |
getWithStd() |
static <T> boolean |
hasDefault(Param<T> param) |
static boolean |
hasParam(String paramName) |
static Param<String> |
inputCol() |
static boolean |
isDefined(Param<?> param) |
static boolean |
isSet(Param<?> param) |
static StandardScaler |
load(String path) |
static Param<String> |
outputCol() |
static Param<?>[] |
params() |
static void |
save(String path) |
static <T> Params |
set(Param<T> param,
T value) |
StandardScaler |
setInputCol(String value) |
StandardScaler |
setOutputCol(String value) |
StandardScaler |
setWithMean(boolean value) |
StandardScaler |
setWithStd(boolean value) |
static String |
toString() |
StructType |
transformSchema(StructType schema)
:: DeveloperApi ::
|
String |
uid()
An immutable unique ID for the object and its derivatives.
|
StructType |
validateAndTransformSchema(StructType schema)
Validates and transforms the input schema.
|
static void |
validateParams() |
static BooleanParam |
withMean() |
BooleanParam |
withMean()
Whether to center the data with mean before scaling.
|
static BooleanParam |
withStd() |
BooleanParam |
withStd()
Whether to scale the data to unit standard deviation.
|
static MLWriter |
write() |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
toString
write
save
public StandardScaler(String uid)
public StandardScaler()
public static StandardScaler load(String path)
public static String toString()
public static Param<?>[] params()
public static void validateParams()
public static String explainParam(Param<?> param)
public static String explainParams()
public static final boolean isSet(Param<?> param)
public static final boolean isDefined(Param<?> param)
public static boolean hasParam(String paramName)
public static Param<Object> getParam(String paramName)
public static final <T> scala.Option<T> get(Param<T> param)
public static final <T> T getOrDefault(Param<T> param)
public static final <T> scala.Option<T> getDefault(Param<T> param)
public static final <T> boolean hasDefault(Param<T> param)
public static final ParamMap extractParamMap()
public static final Param<String> inputCol()
public static final String getInputCol()
public static final Param<String> outputCol()
public static final String getOutputCol()
public static BooleanParam withMean()
public static boolean getWithMean()
public static BooleanParam withStd()
public static boolean getWithStd()
public static void save(String path) throws java.io.IOException
java.io.IOException
public static MLWriter write()
public String uid()
Identifiable
uid
in interface Identifiable
public StandardScaler setInputCol(String value)
public StandardScaler setOutputCol(String value)
public StandardScaler setWithMean(boolean value)
public StandardScaler setWithStd(boolean value)
public StandardScalerModel fit(Dataset<?> dataset)
Estimator
fit
in class Estimator<StandardScalerModel>
dataset
- (undocumented)public StructType transformSchema(StructType schema)
PipelineStage
Check transform validity and derive the output schema from the input schema.
Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.
transformSchema
in class PipelineStage
schema
- (undocumented)public StandardScaler copy(ParamMap extra)
Params
defaultCopy()
.copy
in interface Params
copy
in class Estimator<StandardScalerModel>
extra
- (undocumented)public BooleanParam withMean()
public boolean getWithMean()
public BooleanParam withStd()
public boolean getWithStd()
public StructType validateAndTransformSchema(StructType schema)