diff options
| author | Yuhao Yang <hhbyyh@gmail.com> | 2016-06-30 19:34:51 -0700 |
|---|---|---|
| committer | Joseph K. Bradley <joseph@databricks.com> | 2016-06-30 19:34:51 -0700 |
| commit | aa6564f37f1d8de77c3b7bfa885000252efffea6 (patch) | |
| tree | 03c9477a2470830a8971f8767677a342471f035e /mllib | |
| parent | 38f4d6f44eaa03bdc703662e4a7be9c09ba86e16 (diff) | |
| download | spark-aa6564f37f1d8de77c3b7bfa885000252efffea6.tar.gz spark-aa6564f37f1d8de77c3b7bfa885000252efffea6.tar.bz2 spark-aa6564f37f1d8de77c3b7bfa885000252efffea6.zip | |
[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 <hhbyyh@gmail.com>
Author: Yuhao Yang <yuhao.yang@intel.com>
Closes #12384 from hhbyyh/transformSchemaDoc.
Diffstat (limited to 'mllib')
| -rw-r--r-- | mllib/src/main/scala/org/apache/spark/ml/Pipeline.scala | 5 |
1 files changed, 4 insertions, 1 deletions
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 25e56d70c2..a1d08b3a6e 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 |