Github user jkbradley commented on a diff in the pull request:

    https://github.com/apache/spark/pull/3099#discussion_r20116505
  
    --- Diff: mllib/src/main/scala/org/apache/spark/ml/param/sharedParams.scala 
---
    @@ -0,0 +1,74 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one or more
    + * contributor license agreements.  See the NOTICE file distributed with
    + * this work for additional information regarding copyright ownership.
    + * The ASF licenses this file to You under the Apache License, Version 2.0
    + * (the "License"); you may not use this file except in compliance with
    + * the License.  You may obtain a copy of the License at
    + *
    + *    http://www.apache.org/licenses/LICENSE-2.0
    + *
    + * Unless required by applicable law or agreed to in writing, software
    + * distributed under the License is distributed on an "AS IS" BASIS,
    + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    + * See the License for the specific language governing permissions and
    + * limitations under the License.
    + */
    +
    +package org.apache.spark.ml.param
    +
    +private[ml] trait HasRegParam extends Params {
    +  /** param for regularization parameter */
    +  val regParam: DoubleParam = new DoubleParam(this, "regParam", 
"regularization parameter")
    +  def getRegParam: Double = get(regParam)
    +}
    +
    +private[ml] trait HasMaxIter extends Params {
    +  /** param for max number of iterations */
    +  val maxIter: IntParam = new IntParam(this, "maxIter", "max number of 
iterations")
    +  def getMaxIter: Int = get(maxIter)
    +}
    +
    +private[ml] trait HasFeaturesCol extends Params {
    +  /** param for features column name */
    +  val featuresCol: Param[String] =
    +    new Param(this, "featuresCol", "features column name", 
Some("features"))
    +  def getFeaturesCol: String = get(featuresCol)
    +}
    +
    +private[ml] trait HasLabelCol extends Params {
    +  /** param for label column name */
    +  val labelCol: Param[String] = new Param(this, "labelCol", "label column 
name", Some("label"))
    +  def getLabelCol: String = get(labelCol)
    +}
    +
    +private[ml] trait HasScoreCol extends Params {
    +  /** param for score column name */
    +  val scoreCol: Param[String] = new Param(this, "scoreCol", "score column 
name", Some("score"))
    +  def getScoreCol: String = get(scoreCol)
    +}
    +
    +private[ml] trait HasPredictionCol extends Params {
    +  /** param for prediction column name */
    +  val predictionCol: Param[String] =
    +    new Param(this, "predictionCol", "prediction column name", 
Some("prediction"))
    +  def getPredictionCol: String = get(predictionCol)
    +}
    +
    +private[ml] trait HasThreshold extends Params {
    +  /** param for threshold in (binary) prediction */
    +  val threshold: DoubleParam = new DoubleParam(this, "threshold", 
"threshold in prediction")
    +  def getThreshold: Double = get(threshold)
    +}
    +
    +private[ml] trait HasInputCol extends Params {
    --- End diff --
    
    I like encouraging people to use the same parameter names such as 
"inputCol," but I don't like the tendency not to override the documentation.  
E.g., this should always be documented with the data type expected in the input 
column.  Can val inputCol be a def and remain abstract, or is there a better 
way to encourage documentation?
    
    For now, can val inputCol be overridden everywhere to include better 
documentation?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to