Packages

t

com.johnsnowlabs.nlp.annotators.params

SourceTrackingMetadataParams

trait SourceTrackingMetadataParams extends ResetSentenceIndicesParam

Self Type
SourceTrackingMetadataParams with HasOutputAnnotationCol
Linear Supertypes
ResetSentenceIndicesParam, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
ChunkConverter, NerConverterInternal, NerConverterInternalModel
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. SourceTrackingMetadataParams
  2. ResetSentenceIndicesParam
  3. Params
  4. Serializable
  5. Serializable
  6. Identifiable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete 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. val allPossibleFieldsToStandardize: StringArrayParam

    array with all possible fields containing the value to write in the standard field ordered by priority

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def clear(param: Param[_]): SourceTrackingMetadataParams.this
    Definition Classes
    Params
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  10. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  14. def explainParams(): String
    Definition Classes
    Params
  15. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  16. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  19. def getAllPossibleFieldsToStandardize: Array[String]
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  22. def getIncludeOutputColumn: Boolean
  23. def getIncludeStandardField: Boolean
  24. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  25. def getOutputColumnKey: String
  26. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  27. def getResetSentenceIndices: Boolean

    Gets resetSentenceIndices parameter

    Gets resetSentenceIndices parameter

    Definition Classes
    ResetSentenceIndicesParam
  28. def getStandardFieldKey: String
  29. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  30. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. val includeOutputColumn: BooleanParam

    whether or not to include a metadata key/value to specify the output column name for the annotation

  33. val includeStandardField: BooleanParam

    whether to standardize the metadata key for entity, useful for chunk columns

  34. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. val outputColumnKey: Param[String]

    key name for the source column value

  41. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  42. def resetSentenceIndices(metadata: Map[String, String]): Map[String, String]

    Reset sentence index in metadata by adding "sentence" -> "0"

    Reset sentence index in metadata by adding "sentence" -> "0"

    Attributes
    protected
    Definition Classes
    ResetSentenceIndicesParam
  43. val resetSentenceIndices: BooleanParam

    Whether to reset sentence indices to treat the entire output as if it originates from a single document.

    Whether to reset sentence indices to treat the entire output as if it originates from a single document.

    When set to true, the metadata of each entity will be updated by assigning the sentence key a value of 0, effectively treating the entire output as if it comes from a single document, regardless of the original sentence boundaries. Default: False.

    Definition Classes
    ResetSentenceIndicesParam
  44. final def set(paramPair: ParamPair[_]): SourceTrackingMetadataParams.this
    Attributes
    protected
    Definition Classes
    Params
  45. final def set(param: String, value: Any): SourceTrackingMetadataParams.this
    Attributes
    protected
    Definition Classes
    Params
  46. final def set[T](param: Param[T], value: T): SourceTrackingMetadataParams.this
    Definition Classes
    Params
  47. def setAllPossibleFieldsToStandardize(v: Array[String]): SourceTrackingMetadataParams.this
  48. final def setDefault(paramPairs: ParamPair[_]*): SourceTrackingMetadataParams.this
    Attributes
    protected
    Definition Classes
    Params
  49. final def setDefault[T](param: Param[T], value: T): SourceTrackingMetadataParams.this
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  50. def setIncludeOutputColumn(v: Boolean): SourceTrackingMetadataParams.this
  51. def setIncludeStandardField(v: Boolean): SourceTrackingMetadataParams.this
  52. def setOutputColumnKey(v: String): SourceTrackingMetadataParams.this
  53. def setResetSentenceIndices(value: Boolean): SourceTrackingMetadataParams.this

    Set whether to reset sentence indices to treat the entire output as if it originates from a single document.

    Set whether to reset sentence indices to treat the entire output as if it originates from a single document.

    When set to true, the metadata of each entity will be updated by assigning the sentence key a value of 0, effectively treating the entire output as if it comes from a single document, regardless of the original sentence boundaries. Default: False.

    Definition Classes
    ResetSentenceIndicesParam
  54. def setStandardFieldKey(v: String): SourceTrackingMetadataParams.this
  55. val standardFieldKey: Param[String]

    key name for the standard homogenized field

  56. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  57. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  58. def updateMetadataWithSource(metadata: Map[String, String]): Map[String, String]
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ResetSentenceIndicesParam

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped