You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@uima.apache.org by Richard Eckart de Castilho <ri...@gmail.com> on 2013/04/10 15:58:48 UTC

TextMarker parameters

Hi Peter,

is there any documentation what the following parameters do?

SCRIPT_PATHS
RESOURCE_PATHS
ADDITIONAL_SCRIPTS
ADDITIONAL_ENGINES
REMOVE_BASICS
SEEDERS
DEFAULT_FILTERED_TYPES

I found no JavaDoc in TextMarkerEngine (2.0.0). If there is no documentation,
would you mind briefly describing each?

Cheers,

-- Richard

Re: TextMarker parameters

Posted by Richard Eckart de Castilho <ri...@gmail.com>.
Excellent :) I added these as JavaDoc comments to the TextMarker component
in DKPro core. I expect there is no objection from you ;)

Since the uimafit-maven-plugin supports failing a build on missing 
parameter descriptions, I'm using that option to hunt down under-documented
components ;)

Cheers,

-- Richard

Am 10.04.2013 um 17:39 schrieb Peter Klügl <pk...@uni-wuerzburg.de>:

> Hi,
> 
> 
> Am 10.04.2013 15:58, schrieb Richard Eckart de Castilho:
>> Hi Peter,
>> 
>> is there any documentation what the following parameters do?
>> 
>> SCRIPT_PATHS
> 
> lookup paths for the script files
> 
>> RESOURCE_PATHS
> 
> lookup paths for the resource files like word lists
> 
>> ADDITIONAL_SCRIPTS
> 
> names of referenced script files: file name without extension with package namspace separated by periods
> 
>> ADDITIONAL_ENGINES
> 
> names of referenced analysis engine descriptors, again wihtout extension and with package namespace
> 
>> REMOVE_BASICS
> 
> option to remove the inference annotations after the script was applied
> 
>> SEEDERS
> 
> list of some implemenations that add annotations before the script is applied. By default there is the TextMarker lexer which adds the annotations like CW
> 
>> DEFAULT_FILTERED_TYPES
> 
> the types that are filtered by default. Defining parts of text which are normally not interesting.
> 
>> 
>> I found no JavaDoc in TextMarkerEngine (2.0.0). If there is no documentation,
>> would you mind briefly describing each?
> 
> there is a short description in the documentation, section 1.5.1.2
> http://uima.apache.org/d/textmarker-current/tools.textmarker.book.html#ugr.tools.tm.ae.basic
> 
> There is no JavaDoc yet, but it's on my todo-list.
> 
> Best,
> 
> Peter
> 
>> Cheers,
>> 
>> -- Richard
>

Re: TextMarker parameters

Posted by Peter Klügl <pk...@uni-wuerzburg.de>.
Hi,


Am 10.04.2013 15:58, schrieb Richard Eckart de Castilho:
> Hi Peter,
>
> is there any documentation what the following parameters do?
>
> SCRIPT_PATHS

lookup paths for the script files

> RESOURCE_PATHS

lookup paths for the resource files like word lists

> ADDITIONAL_SCRIPTS

names of referenced script files: file name without extension with 
package namspace separated by periods

> ADDITIONAL_ENGINES

names of referenced analysis engine descriptors, again wihtout extension 
and with package namespace

> REMOVE_BASICS

option to remove the inference annotations after the script was applied

> SEEDERS

list of some implemenations that add annotations before the script is 
applied. By default there is the TextMarker lexer which adds the 
annotations like CW

> DEFAULT_FILTERED_TYPES

the types that are filtered by default. Defining parts of text which are 
normally not interesting.

>
> I found no JavaDoc in TextMarkerEngine (2.0.0). If there is no documentation,
> would you mind briefly describing each?

there is a short description in the documentation, section 1.5.1.2
http://uima.apache.org/d/textmarker-current/tools.textmarker.book.html#ugr.tools.tm.ae.basic

There is no JavaDoc yet, but it's on my todo-list.

Best,

Peter

> Cheers,
>
> -- Richard