Class

com.johnsnowlabs.nlp

GraphFinisher

Related Doc: package nlp

Permalink

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, 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. Serializable
  8. Identifiable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GraphFinisher()

    Permalink

  2. new GraphFinisher(uid: String)

    Permalink

    uid

    required uid for storing annotator to disk

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. val cleanAnnotations: BooleanParam

    Permalink

    Whether to remove annotation columns (Default: true)

  7. final def clear(param: Param[_]): GraphFinisher.this.type

    Permalink
    Definition Classes
    Params

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def copy(extra: ParamMap): Transformer

    Permalink
    Definition Classes
    GraphFinisher → Transformer → PipelineStage → Params

  10. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  11. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  15. def explainParams(): String

    Permalink
    Definition Classes
    Params

  16. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  17. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. def flattenMetadata: UserDefinedFunction

    Permalink

  20. def flattenPaths: UserDefinedFunction

    Permalink

  21. def flattenPathsAsArray: UserDefinedFunction

    Permalink

  22. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  25. def getInputCol: String

    Permalink

    Name of EmbeddingsFinisher output cols

  26. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  27. def getOutputCol: String

    Permalink

    Name of input annotation col

  28. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  29. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  30. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  32. val includeMetadata: BooleanParam

    Permalink

    Annotation metadata format (Default: false)

  33. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  34. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  35. val inputCol: Param[String]

    Permalink

    Name of input annotation cols

  36. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  37. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  38. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  39. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  40. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  41. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  42. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  43. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  44. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  45. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  46. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  47. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  53. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  54. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  55. val outputAsArray: BooleanParam

    Permalink

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

  56. val outputCol: Param[String]

    Permalink

    Name of finisher output cols

  57. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  58. final def set(paramPair: ParamPair[_]): GraphFinisher.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  59. final def set(param: String, value: Any): GraphFinisher.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  60. final def set[T](param: Param[T], value: T): GraphFinisher.this.type

    Permalink
    Definition Classes
    Params

  61. def setCleanAnnotations(value: Boolean): GraphFinisher.this.type

    Permalink

    Whether to remove annotation columns (Default: true)

  62. final def setDefault(paramPairs: ParamPair[_]*): GraphFinisher.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  63. final def setDefault[T](param: Param[T], value: T): GraphFinisher.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  64. def setIncludeMetadata(value: Boolean): GraphFinisher.this.type

    Permalink

    Annotation metadata format (Default: false)

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

    Permalink

    Name of input annotation col

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

    Permalink

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

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

    Permalink

    Name of finisher output col

  68. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  69. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  70. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    GraphFinisher → Transformer

  71. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )

  72. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  73. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    GraphFinisher → PipelineStage

  74. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  75. val uid: String

    Permalink

    required uid for storing annotator to disk

    required uid for storing annotator to disk

    Definition Classes
    GraphFinisher → Identifiable

  76. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  77. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  78. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

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