Skip to content

[SPARK-15957][Follow-up][ML][PySpark] Add Python API for RFormula forceIndexLabel. #15430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yanboliang wants to merge 1 commit into from
Closed

[SPARK-15957][Follow-up][ML][PySpark] Add Python API for RFormula forceIndexLabel. #15430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 27 additions & 4 deletions python/pyspark/ml/feature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2494,21 +2494,30 @@ class RFormula(JavaEstimator, HasFeaturesCol, HasLabelCol, JavaMLReadable, JavaM
formula = Param(Params._dummy(), "formula", "R model formula",
typeConverter=TypeConverters.toString)

forceIndexLabel = Param(Params._dummy(), "forceIndexLabel",
"Force to index label whether it is numeric or string",
typeConverter=TypeConverters.toBoolean)

@keyword_only
def __init__(self, formula=None, featuresCol="features", labelCol="label"):
def __init__(self, formula=None, featuresCol="features", labelCol="label",
forceIndexLabel=False):
"""
__init__(self, formula=None, featuresCol="features", labelCol="label")
__init__(self, formula=None, featuresCol="features", labelCol="label", \
forceIndexLabel=False)
"""
super(RFormula, self).__init__()
self._java_obj = self._new_java_obj("org.apache.spark.ml.feature.RFormula", self.uid)
self._setDefault(forceIndexLabel=False)
kwargs = self.__init__._input_kwargs
self.setParams(**kwargs)

@keyword_only
@since("1.5.0")
def setParams(self, formula=None, featuresCol="features", labelCol="label"):
def setParams(self, formula=None, featuresCol="features", labelCol="label",
forceIndexLabel=False):
"""
setParams(self, formula=None, featuresCol="features", labelCol="label")
setParams(self, formula=None, featuresCol="features", labelCol="label", \
forceIndexLabel=False)
Sets params for RFormula.
"""
kwargs = self.setParams._input_kwargs
Expand All @@ -2528,6 +2537,20 @@ def getFormula(self):
"""
return self.getOrDefault(self.formula)

@since("2.1.0")
def setForceIndexLabel(self, value):
"""
Sets the value of :py:attr:`forceIndexLabel`.
"""
return self._set(forceIndexLabel=value)

@since("2.1.0")
def getForceIndexLabel(self):
"""
Gets the value of :py:attr:`forceIndexLabel`.
"""
return self.getOrDefault(self.forceIndexLabel)

def _create_model(self, java_model):
return RFormulaModel(java_model)

Expand Down
16 changes: 16 additions & 0 deletions python/pyspark/ml/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,22 @@ def test_count_vectorizer_with_binary(self):
feature, expected = r
self.assertEqual(feature, expected)

def test_rformula_force_index_label(self):
df = self.spark.createDataFrame([
(1.0, 1.0, "a"),
(0.0, 2.0, "b"),
(1.0, 0.0, "a")], ["y", "x", "s"])
# Does not index label by default since it's numeric type.
rf = RFormula(formula="y ~ x + s")
model = rf.fit(df)
transformedDF = model.transform(df)
self.assertEqual(transformedDF.head().label, 1.0)
# Force to index label.
rf2 = RFormula(formula="y ~ x + s").setForceIndexLabel(True)
model2 = rf2.fit(df)
transformedDF2 = model2.transform(df)
self.assertEqual(transformedDF2.head().label, 0.0)


class HasInducedError(Params):

Expand Down