Packages

c

com.johnsnowlabs.nlp

GraphFinisher

class GraphFinisher extends Transformer

Helper class to convert the knowledge graph from GraphExtraction into a generic format, such as RDF.

Example

This is a continuation of the example of GraphExtraction. To see how the graph is extracted, see the documentation of that class.

import com.johnsnowlabs.nlp.GraphFinisher

val graphFinisher = new GraphFinisher()
  .setInputCol("graph")
  .setOutputCol("graph_finished")
  .setOutputAsArray(false)

val finishedResult = graphFinisher.transform(result)
finishedResult.select("text", "graph_finished").show(false)
+-----------------------------------------------------+-----------------------------------------------------------------------+
|text                                                 |graph_finished                                                         |
+-----------------------------------------------------+-----------------------------------------------------------------------+
|You and John prefer the morning flight through Denver|[[(prefer,nsubj,morning), (morning,flat,flight), (flight,flat,Denver)]]|
+-----------------------------------------------------+-----------------------------------------------------------------------+
See also

GraphExtraction to extract the graph.

Linear Supertypes
Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. GraphFinisher
  2. Transformer
  3. PipelineStage
  4. Logging
  5. Params
  6. Serializable
  7. Identifiable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GraphFinisher()
  2. new GraphFinisher(uid: String)

    uid

    required uid for storing annotator to disk

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def annotate(metadata: Map[String, String]): Seq[Annotation]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val cleanAnnotations: BooleanParam

    Whether to remove annotation columns (Default: true)

  8. final def clear(param: Param[_]): GraphFinisher.this.type
    Definition Classes
    Params
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def copy(extra: ParamMap): Transformer
    Definition Classes
    GraphFinisher → Transformer → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  12. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  16. def explainParams(): String
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  19. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  22. def getInputCol: String

    Name of EmbeddingsFinisher output cols

  23. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  24. def getOutputCol: String

    Name of input annotation col

  25. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  26. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  27. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  29. val includeMetadata: BooleanParam

    Annotation metadata format (Default: false)

  30. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  31. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. val inputCol: Param[String]

    Name of input annotation cols

  33. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  36. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  37. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  38. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  45. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  52. val outputAsArray: BooleanParam

    Finisher generates an Array with the results instead of string (Default: true)

  53. val outputCol: Param[String]

    Name of finisher output cols

  54. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  55. final def set(paramPair: ParamPair[_]): GraphFinisher.this.type
    Attributes
    protected
    Definition Classes
    Params
  56. final def set(param: String, value: Any): GraphFinisher.this.type
    Attributes
    protected
    Definition Classes
    Params
  57. final def set[T](param: Param[T], value: T): GraphFinisher.this.type
    Definition Classes
    Params
  58. def setCleanAnnotations(value: Boolean): GraphFinisher.this.type

    Whether to remove annotation columns (Default: true)

  59. final def setDefault(paramPairs: ParamPair[_]*): GraphFinisher.this.type
    Attributes
    protected
    Definition Classes
    Params
  60. final def setDefault[T](param: Param[T], value: T): GraphFinisher.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  61. def setIncludeMetadata(value: Boolean): GraphFinisher.this.type

    Annotation metadata format (Default: false)

  62. def setInputCol(value: String): GraphFinisher.this.type

    Name of input annotation col

  63. def setOutputAsArray(value: Boolean): GraphFinisher.this.type

    Finisher generates an Array with the results instead of string (Default: true)

  64. def setOutputCol(value: String): GraphFinisher.this.type

    Name of finisher output col

  65. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  66. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  67. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    GraphFinisher → Transformer
  68. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since("2.0.0")
  69. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @varargs() @Since("2.0.0")
  70. def transformSchema(schema: StructType): StructType
    Definition Classes
    GraphFinisher → PipelineStage
  71. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  72. val uid: String
    Definition Classes
    GraphFinisher → Identifiable
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  75. 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)

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters