com.johnsnowlabs.nlp.annotators.resolution
SentenceEntityResolverModel 
            Companion class SentenceEntityResolverModel
          
      object SentenceEntityResolverModel extends ReadablePretrainedSentenceEntityResolver with Serializable
- Alphabetic
 - By Inheritance
 
- SentenceEntityResolverModel
 - Serializable
 - Serializable
 - ReadablePretrainedSentenceEntityResolver
 - EvalEntityResolver
 - HasPretrained
 - ParamsAndFeaturesReadable
 - DefaultParamsReadable
 - MLReadable
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - All
 
Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        accuracy(dataset: DataFrame, trueCol: String, resolverCol: String, numOfChars: Int = 0): Double
      
      
      
calculates the accuracy metric for the EntityResolverModel in the provided dataset; the dataset should contain a column with the true code and a column from the EntityResolverModel annotator
calculates the accuracy metric for the EntityResolverModel in the provided dataset; the dataset should contain a column with the true code and a column from the EntityResolverModel annotator
- dataset
 Transformed DataFrame
- trueCol
 Column with the ground truth code
- resolverCol
 Column with the EntityResolverModel annotation
- returns
 The rate of correct entities
- Definition Classes
 - EvalEntityResolver
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        addReader(reader: (SentenceEntityResolverModel, String, SparkSession) ⇒ Unit): Unit
      
      
      
- Definition Classes
 - ParamsAndFeaturesReadable
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... ) @native()
 
 - 
      
      
      
        
      
    
      
        
        val
      
      
        defaultLang: String
      
      
      
- Definition Classes
 - HasPretrained
 
 - 
      
      
      
        
      
    
      
        
        lazy val
      
      
        defaultLoc: String
      
      
      
- Definition Classes
 - ReadablePretrainedSentenceEntityResolver → HasPretrained
 
 - 
      
      
      
        
      
    
      
        
        val
      
      
        defaultModelName: Some[String]
      
      
      
- Definition Classes
 - ReadablePretrainedSentenceEntityResolver → HasPretrained
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( classOf[java.lang.Throwable] )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hitsAtK(dataset: DataFrame, trueCol: String, resolverCol: String, k: Int, numOfChars: Int = 0): Double
      
      
      
- dataset
 Transformed DataFrame
- trueCol
 Column with the ground truth code
- resolverCol
 Column with the EntityResolverModel annotation
- k
 Number of results to include in the set (k parameter for Hits@K)
- numOfChars
 Number of characters to compare from the codes starting from left; defaults to 0 which compares the full code
- returns
 The rate of correct entities appearing in the top k entries for each instance list
- Definition Classes
 - EvalEntityResolver
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        load(path: String): SentenceEntityResolverModel
      
      
      
- Definition Classes
 - MLReadable
 - Annotations
 - @Since( "1.6.0" )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @native()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        onRead(instance: SentenceEntityResolverModel, path: String, session: SparkSession): Unit
      
      
      
- Attributes
 - protected
 - Definition Classes
 - ParamsAndFeaturesReadable
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        pretrained(name: String, lang: String): SentenceEntityResolverModel
      
      
      
- Definition Classes
 - ReadablePretrainedSentenceEntityResolver → HasPretrained
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        pretrained(name: String): SentenceEntityResolverModel
      
      
      
- Definition Classes
 - ReadablePretrainedSentenceEntityResolver → HasPretrained
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        pretrained(): SentenceEntityResolverModel
      
      
      
- Definition Classes
 - ReadablePretrainedSentenceEntityResolver → HasPretrained
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        pretrained(name: String, lang: String, remoteLoc: String): SentenceEntityResolverModel
      
      
      
Java compliant-overrides
Java compliant-overrides
- Definition Classes
 - ReadablePretrainedSentenceEntityResolver → HasPretrained
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        read: MLReader[SentenceEntityResolverModel]
      
      
      
- Definition Classes
 - ParamsAndFeaturesReadable → DefaultParamsReadable → MLReadable
 
 - 
      
      
      
        
      
    
      
        
        val
      
      
        readers: ArrayBuffer[(SentenceEntityResolverModel, String, SparkSession) ⇒ Unit]
      
      
      
- Attributes
 - protected
 - Definition Classes
 - ParamsAndFeaturesReadable
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... ) @native()