Repository: spark
Updated Branches:
  refs/heads/branch-2.0 80a7bff89 -> cc3c44b11


[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 <hhb...@gmail.com>
Author: Yuhao Yang <yuhao.y...@intel.com>

Closes #12384 from hhbyyh/transformSchemaDoc.

(cherry picked from commit aa6564f37f1d8de77c3b7bfa885000252efffea6)
Signed-off-by: Joseph K. Bradley <jos...@databricks.com>


Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/cc3c44b1
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/cc3c44b1
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/cc3c44b1

Branch: refs/heads/branch-2.0
Commit: cc3c44b1196c4186c0b55e319460524e9b9f865b
Parents: 80a7bff
Author: Yuhao Yang <hhb...@gmail.com>
Authored: Thu Jun 30 19:34:51 2016 -0700
Committer: Joseph K. Bradley <jos...@databricks.com>
Committed: Thu Jun 30 19:35:06 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/cc3c44b1/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: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org

Reply via email to