mmlspark.train package

Submodules

mmlspark.train.ComputeModelStatistics module

class mmlspark.train.ComputeModelStatistics.ComputeModelStatistics(evaluationMetric='all', labelCol=None, scoredLabelsCol=None, scoresCol=None)

Bases: mmlspark.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

• evaluationMetric (str) – Metric to evaluate models with (default: all)

• labelCol (str) – The name of the label column

• scoredLabelsCol (str) – Scored labels column name, only required if using SparkML estimators

• scoresCol (str) – Scores or raw prediction column name, only required if using SparkML estimators

getEvaluationMetric()

Returns

Metric to evaluate models with (default: all)

Return type

str

static getJavaPackage()

Returns package name String.

getLabelCol()

Returns

The name of the label column

Return type

str

getScoredLabelsCol()

Returns

Scored labels column name, only required if using SparkML estimators

Return type

str

getScoresCol()

Returns

Scores or raw prediction column name, only required if using SparkML estimators

Return type

str

classmethod read()

Returns an MLReader instance for this class.

setEvaluationMetric(value)

Parameters

evaluationMetric (str) – Metric to evaluate models with (default: all)

setLabelCol(value)

Parameters

labelCol (str) – The name of the label column

setParams(evaluationMetric='all', labelCol=None, scoredLabelsCol=None, scoresCol=None)

Set the (keyword only) parameters

Parameters

• evaluationMetric (str) – Metric to evaluate models with (default: all)

• labelCol (str) – The name of the label column

• scoredLabelsCol (str) – Scored labels column name, only required if using SparkML estimators

• scoresCol (str) – Scores or raw prediction column name, only required if using SparkML estimators

setScoredLabelsCol(value)

Parameters

scoredLabelsCol (str) – Scored labels column name, only required if using SparkML estimators

setScoresCol(value)

Parameters

scoresCol (str) – Scores or raw prediction column name, only required if using SparkML estimators

mmlspark.train.ComputePerInstanceStatistics module

class mmlspark.train.ComputePerInstanceStatistics.ComputePerInstanceStatistics(evaluationMetric='all', labelCol=None, scoredLabelsCol=None, scoredProbabilitiesCol=None, scoresCol=None)

Bases: mmlspark.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

• evaluationMetric (str) – Metric to evaluate models with (default: all)

• labelCol (str) – The name of the label column

• scoredLabelsCol (str) – Scored labels column name, only required if using SparkML estimators

• scoredProbabilitiesCol (str) – Scored probabilities, usually calibrated from raw scores, only required if using SparkML estimators

• scoresCol (str) – Scores or raw prediction column name, only required if using SparkML estimators

getEvaluationMetric()

Returns

Metric to evaluate models with (default: all)

Return type

str

static getJavaPackage()

Returns package name String.

getLabelCol()

Returns

The name of the label column

Return type

str

getScoredLabelsCol()

Returns

Scored labels column name, only required if using SparkML estimators

Return type

str

getScoredProbabilitiesCol()

Returns

Scored probabilities, usually calibrated from raw scores, only required if using SparkML estimators

Return type

str

getScoresCol()

Returns

Scores or raw prediction column name, only required if using SparkML estimators

Return type

str

classmethod read()

Returns an MLReader instance for this class.

setEvaluationMetric(value)

Parameters

evaluationMetric (str) – Metric to evaluate models with (default: all)

setLabelCol(value)

Parameters

labelCol (str) – The name of the label column

setParams(evaluationMetric='all', labelCol=None, scoredLabelsCol=None, scoredProbabilitiesCol=None, scoresCol=None)

Set the (keyword only) parameters

Parameters

• evaluationMetric (str) – Metric to evaluate models with (default: all)

• labelCol (str) – The name of the label column

• scoredLabelsCol (str) – Scored labels column name, only required if using SparkML estimators

• scoredProbabilitiesCol (str) – Scored probabilities, usually calibrated from raw scores, only required if using SparkML estimators

• scoresCol (str) – Scores or raw prediction column name, only required if using SparkML estimators

setScoredLabelsCol(value)

Parameters

scoredLabelsCol (str) – Scored labels column name, only required if using SparkML estimators

setScoredProbabilitiesCol(value)

Parameters

scoredProbabilitiesCol (str) – Scored probabilities, usually calibrated from raw scores, only required if using SparkML estimators

setScoresCol(value)

Parameters

scoresCol (str) – Scores or raw prediction column name, only required if using SparkML estimators

mmlspark.train.TrainClassifier module

class mmlspark.train.TrainClassifier.TrainClassifier(featuresCol=None, labelCol=None, labels=None, model=None, numFeatures=0, reindexLabel=True)

Bases: mmlspark.train._TrainClassifier._TrainClassifier

class mmlspark.train.TrainClassifier.TrainedClassifierModel(java_model=None)

Bases: mmlspark.train._TrainClassifier._TrainedClassifierModel

getModel()

Get the underlying model.

mmlspark.train.TrainRegressor module

class mmlspark.train.TrainRegressor.TrainRegressor(featuresCol=None, labelCol=None, model=None, numFeatures=0)

Bases: mmlspark.train._TrainRegressor._TrainRegressor

class mmlspark.train.TrainRegressor.TrainedRegressorModel(java_model=None)

Bases: mmlspark.train._TrainRegressor._TrainedRegressorModel

getModel()

Get the underlying model.

Module contents

MicrosoftML is a library of Python classes to interface with the Microsoft scala APIs to utilize Apache Spark to create distibuted machine learning models.

MicrosoftML simplifies training and scoring classifiers and regressors, as well as facilitating the creation of models using the CNTK library, images, and text.