ComponentParameters (DKPro Core 1.9.0 API)

java.lang.Object
- de.tudarmstadt.ukp.dkpro.core.api.parameter.ComponentParameters

public final class ComponentParameters
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO_NUM_THREADS` Use smart number of threads if PARAM_NUM_THREADS is set to this value
`static String`	`DEFAULT_ENCODING`
`static String`	`PARAM_ACCEPTED_TAGS_REGEX` Regex to filter tags, e. g.
`static String`	`PARAM_CHUNK_MAPPING_LOCATION` Location of the mapping file for chunk tags to UIMA types.
`static String`	`PARAM_CHUNK_TAG_SET` Use this chunk tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data.
`static String`	`PARAM_CONSTITUENT_MAPPING_LOCATION` Location of the mapping file for constituent tags to UIMA types.
`static String`	`PARAM_CONSTITUENT_TAG_SET`
`static String`	`PARAM_DELETE_COVER` When splitting an annotation into multiple parts, e.g.
`static String`	`PARAM_DEPENDENCY_MAPPING_LOCATION` Location of the mapping file for dependency tags to UIMA types.
`static String`	`PARAM_FILENAME_EXTENSION` Use this filename extension.
`static String`	`PARAM_INTERN_TAGS` Use the `String.intern()` method on tags.
`static String`	`PARAM_LANGUAGE` For analysis engines: Use this language instead of the document language to resolve the model and tag set mapping.
`static String`	`PARAM_MAX_SENTENCE_LENGTH` Maximal sentence length in tokens that is still being processed.
`static String`	`PARAM_MODEL_ENCODING` The character encoding used by the model.
`static String`	`PARAM_MODEL_LOCATION` Location from which the model is read.
`static String`	`PARAM_MORPH_MAPPING_LOCATION` Location of the mapping file for morphological analysis strings to features.
`static String`	`PARAM_MORPH_TAG_SET`
`static String`	`PARAM_NAMED_ENTITY_MAPPING_LOCATION` Location of the mapping file for named entity tags to UIMA types.
`static String`	`PARAM_NUM_THREADS` The number of threads to use for components that implement multi-threading
`static String`	`PARAM_PATTERNS` Variant of the model.
`static String`	`PARAM_POS_MAPPING_LOCATION` Location of the mapping file for part-of-speech tags to UIMA types.
`static String`	`PARAM_POS_TAG_SET` Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data.
`static String`	`PARAM_PRINT_TAGSET` Log the tag set(s) when a model is loaded.
`static String`	`PARAM_READ_CHUNK`
`static String`	`PARAM_READ_CONSTITUENT`
`static String`	`PARAM_READ_COREFERENCE`
`static String`	`PARAM_READ_CPOS`
`static String`	`PARAM_READ_DEPENDENCY`
`static String`	`PARAM_READ_FORM`
`static String`	`PARAM_READ_LEMMA`
`static String`	`PARAM_READ_MORPH`
`static String`	`PARAM_READ_NAMED_ENTITY`
`static String`	`PARAM_READ_PARAGRAPH`
`static String`	`PARAM_READ_PENN_TREE`
`static String`	`PARAM_READ_POS`
`static String`	`PARAM_READ_SENTENCE`
`static String`	`PARAM_READ_TOKEN`
`static String`	`PARAM_SEGMENTATION_MODEL_LOCATION` Location from which the segmentation model is read.
`static String`	`PARAM_SOURCE_ENCODING` Character encoding of the input data.
`static String`	`PARAM_SOURCE_LOCATION` Location from which the input is read.
`static String`	`PARAM_STRIP_EXTENSION` Remove the original extension.
`static String`	`PARAM_TARGET_ENCODING` Character encoding of the output data.
`static String`	`PARAM_TARGET_LOCATION` Location to which the output is written.
`static String`	`PARAM_TOKENIZATION_MODEL_LOCATION` Location from which the tokenization model is read.
`static String`	`PARAM_VARIANT` Variant of a model the model.
`static String`	`PARAM_WRITE_CHUNK`
`static String`	`PARAM_WRITE_CONSTITUENT`
`static String`	`PARAM_WRITE_COREFERENCE`
`static String`	`PARAM_WRITE_CPOS`
`static String`	`PARAM_WRITE_DEPENDENCY`
`static String`	`PARAM_WRITE_FORM`
`static String`	`PARAM_WRITE_LEMMA`
`static String`	`PARAM_WRITE_MORPH`
`static String`	`PARAM_WRITE_NAMED_ENTITY`
`static String`	`PARAM_WRITE_PARAGRAPH`
`static String`	`PARAM_WRITE_PENN_TREE`
`static String`	`PARAM_WRITE_POS`
`static String`	`PARAM_WRITE_SENTENCE`
`static String`	`PARAM_WRITE_TOKEN`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`computeNumThreads(int value)` Compute the number of threads to use for components that can make use of multi-threading.

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

- Field Detail
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    See Also:
    
    Constant Field Values
  - PARAM_LANGUAGE
```
public static final String PARAM_LANGUAGE
```
    For analysis engines: Use this language instead of the document language to resolve the model and tag set mapping. For readers: Set this as the language of the produced documents.
    
    See Also:
    
    Constant Field Values
  - PARAM_PATTERNS
```
public static final String PARAM_PATTERNS
```
    Variant of the model. Used to address a specific model if here are multiple models for one language.
    
    See Also:
    
    Constant Field Values
  - PARAM_VARIANT
```
public static final String PARAM_VARIANT
```
    Variant of a model the model. Used to address a specific model if here are multiple models for one language.
    
    See Also:
    
    Constant Field Values
  - PARAM_ACCEPTED_TAGS_REGEX
```
public static final String PARAM_ACCEPTED_TAGS_REGEX
```
    Regex to filter tags, e. g. named entities. Used by, e. g, named entity, trainers to train a model for just one model variant.
    
    See Also:
    
    Constant Field Values
  - PARAM_MODEL_LOCATION
```
public static final String PARAM_MODEL_LOCATION
```
    Location from which the model is read.
    
    See Also:
    
    Constant Field Values
  - PARAM_SEGMENTATION_MODEL_LOCATION
```
public static final String PARAM_SEGMENTATION_MODEL_LOCATION
```
    Location from which the segmentation model is read.
    
    See Also:
    
    Constant Field Values
  - PARAM_TOKENIZATION_MODEL_LOCATION
```
public static final String PARAM_TOKENIZATION_MODEL_LOCATION
```
    Location from which the tokenization model is read.
    
    See Also:
    
    Constant Field Values
  - PARAM_MODEL_ENCODING
```
public static final String PARAM_MODEL_ENCODING
```
    The character encoding used by the model.
    
    See Also:
    
    Constant Field Values
  - PARAM_SOURCE_LOCATION
```
public static final String PARAM_SOURCE_LOCATION
```
    Location from which the input is read.
    
    See Also:
    
    Constant Field Values
  - PARAM_SOURCE_ENCODING
```
public static final String PARAM_SOURCE_ENCODING
```
    Character encoding of the input data.
    
    See Also:
    
    Constant Field Values
  - PARAM_TARGET_LOCATION
```
public static final String PARAM_TARGET_LOCATION
```
    Location to which the output is written.
    
    See Also:
    
    Constant Field Values
  - PARAM_TARGET_ENCODING
```
public static final String PARAM_TARGET_ENCODING
```
    Character encoding of the output data.
    
    See Also:
    
    Constant Field Values
  - PARAM_FILENAME_EXTENSION
```
public static final String PARAM_FILENAME_EXTENSION
```
    Use this filename extension.
    
    See Also:
    
    Constant Field Values
  - PARAM_STRIP_EXTENSION
```
public static final String PARAM_STRIP_EXTENSION
```
    Remove the original extension.
    
    See Also:
    
    Constant Field Values
  - PARAM_PRINT_TAGSET
```
public static final String PARAM_PRINT_TAGSET
```
    Log the tag set(s) when a model is loaded.
    
    See Also:
    
    Constant Field Values
  - PARAM_INTERN_TAGS
```
public static final String PARAM_INTERN_TAGS
```
    Use the String.intern() method on tags. This is usually a good idea to avoid spamming the heap with thousands of strings representing only a few different tags.
    
    See Also:
    
    Constant Field Values
  - PARAM_DELETE_COVER
```
public static final String PARAM_DELETE_COVER
```
    When splitting an annotation into multiple parts, e.g. when splitting a token that is a compound word into multiple tokens, each representing a part of the word, this parameter controls if the original annotation is kept or removed.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_SENTENCE_LENGTH
```
public static final String PARAM_MAX_SENTENCE_LENGTH
```
    Maximal sentence length in tokens that is still being processed.
    
    See Also:
    
    Constant Field Values
  - PARAM_NUM_THREADS
```
public static final String PARAM_NUM_THREADS
```
    The number of threads to use for components that implement multi-threading
    
    See Also:
    
    Constant Field Values
  - AUTO_NUM_THREADS
```
public static final String AUTO_NUM_THREADS
```
    Use smart number of threads if PARAM_NUM_THREADS is set to this value
    
    See Also:
    
    Constant Field Values
  - PARAM_READ_PARAGRAPH
```
public static final String PARAM_READ_PARAGRAPH
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_SENTENCE
```
public static final String PARAM_READ_SENTENCE
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_TOKEN
```
public static final String PARAM_READ_TOKEN
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_FORM
```
public static final String PARAM_READ_FORM
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_LEMMA
```
public static final String PARAM_READ_LEMMA
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_POS
```
public static final String PARAM_READ_POS
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_CPOS
```
public static final String PARAM_READ_CPOS
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_CHUNK
```
public static final String PARAM_READ_CHUNK
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_MORPH
```
public static final String PARAM_READ_MORPH
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_CONSTITUENT
```
public static final String PARAM_READ_CONSTITUENT
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_COREFERENCE
```
public static final String PARAM_READ_COREFERENCE
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_PENN_TREE
```
public static final String PARAM_READ_PENN_TREE
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_DEPENDENCY
```
public static final String PARAM_READ_DEPENDENCY
```
    See Also:
    
    Constant Field Values
  - PARAM_READ_NAMED_ENTITY
```
public static final String PARAM_READ_NAMED_ENTITY
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_PARAGRAPH
```
public static final String PARAM_WRITE_PARAGRAPH
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_SENTENCE
```
public static final String PARAM_WRITE_SENTENCE
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_TOKEN
```
public static final String PARAM_WRITE_TOKEN
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_FORM
```
public static final String PARAM_WRITE_FORM
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_LEMMA
```
public static final String PARAM_WRITE_LEMMA
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_POS
```
public static final String PARAM_WRITE_POS
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_CPOS
```
public static final String PARAM_WRITE_CPOS
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_CHUNK
```
public static final String PARAM_WRITE_CHUNK
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_MORPH
```
public static final String PARAM_WRITE_MORPH
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_CONSTITUENT
```
public static final String PARAM_WRITE_CONSTITUENT
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_COREFERENCE
```
public static final String PARAM_WRITE_COREFERENCE
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_PENN_TREE
```
public static final String PARAM_WRITE_PENN_TREE
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_DEPENDENCY
```
public static final String PARAM_WRITE_DEPENDENCY
```
    See Also:
    
    Constant Field Values
  - PARAM_WRITE_NAMED_ENTITY
```
public static final String PARAM_WRITE_NAMED_ENTITY
```
    See Also:
    
    Constant Field Values
  - PARAM_POS_TAG_SET
```
public static final String PARAM_POS_TAG_SET
```
    Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.
    
    See Also:
    
    Constant Field Values
  - PARAM_CHUNK_TAG_SET
```
public static final String PARAM_CHUNK_TAG_SET
```
    Use this chunk tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.
    
    See Also:
    
    Constant Field Values
  - PARAM_CONSTITUENT_TAG_SET
```
public static final String PARAM_CONSTITUENT_TAG_SET
```
    See Also:
    
    Constant Field Values
  - PARAM_MORPH_TAG_SET
```
public static final String PARAM_MORPH_TAG_SET
```
    See Also:
    
    Constant Field Values
  - PARAM_POS_MAPPING_LOCATION
```
public static final String PARAM_POS_MAPPING_LOCATION
```
    Location of the mapping file for part-of-speech tags to UIMA types.
    
    See Also:
    
    Constant Field Values
  - PARAM_CONSTITUENT_MAPPING_LOCATION
```
public static final String PARAM_CONSTITUENT_MAPPING_LOCATION
```
    Location of the mapping file for constituent tags to UIMA types.
    
    See Also:
    
    Constant Field Values
  - PARAM_CHUNK_MAPPING_LOCATION
```
public static final String PARAM_CHUNK_MAPPING_LOCATION
```
    Location of the mapping file for chunk tags to UIMA types.
    
    See Also:
    
    Constant Field Values
  - PARAM_NAMED_ENTITY_MAPPING_LOCATION
```
public static final String PARAM_NAMED_ENTITY_MAPPING_LOCATION
```
    Location of the mapping file for named entity tags to UIMA types.
    
    See Also:
    
    Constant Field Values
  - PARAM_MORPH_MAPPING_LOCATION
```
public static final String PARAM_MORPH_MAPPING_LOCATION
```
    Location of the mapping file for morphological analysis strings to features.
    
    See Also:
    
    Constant Field Values
  - PARAM_DEPENDENCY_MAPPING_LOCATION
```
public static final String PARAM_DEPENDENCY_MAPPING_LOCATION
```
    Location of the mapping file for dependency tags to UIMA types.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - computeNumThreads
```
public static int computeNumThreads(int value)
```
    Compute the number of threads to use for components that can make use of multi-threading.
    - for positive values: use the given number of threads, with the number of available CPUs maximum.
    - for negative value: use the number of available CPUs minus the given value, minimum 1.
    - for AUTO_NUM_THREADS (0): use the number of available CPUs minus one.
    Parameters:
    
    value - the user-proposed number of threads (positive, negative, or 0)
    
    Returns:
    
    the actual number of threads to use.

