TFIDFKeywordExtractor (com.gengoai:hermes 1.1-SNAPSHOT API)

java.lang.Object
- com.gengoai.hermes.extraction.keyword.TFIDFKeywordExtractor

All Implemented Interfaces:

Extractor, KeywordExtractor, Serializable
```
public class TFIDFKeywordExtractor
extends Object
implements KeywordExtractor
```
Keyword extractor that scores words based on their TFIDF value.

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`TFIDFKeywordExtractor()`	Instantiates a new TFIDFKeywordExtractor.
`TFIDFKeywordExtractor(@NonNull FeaturizingExtractor termExtractor)`	Instantiates a new TFIDFKeywordExtractor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Extraction`	`extract(HString source)`	Generate an `Extraction` from the given `HString`.
`void`	`fit(DocumentCollection corpus)`	In certain cases a keyword extractor needs to collect corpus level statistics or construct a model of what a good keyword looks like.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TFIDFKeywordExtractor
```
public TFIDFKeywordExtractor()
```
    Instantiates a new TFIDFKeywordExtractor.
  - TFIDFKeywordExtractor
```
public TFIDFKeywordExtractor(@NonNull
                             @NonNull FeaturizingExtractor termExtractor)
```
    Instantiates a new TFIDFKeywordExtractor.
    
    Parameters:
    
    termExtractor - the specification for filtering and converting annotations to strings
- Method Detail
  - extract
```
public Extraction extract(HString source)
```
    Description copied from interface: Extractor
    
    Generate an Extraction from the given HString.
    
    Specified by:
    
    extract in interface Extractor
    
    Parameters:
    
    source - the source text from which we will generate an Extraction
    
    Returns:
    
    the Extraction
  - fit
```
public void fit(DocumentCollection corpus)
```
    Description copied from interface: KeywordExtractor
    
    In certain cases a keyword extractor needs to collect corpus level statistics or construct a model of what a good keyword looks like. The fit method allows implementations to perform this logic at a corpus level.
    
    Specified by:
    
    fit in interface KeywordExtractor
    
    Parameters:
    
    corpus - the corpus to fit the extractor to