c

org.graphframes.lib

LabelPropagation

class LabelPropagation extends Arguments with WithAlgorithmChoice with WithCheckpointInterval with WithMaxIter with WithLocalCheckpoints

Run static Label Propagation for detecting communities in networks.

Each node in the network is initially assigned to its own community. At every iteration, nodes send their community affiliation to all neighbors and update their state to the mode community affiliation of incoming messages.

LPA is a standard community detection algorithm for graphs. It is very inexpensive computationally, although (1) convergence is not guaranteed and (2) one can end up with trivial solutions (all nodes are identified into a single community).

The resulting DataFrame contains all the original vertex information and one additional column:

  • label (LongType): label of community affiliation
Linear Supertypes
WithLocalCheckpoints, WithMaxIter, WithCheckpointInterval, Logging, WithAlgorithmChoice, Arguments, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LabelPropagation
  2. WithLocalCheckpoints
  3. WithMaxIter
  4. WithCheckpointInterval
  5. Logging
  6. WithAlgorithmChoice
  7. Arguments
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from LabelPropagation toany2stringadd[LabelPropagation] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LabelPropagation, B)
    Implicit
    This member is added by an implicit conversion from LabelPropagation toArrowAssoc[LabelPropagation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val ALGO_GRAPHFRAMES: String
    Attributes
    protected
    Definition Classes
    WithAlgorithmChoice
  7. val ALGO_GRAPHX: String
    Attributes
    protected
    Definition Classes
    WithAlgorithmChoice
  8. val algorithm: String
    Attributes
    protected
    Definition Classes
    WithAlgorithmChoice
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val checkpointInterval: Int
    Attributes
    protected
    Definition Classes
    WithCheckpointInterval
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  12. def ensuring(cond: (LabelPropagation) => Boolean, msg: => Any): LabelPropagation
    Implicit
    This member is added by an implicit conversion from LabelPropagation toEnsuring[LabelPropagation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (LabelPropagation) => Boolean): LabelPropagation
    Implicit
    This member is added by an implicit conversion from LabelPropagation toEnsuring[LabelPropagation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): LabelPropagation
    Implicit
    This member is added by an implicit conversion from LabelPropagation toEnsuring[LabelPropagation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): LabelPropagation
    Implicit
    This member is added by an implicit conversion from LabelPropagation toEnsuring[LabelPropagation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def getAlgorithm: String
    Definition Classes
    WithAlgorithmChoice
  19. def getCheckpointInterval: Int

    Gets checkpoint interval.

    Gets checkpoint interval.

    Definition Classes
    WithCheckpointInterval
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. def getUseLocalCheckpoints: Boolean

    Gets whether local checkpoints are being used instead of regular checkpoints.

    Gets whether local checkpoints are being used instead of regular checkpoints.

    returns

    true if local checkpoints are enabled, false otherwise

    Definition Classes
    WithLocalCheckpoints
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def logDebug(s: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(s: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logTrace(s: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logWarn(s: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def maxIter(value: Int): LabelPropagation.this.type

    The max number of iterations of algorithm to be performed.

    The max number of iterations of algorithm to be performed.

    Definition Classes
    WithMaxIter
  29. val maxIter: Option[Int]
    Attributes
    protected
    Definition Classes
    WithMaxIter
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  33. def run(): DataFrame
  34. def setAlgorithm(value: String): LabelPropagation.this.type

    Set an algorithm to use.

    Set an algorithm to use. Supported algorithms are "graphx" and "graphframes".

    Definition Classes
    WithAlgorithmChoice
  35. def setCheckpointInterval(value: Int): LabelPropagation.this.type

    Sets checkpoint interval in terms of number of iterations (default: 2).

    Sets checkpoint interval in terms of number of iterations (default: 2). Checkpointing regularly helps recover from failures, clean shuffle files, shorten the lineage of the computation graph, and reduce the complexity of plan optimization. As of Spark 2.0, the complexity of plan optimization would grow exponentially without checkpointing. Hence, disabling or setting longer-than-default checkpoint intervals are not recommended. Checkpoint data is saved under org.apache.spark.SparkContext.getCheckpointDir with prefix of the algorithm name. If the checkpoint directory is not set, this throws a java.io.IOException. Set a nonpositive value to disable checkpointing. This parameter is only used when the algorithm is set to "graphframes". Its default value might change in the future.

    Definition Classes
    WithCheckpointInterval
    See also

    org.apache.spark.SparkContext.setCheckpointDir in Spark API doc

  36. def setUseLocalCheckpoints(value: Boolean): LabelPropagation.this.type

    Sets whether to use local checkpoints instead of regular checkpoints (default: false).

    Sets whether to use local checkpoints instead of regular checkpoints (default: false). Local checkpoints are faster but less reliable as they don't survive node failures.

    value

    true to use local checkpoints, false for regular checkpoints

    returns

    this instance

    Definition Classes
    WithLocalCheckpoints
  37. val supportedAlgorithms: Array[String]
    Definition Classes
    WithAlgorithmChoice
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. val useLocalCheckpoints: Boolean
    Attributes
    protected
    Definition Classes
    WithLocalCheckpoints
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from LabelPropagation toStringFormat[LabelPropagation] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (LabelPropagation, B)
    Implicit
    This member is added by an implicit conversion from LabelPropagation toArrowAssoc[LabelPropagation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from WithLocalCheckpoints

Inherited from WithMaxIter

Inherited from WithCheckpointInterval

Inherited from Logging

Inherited from WithAlgorithmChoice

Inherited from Arguments

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromLabelPropagation to any2stringadd[LabelPropagation]

Inherited by implicit conversion StringFormat fromLabelPropagation to StringFormat[LabelPropagation]

Inherited by implicit conversion Ensuring fromLabelPropagation to Ensuring[LabelPropagation]

Inherited by implicit conversion ArrowAssoc fromLabelPropagation to ArrowAssoc[LabelPropagation]

Ungrouped