Class ComponentParameters

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENCODING

PARAM_LANGUAGE

PARAM_PATTERNS

PARAM_VARIANT

PARAM_ACCEPTED_TAGS_REGEX

PARAM_MODEL_LOCATION

PARAM_SEGMENTATION_MODEL_LOCATION

PARAM_TOKENIZATION_MODEL_LOCATION

PARAM_MODEL_ENCODING

PARAM_SOURCE_LOCATION

PARAM_SOURCE_ENCODING

PARAM_TARGET_LOCATION

PARAM_TARGET_ENCODING

PARAM_FILENAME_EXTENSION

PARAM_STRIP_EXTENSION

PARAM_PRINT_TAGSET

PARAM_INTERN_TAGS

PARAM_DELETE_COVER

PARAM_MAX_SENTENCE_LENGTH

PARAM_NUM_THREADS

AUTO_NUM_THREADS

PARAM_READ_PARAGRAPH

PARAM_READ_SENTENCE

PARAM_READ_TOKEN

PARAM_READ_FORM

PARAM_READ_LEMMA

PARAM_READ_POS

PARAM_READ_CPOS

PARAM_READ_CHUNK

PARAM_READ_MORPH

PARAM_READ_CONSTITUENT

PARAM_READ_COREFERENCE

PARAM_READ_PENN_TREE

PARAM_READ_DEPENDENCY

PARAM_READ_NAMED_ENTITY

PARAM_WRITE_PARAGRAPH

PARAM_WRITE_SENTENCE

PARAM_WRITE_TOKEN

PARAM_WRITE_FORM

PARAM_WRITE_LEMMA

PARAM_WRITE_POS

PARAM_WRITE_CPOS

PARAM_WRITE_CHUNK

PARAM_WRITE_MORPH

PARAM_WRITE_CONSTITUENT

PARAM_WRITE_COREFERENCE

PARAM_WRITE_PENN_TREE

PARAM_WRITE_DEPENDENCY

PARAM_WRITE_NAMED_ENTITY

PARAM_POS_TAG_SET

PARAM_CHUNK_TAG_SET

PARAM_CONSTITUENT_TAG_SET

PARAM_MORPH_TAG_SET

PARAM_POS_MAPPING_LOCATION

PARAM_CONSTITUENT_MAPPING_LOCATION

PARAM_CHUNK_MAPPING_LOCATION

PARAM_NAMED_ENTITY_MAPPING_LOCATION

PARAM_MORPH_MAPPING_LOCATION

PARAM_DEPENDENCY_MAPPING_LOCATION

Method Detail

computeNumThreads