Repository: spark Updated Branches: refs/heads/master 38f4d6f44 -> aa6564f37
[SPARK-14608][ML] transformSchema needs better documentation ## What changes were proposed in this pull request? jira: https://issues.apache.org/jira/browse/SPARK-14608 PipelineStage.transformSchema currently has minimal documentation. It should have more to explain it can: check schema check parameter interactions ## How was this patch tested? unit test Author: Yuhao Yang <[email protected]> Author: Yuhao Yang <[email protected]> Closes #12384 from hhbyyh/transformSchemaDoc. Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/aa6564f3 Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/aa6564f3 Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/aa6564f3 Branch: refs/heads/master Commit: aa6564f37f1d8de77c3b7bfa885000252efffea6 Parents: 38f4d6f Author: Yuhao Yang <[email protected]> Authored: Thu Jun 30 19:34:51 2016 -0700 Committer: Joseph K. Bradley <[email protected]> Committed: Thu Jun 30 19:34:51 2016 -0700 ---------------------------------------------------------------------- mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/aa6564f3/mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala ---------------------------------------------------------------------- diff --git a/mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala b/mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala index 25e56d7..a1d08b3 100644 --- a/mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala +++ b/mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala @@ -44,7 +44,10 @@ abstract class PipelineStage extends Params with Logging { /** * :: DeveloperApi :: * - * Derives the output schema from the input schema. + * Check transform validity and derive the output schema from the input schema. + * + * Typical implementation should first conduct verification on schema change and parameter + * validity, including complex parameter interaction checks. */ @DeveloperApi def transformSchema(schema: StructType): StructType --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
