IsotonicRegression ¶

class pyspark.ml.regression. IsotonicRegression ( * , featuresCol : str = 'features' , labelCol : str = 'label' , predictionCol : str = 'prediction' , weightCol : Optional [ str ] = None , isotonic : bool = True , featureIndex : int = 0 ) [source] ¶

目前使用并行化的池相邻违规者算法实现。仅支持单变量（单一特征）算法。

新增于版本 1.6.0。

示例

           >>> from pyspark.ml.linalg import Vectors
>>> df = spark.createDataFrame([
...     (1.0, Vectors.dense(1.0)),
...     (0.0, Vectors.sparse(1, [], []))], ["label", "features"])
>>> ir = IsotonicRegression()
>>> model = ir.fit(df)
>>> model.setFeaturesCol("features")
IsotonicRegressionModel...
>>> model.numFeatures
1
>>> test0 = spark.createDataFrame([(Vectors.dense(-1.0),)], ["features"])
>>> model.transform(test0).head().prediction
0.0
>>> model.predict(test0.head().features[model.getFeatureIndex()])
0.0
>>> model.boundaries
DenseVector([0.0, 1.0])
>>> ir_path = temp_path + "/ir"
>>> ir.save(ir_path)
>>> ir2 = IsotonicRegression.load(ir_path)
>>> ir2.getIsotonic()
True
>>> model_path = temp_path + "/ir_model"
>>> model.save(model_path)
>>> model2 = IsotonicRegressionModel.load(model_path)
>>> model.boundaries == model2.boundaries
True
>>> model.predictions == model2.predictions
True
>>> model.transform(test0).take(1) == model2.transform(test0).take(1)
True

          

方法

`clear` (参数)	如果参数已明确设置，则从参数映射中清除该参数。
`copy` ([extra])	创建此实例的副本，具有相同的uid和一些额外的参数。
`explainParam` (参数)	解释单个参数并返回其名称、文档以及可选的默认值和用户提供的值的字符串。
`explainParams` ()	返回所有参数的文档，包括它们可选的默认值和用户提供的值。
`extractParamMap` ([extra])	提取嵌入的默认参数值和用户提供的值，然后将它们与输入中的额外值合并到一个扁平的参数映射中，如果存在冲突，则使用后者的值，即顺序为：默认参数值 < 用户提供的值 < 额外值。
`fit` (数据集[, 参数])	使用可选参数将模型拟合到输入数据集。
`fitMultiple` (数据集, 参数映射)	为输入数据集中的每个参数映射拟合一个模型。
`getFeatureIndex` ()	获取featureIndex的值或其默认值。
`getFeaturesCol` ()	获取featuresCol的值或其默认值。
`getIsotonic` ()	获取isotonic的值或其默认值。
`getLabelCol` ()	获取 labelCol 的值或其默认值。
`getOrDefault` (参数)	获取用户提供的参数映射中的参数值或其默认值。
`getParam` (paramName)	根据名称获取参数。
`getPredictionCol` ()	获取 predictionCol 的值或其默认值。
`getWeightCol` ()	获取 weightCol 的值或其默认值。
`hasDefault` (参数)	检查参数是否具有默认值。
`hasParam` (paramName)	测试此实例是否包含具有给定（字符串）名称的参数。
`isDefined` (参数)	检查参数是否由用户显式设置或具有默认值。
`isSet` (参数)	检查参数是否被用户显式设置。
`load` (路径)	从输入路径读取一个ML实例，是 read().load(path) 的快捷方式。
`read` ()	返回此类的一个 MLReader 实例。
`save` (路径)	将此 ML 实例保存到给定路径，是 ‘write().save(path)’ 的快捷方式。
`set` (参数, 值)	在嵌入的参数映射中设置一个参数。
`setFeatureIndex` (值)	设置 `featureIndex` 的值。
`setFeaturesCol` (值)	设置 `featuresCol` 的值。
`setIsotonic` (值)	设置 `isotonic` 的值。
`setLabelCol` (值)	设置 `labelCol` 的值。
`setParams` (*[, 特征列, 标签列, …])	setParams(self, *, featuresCol=”features”, labelCol=”label”, predictionCol=”prediction”, weightCol=None, isotonic=True, featureIndex=0): 设置IsotonicRegression的参数。
`setPredictionCol` (值)	设置 `predictionCol` 的值。
`setWeightCol` (值)	设置 `weightCol` 的值。
`write` ()	返回此ML实例的MLWriter实例。

属性

`featureIndex`
`featuresCol`
`isotonic`
`labelCol`
`参数`	返回按名称排序的所有参数。
`predictionCol`
`weightCol`

方法文档

clear ( param : pyspark.ml.param.Param ) → None ¶: 如果参数已明确设置，则从参数映射中清除该参数。

copy ( extra : Optional [ ParamMap ] = None ) → JP ¶

创建此实例的副本，具有相同的uid和一些额外的参数。此实现首先调用Params.copy，然后使用额外参数复制伴随的Java管道组件。因此，Python包装器和Java管道组件都会被复制。

Parameters

extra dict, optional: 复制到新实例的额外参数

Returns

JavaParams: 此实例的副本

explainParam ( param : Union [ str , pyspark.ml.param.Param ] ) → str ¶: 解释单个参数并返回其名称、文档以及可选的默认值和用户提供的值的字符串。

explainParams ( ) → str ¶: 返回所有参数的文档，包括它们可选的默认值和用户提供的值。

extractParamMap ( extra : Optional [ ParamMap ] = None ) → ParamMap ¶

提取嵌入的默认参数值和用户提供的值，然后将它们与输入中的额外值合并到一个扁平的参数映射中，如果存在冲突，则使用后者的值，即顺序为：默认参数值 < 用户提供的值 < 额外值。

Parameters

