Skip to content

[SPARK-12711][ML] ML StopWordsRemover does not protect itself from column name duplication #10741

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
grzegorz-chilkiewicz wants to merge 5 commits into from
Closed

[SPARK-12711][ML] ML StopWordsRemover does not protect itself from column name duplication #10741

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c3d60f
[SPARK-12711] ML StopWordsRemover does not protect itself from column…
grzegorz-chilkiewicz Jan 13, 2016
1474b6f
[SPARK-12711] ML StopWordsRemover does not protect itself from column…
grzegorz-chilkiewicz Jan 13, 2016
ca9a852
Merge branch 'master' of https://github.com/grzegorz-chilkiewicz/spar…
grzegorz-chilkiewicz Jan 13, 2016
37af391
[SPARK-12711][ML] ML StopWordsRemover does not protect itself from co…
grzegorz-chilkiewicz Jan 14, 2016
49fd362
Fix empty DataFrame column error
grzegorz-chilkiewicz Jan 27, 2016
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
4 changes: 1 addition & 3 deletions mllib/src/main/scala/org/apache/spark/ml/feature/StopWordsRemover.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,7 @@ class StopWordsRemover(override val uid: String)
val inputType = schema($(inputCol)).dataType
require(inputType.sameType(ArrayType(StringType)),
s"Input type must be ArrayType(StringType) but got $inputType.")
val outputFields = schema.fields :+
StructField($(outputCol), inputType, schema($(inputCol)).nullable)
StructType(outputFields)
SchemaUtils.appendColumn(schema, $(outputCol), inputType, schema($(inputCol)).nullable)
}

override def copy(extra: ParamMap): StopWordsRemover = defaultCopy(extra)
Expand Down
8 changes: 3 additions & 5 deletions mllib/src/main/scala/org/apache/spark/ml/util/SchemaUtils.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,10 @@ private[spark] object SchemaUtils {
def appendColumn(
schema: StructType,
colName: String,
dataType: DataType): StructType = {
dataType: DataType,
nullable: Boolean = false): StructType = {
if (colName.isEmpty) return schema
val fieldNames = schema.fieldNames
require(!fieldNames.contains(colName), s"Column $colName already exists.")
val outputFields = schema.fields :+ StructField(colName, dataType, nullable = false)
StructType(outputFields)
appendColumn(schema, StructField(colName, dataType, nullable))
}

/**
Expand Down
18 changes: 18 additions & 0 deletions mllib/src/test/scala/org/apache/spark/ml/feature/StopWordsRemoverSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,22 @@ class StopWordsRemoverSuite
.setCaseSensitive(true)
testDefaultReadWrite(t)
}

test("StopWordsRemover output column already exists") {
val outpuCol = "expected"
Copy link
Member

@jkbradley jkbradley Jan 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: "outputCol"

val remover = new StopWordsRemover()
.setInputCol("raw")
.setOutputCol(outpuCol)
.setCaseSensitive(true)
Copy link
Member

@jkbradley jkbradley Jan 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not needed for this test

val dataSet = sqlContext.createDataFrame(Seq(
Copy link
Member

@jkbradley jkbradley Jan 26, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just copy one of the datasets from an above test. That should fix the error.

Copy link
Contributor Author

@grzegorz-chilkiewicz grzegorz-chilkiewicz Jan 27, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed out that second column in dataSet was totally empty... - and that was the problem...
I do not want to make that example too complicated, because this test does not even check correctness of execution result
I'm sorry for problems

(Seq("A"), Seq("A")),
(Seq("The", "the"), Seq("The"))
)).toDF("raw", outpuCol)

val thrown = intercept[IllegalArgumentException] {
testStopWordsRemover(remover, dataSet)
}
assert(thrown.getClass === classOf[IllegalArgumentException])
Copy link
Member

@jkbradley jkbradley Jan 13, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already checked in line 104.

Copy link
Contributor Author

@grzegorz-chilkiewicz grzegorz-chilkiewicz Jan 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to take pattern from:
github.com/apache/spark/blob/master/core/src/test/scala/org/apache/spark/FailureSuite.scala#L100-L106

I think this check theoretically could be useful:
https://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html
is non-abstract class and have subclasses,
intercept can catch e.g. PatternSyntaxException, which is not what we should treat as a test success.

But of course, PatternSyntaxException is very unlikely to have message "requirement failed: Column ${outpuCol} already exists."

Am I correct?
Maybe "assert(thrown.getClass === classOf[IllegalArgumentException])" line should stay?

Copy link
Member

@jkbradley jkbradley Jan 26, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see; I bet you're correct. Don't worry about it for now, though.

assert(thrown.getMessage == s"requirement failed: Column ${outpuCol} already exists.")
}
}