Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ private[ml] trait MultilayerPerceptronParams extends PredictorParams
with HasSeed with HasMaxIter with HasTol {
/**
* Layer sizes including input size and output size.
* Default: Array(1, 1)
* @group param
*/
final val layers: IntArrayParam = new IntArrayParam(this, "layers",
Expand All @@ -50,6 +51,7 @@ private[ml] trait MultilayerPerceptronParams extends PredictorParams
* Data is stacked within partitions. If block size is more than remaining data in
* a partition then it is adjusted to the size of this data.
* Recommended size is between 10 and 1000.
* Default: 128
* @group expertParam
*/
final val blockSize: IntParam = new IntParam(this, "blockSize",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class BinaryClassificationEvaluator(override val uid: String)

/**
* param for metric name in evaluation
* Default: areaUnderROC
* @group param
*/
val metricName: Param[String] = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ final class Binarizer(override val uid: String)
* Param for threshold used to binarize continuous features.
* The features greater than the threshold, will be binarized to 1.0.
* The features equal to or less than the threshold, will be binarized to 0.0.
* Default: 0.0
* @group param
*/
val threshold: DoubleParam =
Expand Down
1 change: 1 addition & 0 deletions mllib/src/main/scala/org/apache/spark/ml/feature/IDF.scala
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ private[feature] trait IDFBase extends Params with HasInputCol with HasOutputCol

/**
* The minimum of documents in which a term should appear.
* Default: 0
* @group param
*/
final val minDocFreq = new IntParam(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ class StopWordsRemover(override val uid: String)

/**
* the stop words set to be filtered out
* Default: [[StopWords.English]]
* @group param
*/
val stopWords: StringArrayParam = new StringArrayParam(this, "stopWords", "stop words")
Expand All @@ -110,6 +111,7 @@ class StopWordsRemover(override val uid: String)

/**
* whether to do a case sensitive comparison over the stop words
* Default: false
* @group param
*/
val caseSensitive: BooleanParam = new BooleanParam(this, "caseSensitive",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ class IndexToString private[ml] (

/**
* Param for array of labels.
* Optional labels to be provided by the user, if not supplied column
* metadata is read for labels.
* Optional labels to be provided by the user.
* Default: Empty array, in which case column metadata is used for labels.
* @group param
*/
final val labels: StringArrayParam = new StringArrayParam(this, "labels",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ private[ml] trait VectorIndexerParams extends Params with HasInputCol with HasOu
* Must be >= 2.
*
* (default = 20)
* @group param
*/
val maxCategories = new IntParam(this, "maxCategories",
"Threshold for the number of values a categorical feature can take (>= 2)." +
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ final class VectorSlicer(override val uid: String)
/**
* An array of indices to select features from a vector column.
* There can be no overlap with [[names]].
* Default: Empty array
* @group param
*/
val indices = new IntArrayParam(this, "indices",
Expand All @@ -67,6 +68,7 @@ final class VectorSlicer(override val uid: String)
* An array of feature names to select features from a vector column.
* These names must be specified by ML [[org.apache.spark.ml.attribute.Attribute]]s.
* There can be no overlap with [[indices]].
* Default: Empty Array
* @group param
*/
val names = new StringArrayParam(this, "names",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ private[feature] trait Word2VecBase extends Params

/**
* The dimension of the code that you want to transform from words.
* Default: 100
* @group param
*/
final val vectorSize = new IntParam(
Expand All @@ -50,6 +51,7 @@ private[feature] trait Word2VecBase extends Params

/**
* Number of partitions for sentences of words.
* Default: 1
* @group param
*/
final val numPartitions = new IntParam(
Expand All @@ -62,6 +64,7 @@ private[feature] trait Word2VecBase extends Params
/**
* The minimum number of times a token must appear to be included in the word2vec model's
* vocabulary.
* Default: 5
* @group param
*/
final val minCount = new IntParam(this, "minCount", "the minimum number of times a token must " +
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ private[regression] trait IsotonicRegressionBase extends Params with HasFeatures
/**
* Param for whether the output sequence should be isotonic/increasing (true) or
* antitonic/decreasing (false).
* Default: true
* @group param
*/
final val isotonic: BooleanParam =
Expand Down