extra dict, optional: 额外参数值

Returns

dict: 合并的参数映射

fit ( dataset : pyspark.sql.dataframe.DataFrame , params : Union[ParamMap, List[ParamMap], Tuple[ParamMap], None] = None ) → Union [ M , List [ M ] ] ¶

使用可选参数将模型拟合到输入数据集。

新增于版本 1.3.0。

Parameters

dataset pyspark.sql.DataFrame: 输入数据集。
params dict or list or tuple, optional: 一个可选的参数映射，用于覆盖嵌入的参数。如果给定了一个参数映射的列表/元组，这将调用每个参数映射上的fit方法，并返回一个模型列表。

Returns

Transformer or a list of Transformer: 拟合模型

fitMultiple ( dataset : pyspark.sql.dataframe.DataFrame , paramMaps : Sequence [ ParamMap ] ) → Iterator [ Tuple [ int , M ] ] ¶

为输入数据集中的每个参数映射拟合一个模型。

新增于版本 2.3.0。

Parameters

dataset pyspark.sql.DataFrame: 输入数据集。
paramMaps collections.abc.Sequence: 一系列参数映射。

Returns

_FitMultipleIterator: 一个线程安全的可迭代对象，其中包含每个参数映射的一个模型。每次调用 next(modelIterator) 将返回 (index, model) ，其中模型是使用 paramMaps[index] 拟合的。 index 值可能不是连续的。

getFeatureIndex ( ) → int ¶: 获取featureIndex的值或其默认值。

getFeaturesCol ( ) → str ¶: 获取featuresCol的值或其默认值。

getIsotonic ( ) → bool ¶: 获取isotonic的值或其默认值。

getLabelCol ( ) → str ¶: 获取 labelCol 的值或其默认值。

getOrDefault ( param : Union [ str , pyspark.ml.param.Param [ T ] ] ) → Union [ Any , T ] ¶: 获取用户提供的参数映射中的参数值或其默认值。如果两者都未设置，则引发错误。

getParam ( paramName : str ) → pyspark.ml.param.Param ¶: 根据名称获取参数。

getPredictionCol ( ) → str ¶: 获取 predictionCol 的值或其默认值。

getWeightCol ( ) → str ¶: 获取 weightCol 的值或其默认值。

hasDefault ( param : Union [ str , pyspark.ml.param.Param [ Any ] ] ) → bool ¶: 检查参数是否具有默认值。

hasParam ( paramName : str ) → bool ¶: 测试此实例是否包含具有给定（字符串）名称的参数。

isDefined ( param : Union [ str , pyspark.ml.param.Param [ Any ] ] ) → bool ¶: 检查参数是否由用户显式设置或具有默认值。

isSet ( param : Union [ str , pyspark.ml.param.Param [ Any ] ] ) → bool ¶: 检查参数是否被用户显式设置。

classmethod load ( path : str ) → RL ¶: 从输入路径读取一个ML实例，是 read().load(path) 的快捷方式。

classmethod read ( ) → pyspark.ml.util.JavaMLReader [ RL ] ¶: 返回此类的一个 MLReader 实例。

save ( path : str ) → None ¶: 将此 ML 实例保存到给定路径，是 ‘write().save(path)’ 的快捷方式。

set ( param : pyspark.ml.param.Param , value : Any ) → None ¶: 在嵌入的参数映射中设置一个参数。

setFeatureIndex ( value : int ) → pyspark.ml.regression.IsotonicRegression [source] ¶: 设置 featureIndex 的值。

setFeaturesCol ( value : str ) → pyspark.ml.regression.IsotonicRegression [source] ¶: 设置 featuresCol 的值。

新增于版本 1.6.0。

setIsotonic ( value : bool ) → pyspark.ml.regression.IsotonicRegression [source] ¶: 设置 isotonic 的值。

setLabelCol ( value : str ) → pyspark.ml.regression.IsotonicRegression [source] ¶: 设置 labelCol 的值。

新增于版本 1.6.0。

setParams ( * , featuresCol : str = 'features' , labelCol : str = 'label' , predictionCol : str = 'prediction' , weightCol : Optional [ str ] = None , isotonic : bool = True , featureIndex : int = 0 ) → pyspark.ml.regression.IsotonicRegression [source] ¶: setParams(self, *, featuresCol=”features”, labelCol=”label”, predictionCol=”prediction”, weightCol=None, isotonic=True, featureIndex=0): 设置IsotonicRegression的参数。

setPredictionCol ( value : str ) → pyspark.ml.regression.IsotonicRegression [source] ¶: 设置 predictionCol 的值。

新增于版本 1.6.0。

setWeightCol ( value : str ) → pyspark.ml.regression.IsotonicRegression [source] ¶: 设置 weightCol 的值。

新增于版本 1.6.0。

write ( ) → pyspark.ml.util.JavaMLWriter ¶: 返回此ML实例的MLWriter实例。

属性文档

featureIndex = Param(parent='undefined', name='featureIndex', doc='The index of the feature if featuresCol is a vector column, no effect otherwise.') ¶

featuresCol = Param(parent='undefined', name='featuresCol', doc='features column name.') ¶

isotonic = Param(parent='undefined', name='isotonic', doc='whether the output sequence should be isotonic/increasing (true) orantitonic/decreasing (false).') ¶

labelCol = Param(parent='undefined', name='labelCol', doc='label column name.') ¶

params ¶: 返回按名称排序的所有参数。默认实现使用 dir() 获取所有类型为 Param 的属性。

predictionCol = Param(parent='undefined', name='predictionCol', doc='prediction column name.') ¶

weightCol = Param(parent='undefined', name='weightCol', doc='weight column name. If this is not set or empty, we treat all instance weights as 1.0.') ¶

广义线性回归训练摘要

等渗回归模型