MalletTopicModelEstimator (DKPro Core - Master Aggregator 1.7.0 API)

java.lang.Object
- org.apache.uima.analysis_component.AnalysisComponent_ImplBase
- - org.apache.uima.analysis_component.Annotator_ImplBase
  - - org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    - - org.apache.uima.fit.component.JCasAnnotator_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.mallet.topicmodel.MalletTopicModelEstimator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent
```
public class MalletTopicModelEstimator
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase
```
This component estimates an LDA model using Mallet. It stores all incoming CAS' to Mallet Instances before estimating the model, using a ParallelTopicModel.

Author:

Carsten Schnober

Field Summary

Fields
Modifier and Type	Field and Description
`protected cc.mallet.types.InstanceList`	`instanceList`
`protected static String`	`NONE_LABEL`
`static String`	`PARAM_BURNIN_PERIOD` The number of iterations before hyperparameter optimization begins.
`static String`	`PARAM_DISPLAY_INTERVAL` The interval in which to display the estimated topics.
`static String`	`PARAM_DISPLAY_N_TOPIC_WORDS` The number of top words to display during estimation.
`static String`	`PARAM_MIN_TOKEN_LENGTH` Ignore tokens (or lemmas, respectively) that are shorter than the given value.
`static String`	`PARAM_N_ITERATIONS` The number of iterations during model estimation.
`static String`	`PARAM_N_THREADS` The number of threads to use during model estimation.
`static String`	`PARAM_N_TOPICS` The number of topics to estimate for the topic model.
`static String`	`PARAM_OPTIMIZE_INTERVAL` Interval for optimizing Dirichlet hyperparameters.
`static String`	`PARAM_RANDOM_SEED` Set random seed.
`static String`	`PARAM_SAVE_INTERVAL` Define how often to save a serialized model during estimation.
`static String`	`PARAM_TARGET_LOCATION` The target model file location.
`static String`	`PARAM_TYPE_NAME` The annotation type to use for the topic model.
`static String`	`PARAM_USE_LEMMA` If set, uses lemmas instead of original text as features.
`static String`	`PARAM_USE_SYMMETRIC_ALPHA` Use a symmatric alpha value during model estimation? Default: false.

Constructor Summary

Constructors
Constructor and Description

MalletTopicModelEstimator()

Constructors
Constructor and Description
`MalletTopicModelEstimator()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`collectionProcessComplete()`
`protected cc.mallet.types.TokenSequence`	`generateTokenSequence(org.apache.uima.jcas.JCas aJCas)`
`void`	`initialize(org.apache.uima.UimaContext context)`
`void`	`process(org.apache.uima.jcas.JCas aJCas)`

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase
getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase
getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

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

- Field Detail
  - PARAM_TYPE_NAME
```
public static final String PARAM_TYPE_NAME
```
    The annotation type to use for the topic model. Default: de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Token.
    
    See Also:
    Constant Field Values
  - PARAM_TARGET_LOCATION
```
public static final String PARAM_TARGET_LOCATION
```
    The target model file location.
    
    See Also:
    Constant Field Values
  - PARAM_N_TOPICS
```
public static final String PARAM_N_TOPICS
```
    The number of topics to estimate for the topic model.
    
    See Also:
    Constant Field Values
  - PARAM_N_THREADS
```
public static final String PARAM_N_THREADS
```
    The number of threads to use during model estimation. Default: 1.
    
    See Also:
    Constant Field Values
  - PARAM_N_ITERATIONS
```
public static final String PARAM_N_ITERATIONS
```
    The number of iterations during model estimation. Default: 1000.
    
    See Also:
    Constant Field Values
  - PARAM_USE_LEMMA
```
public static final String PARAM_USE_LEMMA
```
    If set, uses lemmas instead of original text as features.
    
    See Also:
    Constant Field Values
  - PARAM_BURNIN_PERIOD
```
public static final String PARAM_BURNIN_PERIOD
```
    The number of iterations before hyperparameter optimization begins. Default: 100
    
    See Also:
    Constant Field Values
  - PARAM_OPTIMIZE_INTERVAL
```
public static final String PARAM_OPTIMIZE_INTERVAL
```
    Interval for optimizing Dirichlet hyperparameters. Default: 50
    
    See Also:
    Constant Field Values
  - PARAM_RANDOM_SEED
```
public static final String PARAM_RANDOM_SEED
```
    Set random seed. If set to -1 (default), uses random generator.
    
    See Also:
    Constant Field Values
  - PARAM_SAVE_INTERVAL
```
public static final String PARAM_SAVE_INTERVAL
```
    Define how often to save a serialized model during estimation. Default: 0 (only save when estimation is done).
    
    See Also:
    Constant Field Values
  - PARAM_USE_SYMMETRIC_ALPHA
```
public static final String PARAM_USE_SYMMETRIC_ALPHA
```
    Use a symmatric alpha value during model estimation? Default: false.
    
    See Also:
    Constant Field Values
  - PARAM_DISPLAY_INTERVAL
```
public static final String PARAM_DISPLAY_INTERVAL
```
    The interval in which to display the estimated topics. Default: 50.
    
    See Also:
    Constant Field Values
  - PARAM_DISPLAY_N_TOPIC_WORDS
```
public static final String PARAM_DISPLAY_N_TOPIC_WORDS
```
    The number of top words to display during estimation. Default: 7.
    
    See Also:
    Constant Field Values
  - PARAM_MIN_TOKEN_LENGTH
```
public static final String PARAM_MIN_TOKEN_LENGTH
```
    Ignore tokens (or lemmas, respectively) that are shorter than the given value. Default: 3.
    
    See Also:
    Constant Field Values
  - NONE_LABEL
```
protected static final String NONE_LABEL
```
    See Also:
    Constant Field Values
  - instanceList
```
protected cc.mallet.types.InstanceList instanceList
```
- Constructor Detail
  - MalletTopicModelEstimator
```
public MalletTopicModelEstimator()
```
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Specified by:
    
    initialize in interface org.apache.uima.analysis_component.AnalysisComponent
    
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - process
```
public void process(org.apache.uima.jcas.JCas aJCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    Specified by:
    
    process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException
  - generateTokenSequence
```
protected cc.mallet.types.TokenSequence generateTokenSequence(org.apache.uima.jcas.JCas aJCas)
                                                       throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException
  - collectionProcessComplete
```
public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    Specified by:
    
    collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent
    
    Overrides:
    
    collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
    
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException

Class MalletTopicModelEstimator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Methods inherited from class java.lang.Object

Field Detail

PARAM_TYPE_NAME

PARAM_TARGET_LOCATION

PARAM_N_TOPICS

PARAM_N_THREADS

PARAM_N_ITERATIONS

PARAM_USE_LEMMA

PARAM_BURNIN_PERIOD

PARAM_OPTIMIZE_INTERVAL

PARAM_RANDOM_SEED

PARAM_SAVE_INTERVAL

PARAM_USE_SYMMETRIC_ALPHA

PARAM_DISPLAY_INTERVAL

PARAM_DISPLAY_N_TOPIC_WORDS

PARAM_MIN_TOKEN_LENGTH

NONE_LABEL

instanceList

Constructor Detail

MalletTopicModelEstimator

Method Detail

initialize

process

generateTokenSequence

collectionProcessComplete