Skip to content

Commit b702e72

Browse files
committed
Update docstring for binary param
1 parent 5936626 commit b702e72

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

mllib/src/main/scala/org/apache/spark/ml/param/shared/sharedParams.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,10 +396,10 @@ private[ml] trait HasSolver extends Params {
396396
private[ml] trait HasBinary extends Params {
397397

398398
/**
399-
* Param for If true, all non zero results are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False..
399+
* Param for If true, all non-zero counts (after any filters are applied) are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False..
400400
* @group param
401401
*/
402-
final val binary: BooleanParam = new BooleanParam(this, "binary", "If true, all non zero results are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False.")
402+
final val binary: BooleanParam = new BooleanParam(this, "binary", "If true, all non-zero counts (after any filters are applied) are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False.")
403403

404404
setDefault(binary, false)
405405

python/pyspark/ml/param/shared.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -585,10 +585,10 @@ def getVarianceCol(self):
585585

586586
class HasBinary(Params):
587587
"""
588-
Mixin for param binary: If True, all non zero results are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False.
588+
Mixin for param binary: If True, all non-zero counts (after any filters are applied) are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False.
589589
"""
590590

591-
binary = Param(Params._dummy(), "binary", "If True, all non zero results are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False.", typeConverter=TypeConverters.toBoolean)
591+
binary = Param(Params._dummy(), "binary", "If True, all non-zero counts (after any filters are applied) are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default False.", typeConverter=TypeConverters.toBoolean)
592592

593593
def __init__(self):
594594
super(HasBinary, self).__init__()

0 commit comments

Comments
 (0)