public final class OneVsRestModel extends Model<OneVsRestModel> implements MLWritable
OneVsRest
.
This stores the models resulting from training k binary classifiers: one for each class.
Each example is scored against all k models, and the model with the highest score
is picked to label the example.
param: labelMetadata Metadata of label column if it exists, or Nominal attribute representing the number of classes in training dataset otherwise. param: models The binary classification models for the reduction. The i-th model is produced by testing the i-th class (taking label 1) vs the rest (taking label 0).
Modifier and Type | Method and Description |
---|---|
protected static <T> T |
$(Param<T> param) |
static Param<Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>>> |
classifier() |
Param<Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>>> |
classifier()
param for the base binary classifier that we reduce multiclass classification into.
|
static Params |
clear(Param<?> param) |
OneVsRestModel |
copy(ParamMap extra)
Creates a copy of this instance with the same UID and some extra params.
|
protected static <T extends Params> |
copyValues(T to,
ParamMap extra) |
protected static <T extends Params> |
copyValues$default$2() |
protected static <T extends Params> |
defaultCopy(ParamMap extra) |
static java.lang.String |
explainParam(Param<?> param) |
static java.lang.String |
explainParams() |
static ParamMap |
extractParamMap() |
static ParamMap |
extractParamMap(ParamMap extra) |
static Param<java.lang.String> |
featuresCol() |
static <T> scala.Option<T> |
get(Param<T> param) |
static Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>> |
getClassifier() |
Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>> |
getClassifier() |
static <T> scala.Option<T> |
getDefault(Param<T> param) |
static java.lang.String |
getFeaturesCol() |
static java.lang.String |
getLabelCol() |
static <T> T |
getOrDefault(Param<T> param) |
static Param<java.lang.Object> |
getParam(java.lang.String paramName) |
static java.lang.String |
getPredictionCol() |
static <T> boolean |
hasDefault(Param<T> param) |
static boolean |
hasParam(java.lang.String paramName) |
static boolean |
hasParent() |
protected static void |
initializeLogIfNecessary(boolean isInterpreter) |
static boolean |
isDefined(Param<?> param) |
static boolean |
isSet(Param<?> param) |
protected static boolean |
isTraceEnabled() |
static Param<java.lang.String> |
labelCol() |
static OneVsRestModel |
load(java.lang.String path) |
protected static org.slf4j.Logger |
log() |
protected static void |
logDebug(scala.Function0<java.lang.String> msg) |
protected static void |
logDebug(scala.Function0<java.lang.String> msg,
java.lang.Throwable throwable) |
protected static void |
logError(scala.Function0<java.lang.String> msg) |
protected static void |
logError(scala.Function0<java.lang.String> msg,
java.lang.Throwable throwable) |
protected static void |
logInfo(scala.Function0<java.lang.String> msg) |
protected static void |
logInfo(scala.Function0<java.lang.String> msg,
java.lang.Throwable throwable) |
protected static java.lang.String |
logName() |
protected static void |
logTrace(scala.Function0<java.lang.String> msg) |
protected static void |
logTrace(scala.Function0<java.lang.String> msg,
java.lang.Throwable throwable) |
protected static void |
logWarning(scala.Function0<java.lang.String> msg) |
protected static void |
logWarning(scala.Function0<java.lang.String> msg,
java.lang.Throwable throwable) |
ClassificationModel[] |
models() |
static Param<?>[] |
params() |
static void |
parent_$eq(Estimator<M> x$1) |
static Estimator<M> |
parent() |
static Param<java.lang.String> |
predictionCol() |
static MLReader<OneVsRestModel> |
read() |
static void |
save(java.lang.String path) |
static <T> Params |
set(Param<T> param,
T value) |
protected static Params |
set(ParamPair<?> paramPair) |
protected static Params |
set(java.lang.String param,
java.lang.Object value) |
protected static <T> Params |
setDefault(Param<T> param,
T value) |
protected static Params |
setDefault(scala.collection.Seq<ParamPair<?>> paramPairs) |
static M |
setParent(Estimator<M> parent) |
static java.lang.String |
toString() |
Dataset<Row> |
transform(Dataset<?> dataset)
Transforms the input dataset.
|
StructType |
transformSchema(StructType schema)
:: DeveloperApi ::
|
java.lang.String |
uid()
An immutable unique ID for the object and its derivatives.
|
protected static StructType |
validateAndTransformSchema(StructType schema,
boolean fitting,
DataType featuresDataType) |
static void |
validateParams() |
MLWriter |
write()
Returns an
MLWriter instance for this ML instance. |
transform, transform, transform
transformSchema
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
save
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
public static MLReader<OneVsRestModel> read()
public static OneVsRestModel load(java.lang.String path)
public static java.lang.String toString()
public static Param<?>[] params()
public static void validateParams()
public static java.lang.String explainParam(Param<?> param)
public static java.lang.String explainParams()
public static final boolean isSet(Param<?> param)
public static final boolean isDefined(Param<?> param)
public static boolean hasParam(java.lang.String paramName)
public static Param<java.lang.Object> getParam(java.lang.String paramName)
protected static final Params set(java.lang.String param, java.lang.Object value)
public static final <T> scala.Option<T> get(Param<T> param)
public static final <T> T getOrDefault(Param<T> param)
protected static final <T> T $(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()
protected static java.lang.String logName()
protected static org.slf4j.Logger log()
protected static void logInfo(scala.Function0<java.lang.String> msg)
protected static void logDebug(scala.Function0<java.lang.String> msg)
protected static void logTrace(scala.Function0<java.lang.String> msg)
protected static void logWarning(scala.Function0<java.lang.String> msg)
protected static void logError(scala.Function0<java.lang.String> msg)
protected static void logInfo(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void logDebug(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void logTrace(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void logWarning(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void logError(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static boolean isTraceEnabled()
protected static void initializeLogIfNecessary(boolean isInterpreter)
public static Estimator<M> parent()
public static void parent_$eq(Estimator<M> x$1)
public static M setParent(Estimator<M> parent)
public static boolean hasParent()
public static final Param<java.lang.String> labelCol()
public static final java.lang.String getLabelCol()
public static final Param<java.lang.String> featuresCol()
public static final java.lang.String getFeaturesCol()
public static final Param<java.lang.String> predictionCol()
public static final java.lang.String getPredictionCol()
protected static StructType validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType)
public static Param<Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>>> classifier()
public static Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>> getClassifier()
public static void save(java.lang.String path) throws java.io.IOException
java.io.IOException
public java.lang.String uid()
Identifiable
uid
in interface Identifiable
public ClassificationModel[] models()
public StructType transformSchema(StructType schema)
PipelineStage
Derives the output schema from the input schema.
transformSchema
in class PipelineStage
schema
- (undocumented)public Dataset<Row> transform(Dataset<?> dataset)
Transformer
transform
in class Transformer
dataset
- (undocumented)public OneVsRestModel copy(ParamMap extra)
Params
copy
in interface Params
copy
in class Model<OneVsRestModel>
extra
- (undocumented)defaultCopy()
public MLWriter write()
MLWritable
MLWriter
instance for this ML instance.write
in interface MLWritable
public Param<Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>>> classifier()
OneVsRest
.public Classifier<?,? extends Classifier<java.lang.Object,Classifier,ClassificationModel>,? extends ClassificationModel<java.lang.Object,ClassificationModel>> getClassifier()