| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+dataBasename |
+"data" |
+
+
+public static final String |
+headerBasename |
+"header" |
+
+
+public static final String |
+outputClassFeature |
+"LF_target" |
+
+
+public static final String |
+outputProbFeature |
+"LF_confidence" |
+
+
+public static final String |
+outputSequenceSpanIDFeature |
+"LF_seq_span_id" |
+
+
+public static final String |
+savedModelDirectory |
+"savedModel" |
+
+
+public static final String |
+tempOutputASName |
+"tmp_outputas_for_ner" |
+
+
+public static final String |
+trainFilename |
+"trainfile" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+DATA_FILE_NAME |
+"crvd.data.json" |
+
+
+public static final String |
+META_FILE_NAME |
+"crvd.meta.json" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+HASMISSINGVALUE_FLAG |
+"\u2554HASMISSINGVALUE\u2557" |
+
+
+public static final String |
+INSTANCE_WEIGHT |
+"\u2554INSTANCEWEIGHT\u2557" |
+
+
+public static final String |
+TARGET_COSTS |
+"\u2554TARGETCOSTS\u2557" |
+
+
+public static final String |
+TARGET_VALUE |
+"\u2554TARGETVALUE\u2557" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+FILENAME_MODEL |
+"lf.model" |
+
+
+public static final String |
+FILENAME_PIPE |
+"lf.pipe" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+protected final String |
+ENV_WRAPPER_HOME |
+"WEKA_WRAPPER_HOME" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+FILENAME_INFO |
+"info.yaml" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+protected static final boolean |
+DEBUG_SEQUENCE_CLASS |
+true |
+
+
+public static final String |
+ELEMSEP |
+"\u2504" |
+
+
+public static final String |
+MVVALUE |
+"\u2554MV\u2557" |
+
+
+public static final String |
+NAMESEP |
+"\u256c" |
+
+
+public static final String |
+NGRAMSEP |
+"\u250b" |
+
+
+public static final String |
+PROP_HAVE_MV |
+"haveMV" |
+
+
+public static final String |
+PROP_IGNORE_HAS_MV |
+"ignore-MV" |
+
+
+public static final String |
+SEQ_BEGINNING |
+"B" |
+
+
+public static final String |
+SEQ_INSIDE |
+"I" |
+
+
+public static final String |
+SEQ_OUTSIDE |
+"O" |
+
+
+public static final String |
+START_SYMBOL |
+"\u2554START\u2557" |
+
+
+public static final String |
+STOP_SYMBOL |
+"\u2554STOP\u2557" |
+
+
+public static final String |
+TYPESEP |
+"\u2506" |
+
+
+public static final String |
+VALSEP |
+"\u2550" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+CODE_BEGIN |
+"B" |
+
+
+public static final String |
+CODE_END |
+"E" |
+
+
+public static final String |
+CODE_INSIDE |
+"I" |
+
+
+public static final String |
+CODE_OUTSIDE |
+"O" |
+
+
+public static final String |
+CODE_SINGLE |
+"S" |
+
+
+public static final String |
+CODESEP |
+"|" |
+
+
+public static final String |
+TYPESEP |
+"," |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+KEY_FOR_TARGET |
+"\u2573TARGET\u2573" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+DEFAULT_ARG_NAME |
+"arg" |
+
+
+public static final int |
+DEFAULT_DESC_PAD |
+3 |
+
+
+public static final int |
+DEFAULT_LEFT_PAD |
+1 |
+
+
+public static final String |
+DEFAULT_LONG_OPT_PREFIX |
+"--" |
+
+
+public static final String |
+DEFAULT_LONG_OPT_SEPARATOR |
+" " |
+
+
+public static final String |
+DEFAULT_OPT_PREFIX |
+"-" |
+
+
+public static final String |
+DEFAULT_SYNTAX_PREFIX |
+"usage: " |
+
+
+public static final int |
+DEFAULT_WIDTH |
+74 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+UNINITIALIZED |
+-1 |
+
+
+public static final int |
+UNLIMITED_VALUES |
+-2 |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/deprecated-list.html b/apidocs/deprecated-list.html new file mode 100644 index 0000000..fc57274 --- /dev/null +++ b/apidocs/deprecated-list.html @@ -0,0 +1,268 @@ + + + + + + +| Class and Description | +
|---|
| org.apache.commons.clipatched.BasicParser
+ since 1.3, use the
+DefaultParser instead |
+
| org.apache.commons.clipatched.GnuParser
+ since 1.3, use the
+DefaultParser instead |
+
| org.apache.commons.clipatched.OptionBuilder
+ since 1.3, use
+Option.builder(String) instead |
+
| org.apache.commons.clipatched.Parser
+ since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases
+ |
+
| org.apache.commons.clipatched.PosixParser
+ since 1.3, use the
+DefaultParser instead |
+
| Field and Description | +
|---|
| org.apache.commons.clipatched.HelpFormatter.defaultArgName
+ Scope will be made private for next major version
+ - use get/setArgName methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultDescPad
+ Scope will be made private for next major version
+ - use get/setDescPadding methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultLeftPad
+ Scope will be made private for next major version
+ - use get/setLeftPadding methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultLongOptPrefix
+ Scope will be made private for next major version
+ - use get/setLongOptPrefix methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultNewLine
+ Scope will be made private for next major version
+ - use get/setNewLine methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultOptPrefix
+ Scope will be made private for next major version
+ - use get/setOptPrefix methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultSyntaxPrefix
+ Scope will be made private for next major version
+ - use get/setSyntaxPrefix methods instead.
+ |
+
| org.apache.commons.clipatched.HelpFormatter.defaultWidth
+ Scope will be made private for next major version
+ - use get/setWidth methods instead.
+ |
+
| Method and Description | +
|---|
| org.apache.commons.clipatched.Option.addValue(String) | +
| org.apache.commons.clipatched.CommandLine.getOptionObject(String)
+ due to System.err message. Instead use getParsedOptionValue(String)
+ |
+
| org.apache.commons.clipatched.Option.setType(Object)
+ since 1.3, use
+Option.setType(Class) instead |
+
| org.apache.commons.clipatched.OptionBuilder.withType(Object)
+ since 1.3, use
+OptionBuilder.withType(Class) instead |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/data/SparseDoubleVector.html b/apidocs/gate/lib/interaction/data/SparseDoubleVector.html new file mode 100644 index 0000000..fae3ce6 --- /dev/null +++ b/apidocs/gate/lib/interaction/data/SparseDoubleVector.html @@ -0,0 +1,403 @@ + + + + + + +public class SparseDoubleVector +extends Object +implements Serializable+
| Modifier and Type | +Field and Description | +
|---|---|
protected int[] |
+indices |
+
protected double |
+instanceWeight |
+
protected double[] |
+values |
+
| Constructor and Description | +
|---|
SparseDoubleVector(int numberOfLocations) |
+
| Modifier and Type | +Method and Description | +
|---|---|
double |
+getInstanceWeight() |
+
int[] |
+getLocations() |
+
double[] |
+getValues() |
+
int |
+nLocations() |
+
void |
+setInstanceWeight(double weight) |
+
protected int[] indices+
protected double[] values+
protected double instanceWeight+
public SparseDoubleVector(int numberOfLocations)+
public int[] getLocations()+
public double[] getValues()+
public int nLocations()+
public double getInstanceWeight()+
public void setInstanceWeight(double weight)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/data/class-use/SparseDoubleVector.html b/apidocs/gate/lib/interaction/data/class-use/SparseDoubleVector.html new file mode 100644 index 0000000..cc687a2 --- /dev/null +++ b/apidocs/gate/lib/interaction/data/class-use/SparseDoubleVector.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/data/package-frame.html b/apidocs/gate/lib/interaction/data/package-frame.html new file mode 100644 index 0000000..dab0aab --- /dev/null +++ b/apidocs/gate/lib/interaction/data/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| SparseDoubleVector | +
+ Minimal container for a sparse vector of n non-zero locations.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/data/package-tree.html b/apidocs/gate/lib/interaction/data/package-tree.html new file mode 100644 index 0000000..33fe8b5 --- /dev/null +++ b/apidocs/gate/lib/interaction/data/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/data/package-use.html b/apidocs/gate/lib/interaction/data/package-use.html new file mode 100644 index 0000000..2201f95 --- /dev/null +++ b/apidocs/gate/lib/interaction/data/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/EchoObjectStream.html b/apidocs/gate/lib/interaction/process/EchoObjectStream.html new file mode 100644 index 0000000..3fbdcef --- /dev/null +++ b/apidocs/gate/lib/interaction/process/EchoObjectStream.html @@ -0,0 +1,284 @@ + + + + + + +public class EchoObjectStream +extends Object+
| Constructor and Description | +
|---|
EchoObjectStream() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+main(String[] args) |
+
public static void main(String[] args) + throws IOException, + ClassNotFoundException+
IOExceptionClassNotFoundExceptionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/EchoStream.html b/apidocs/gate/lib/interaction/process/EchoStream.html new file mode 100644 index 0000000..4ec7de9 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/EchoStream.html @@ -0,0 +1,284 @@ + + + + + + +public class EchoStream +extends Object+
| Constructor and Description | +
|---|
EchoStream() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+main(String[] args) |
+
public static void main(String[] args) + throws IOException, + ClassNotFoundException+
IOExceptionClassNotFoundExceptionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/Process4JsonStream.html b/apidocs/gate/lib/interaction/process/Process4JsonStream.html new file mode 100644 index 0000000..ba36667 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/Process4JsonStream.html @@ -0,0 +1,411 @@ + + + + + + +public class Process4JsonStream +extends ProcessBase+
builder, command, envvars, loggerThread, process, workingDir| Modifier and Type | +Method and Description | +
|---|---|
static Process4JsonStream |
+create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static Process4JsonStream |
+create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
boolean |
+isAlive()
+Check if the external process is running.
+ |
+
static void |
+main(String[] args) |
+
Object |
+readObject()
+Read an object from the process.
+ |
+
protected void |
+setupInteraction()
+This handles the exact way of how the communication is set up.
+ |
+
protected void |
+stopInteraction() |
+
void |
+writeObject(Object object)
+Send a message to the process.
+ |
+
ensureProcess, logStream, need2start, stop, updateCommand4OS, waitForpublic static Process4JsonStream create(File workingDirectory, + Map<String,String> env, + List<String> command)+
public static Process4JsonStream create(File workingDirectory, + Map<String,String> env, + String... command)+
public Object readObject()+
ProcessBasereadObject in class ProcessBasepublic void writeObject(Object object)+
writeObject in class ProcessBaseobject - the object to sendpublic boolean isAlive()+
isAlive in class ProcessBaseprotected void setupInteraction()+
ProcessBasesetupInteraction in class ProcessBaseprotected void stopInteraction()+
stopInteraction in class ProcessBasepublic static void main(String[] args)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/Process4ObjectStream.html b/apidocs/gate/lib/interaction/process/Process4ObjectStream.html new file mode 100644 index 0000000..61042e7 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/Process4ObjectStream.html @@ -0,0 +1,411 @@ + + + + + + +public class Process4ObjectStream +extends ProcessBase+
builder, command, envvars, loggerThread, process, workingDir| Modifier and Type | +Method and Description | +
|---|---|
static Process4ObjectStream |
+create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static Process4ObjectStream |
+create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
boolean |
+isAlive()
+Check if the external process is running.
+ |
+
static void |
+main(String[] args) |
+
Object |
+readObject()
+Read an object from the process.
+ |
+
protected void |
+setupInteraction()
+This handles the exact way of how the communication is set up.
+ |
+
protected void |
+stopInteraction() |
+
void |
+writeObject(Object object)
+Send a message to the process.
+ |
+
ensureProcess, logStream, need2start, stop, updateCommand4OS, waitForpublic static Process4ObjectStream create(File workingDirectory, + Map<String,String> env, + List<String> command)+
public static Process4ObjectStream create(File workingDirectory, + Map<String,String> env, + String... command)+
public Object readObject()+
ProcessBasereadObject in class ProcessBasepublic void writeObject(Object object)+
writeObject in class ProcessBaseobject - the object to sendpublic boolean isAlive()+
isAlive in class ProcessBaseprotected void setupInteraction()+
ProcessBasesetupInteraction in class ProcessBaseprotected void stopInteraction()+
stopInteraction in class ProcessBasepublic static void main(String[] args)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/Process4StringStream.html b/apidocs/gate/lib/interaction/process/Process4StringStream.html new file mode 100644 index 0000000..e286cc4 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/Process4StringStream.html @@ -0,0 +1,417 @@ + + + + + + +public class Process4StringStream +extends ProcessBase+
builder, command, envvars, loggerThread, process, workingDir| Modifier and Type | +Method and Description | +
|---|---|
static Process4StringStream |
+create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static Process4StringStream |
+create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
boolean |
+isAlive()
+Check if the external process is running.
+ |
+
static void |
+main(String[] args) |
+
Object |
+readObject()
+Read an object from the process.
+ |
+
protected void |
+setupInteraction()
+This handles the exact way of how the communication is set up.
+ |
+
protected void |
+stopInteraction() |
+
void |
+writeObject(Object object)
+Send a message to the process.
+ |
+
ensureProcess, logStream, need2start, stop, updateCommand4OS, waitForpublic static Process4StringStream create(File workingDirectory, + Map<String,String> env, + List<String> command)+
public static Process4StringStream create(File workingDirectory, + Map<String,String> env, + String... command)+
public Object readObject()+
ProcessBasereadObject in class ProcessBasepublic void writeObject(Object object)+
writeObject in class ProcessBaseobject - object to sendpublic boolean isAlive()+
isAlive in class ProcessBaseprotected void setupInteraction()+
ProcessBasesetupInteraction in class ProcessBaseprotected void stopInteraction()+
stopInteraction in class ProcessBasepublic static void main(String[] args)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/ProcessBase.html b/apidocs/gate/lib/interaction/process/ProcessBase.html new file mode 100644 index 0000000..a663a3b --- /dev/null +++ b/apidocs/gate/lib/interaction/process/ProcessBase.html @@ -0,0 +1,571 @@ + + + + + + +public abstract class ProcessBase +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected ProcessBuilder |
+builder |
+
protected List<String> |
+command |
+
protected Map<String,String> |
+envvars |
+
protected Thread |
+loggerThread |
+
protected Process |
+process |
+
protected File |
+workingDir |
+
| Constructor and Description | +
|---|
ProcessBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+ensureProcess()
+Make sure the process is running.
+ |
+
boolean |
+isAlive()
+Check if the external process is running.
+ |
+
protected void |
+logStream(InputStream stream,
+ OutputStream outstream)
+Copy the stream output to the logger using the given logging level.
+ |
+
protected boolean |
+need2start() |
+
abstract Object |
+readObject()
+Read an object from the process.
+ |
+
protected abstract void |
+setupInteraction()
+This handles the exact way of how the communication is set up.
+ |
+
void |
+stop()
+Attempt to stop the external process.
+ |
+
protected abstract void |
+stopInteraction() |
+
protected void |
+updateCommand4OS(List<String> command)
+Does an in-place update of the command to conform to what the OS expects.
+ |
+
int |
+waitFor() |
+
abstract void |
+writeObject(Object message)
+Send an object to the process.
+ |
+
protected ProcessBuilder builder+
protected Process process+
protected File workingDir+
protected Thread loggerThread+
public boolean ensureProcess()+
public abstract Object readObject()+
public abstract void writeObject(Object message)+
message - object to sendpublic boolean isAlive()+
public int waitFor()+
public void stop()+
protected abstract void setupInteraction()+
protected abstract void stopInteraction()+
protected void logStream(InputStream stream, + OutputStream outstream)+
stream - stream to copyoutstream - where to copy it toprotected boolean need2start()+
protected void updateCommand4OS(List<String> command)+
command - commandCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/ProcessSimple.html b/apidocs/gate/lib/interaction/process/ProcessSimple.html new file mode 100644 index 0000000..52f6232 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/ProcessSimple.html @@ -0,0 +1,433 @@ + + + + + + +public class ProcessSimple +extends ProcessBase+
builder, command, envvars, loggerThread, process, workingDir| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+copyStream(InputStream processStream,
+ OutputStream ourStream)
+Copy stream
+ |
+
static ProcessSimple |
+create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static ProcessSimple |
+create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
boolean |
+isAlive()
+Check if the external process is running.
+ |
+
static void |
+main(String[] args) |
+
Object |
+readObject()
+This always returns null for this class.
+ |
+
protected void |
+setupInteraction()
+This handles the exact way of how the communication is set up.
+ |
+
protected void |
+stopInteraction() |
+
void |
+writeObject(Object object)
+Does nothing.
+ |
+
ensureProcess, logStream, need2start, stop, updateCommand4OS, waitForpublic static ProcessSimple create(File workingDirectory, + Map<String,String> env, + List<String> command)+
public static ProcessSimple create(File workingDirectory, + Map<String,String> env, + String... command)+
public Object readObject()+
readObject in class ProcessBasepublic void writeObject(Object object)+
writeObject in class ProcessBaseobject - to sendpublic boolean isAlive()+
isAlive in class ProcessBaseprotected void copyStream(InputStream processStream, + OutputStream ourStream)+
processStream - to copyourStream - where to copyprotected void setupInteraction()+
ProcessBasesetupInteraction in class ProcessBaseprotected void stopInteraction()+
stopInteraction in class ProcessBasepublic static void main(String[] args)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/EchoObjectStream.html b/apidocs/gate/lib/interaction/process/class-use/EchoObjectStream.html new file mode 100644 index 0000000..77814fe --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/EchoObjectStream.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/EchoStream.html b/apidocs/gate/lib/interaction/process/class-use/EchoStream.html new file mode 100644 index 0000000..0d8fa4f --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/EchoStream.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/Process4JsonStream.html b/apidocs/gate/lib/interaction/process/class-use/Process4JsonStream.html new file mode 100644 index 0000000..8fb814c --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/Process4JsonStream.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.lib.interaction.process | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Process4JsonStream |
+Process4JsonStream.create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static Process4JsonStream |
+Process4JsonStream.create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/Process4ObjectStream.html b/apidocs/gate/lib/interaction/process/class-use/Process4ObjectStream.html new file mode 100644 index 0000000..48dc36a --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/Process4ObjectStream.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.lib.interaction.process | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Process4ObjectStream |
+Process4ObjectStream.create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static Process4ObjectStream |
+Process4ObjectStream.create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/Process4StringStream.html b/apidocs/gate/lib/interaction/process/class-use/Process4StringStream.html new file mode 100644 index 0000000..5b1ad2d --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/Process4StringStream.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.lib.interaction.process | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Process4StringStream |
+Process4StringStream.create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static Process4StringStream |
+Process4StringStream.create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/ProcessBase.html b/apidocs/gate/lib/interaction/process/class-use/ProcessBase.html new file mode 100644 index 0000000..543ccb1 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/ProcessBase.html @@ -0,0 +1,226 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.lib.interaction.process | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Process4JsonStream
+Minimalist class for exchanging objects through JSON
+
+ NOTE: at the moment, reading from the process can block forever, there is
+ no timeout!
+ |
+
class |
+Process4ObjectStream
+Minimalist class for exchanging objects through obejct streams with a command line process.
+ |
+
class |
+Process4StringStream
+Minimalist class for exchanging String lines
+
+ This just sends or retrieves arbitrary lines of String which could be
+ JSON we already have or want to parse ourself, or anything else.
+ |
+
class |
+ProcessSimple
+Minimalist class for running an external command.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected ProcessBase |
+EngineMBSklearnBase.process |
+
protected ProcessBase |
+EngineDVFileJson.process |
+
protected ProcessBase |
+EngineMBPythonNetworksBase.process |
+
protected ProcessBase |
+EngineMBWekaWrapper.process |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/class-use/ProcessSimple.html b/apidocs/gate/lib/interaction/process/class-use/ProcessSimple.html new file mode 100644 index 0000000..6bdef3f --- /dev/null +++ b/apidocs/gate/lib/interaction/process/class-use/ProcessSimple.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.lib.interaction.process | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static ProcessSimple |
+ProcessSimple.create(File workingDirectory,
+ Map<String,String> env,
+ List<String> command) |
+
static ProcessSimple |
+ProcessSimple.create(File workingDirectory,
+ Map<String,String> env,
+ String... command) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/package-frame.html b/apidocs/gate/lib/interaction/process/package-frame.html new file mode 100644 index 0000000..5d371d1 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/package-frame.html @@ -0,0 +1,27 @@ + + + + + + +| Class | +Description | +
|---|---|
| EchoObjectStream | ++ |
| EchoStream | ++ |
| Process4JsonStream | +
+ Minimalist class for exchanging objects through JSON
+
+ NOTE: at the moment, reading from the process can block forever, there is
+ no timeout!
+ |
+
| Process4ObjectStream | +
+ Minimalist class for exchanging objects through obejct streams with a command line process.
+ |
+
| Process4StringStream | +
+ Minimalist class for exchanging String lines
+
+ This just sends or retrieves arbitrary lines of String which could be
+ JSON we already have or want to parse ourself, or anything else.
+ |
+
| ProcessBase | +
+ Minimalist base class for exchanging objects with a command line process.
+ |
+
| ProcessSimple | +
+ Minimalist class for running an external command.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/package-tree.html b/apidocs/gate/lib/interaction/process/package-tree.html new file mode 100644 index 0000000..33b0276 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/lib/interaction/process/package-use.html b/apidocs/gate/lib/interaction/process/package-use.html new file mode 100644 index 0000000..e544ba9 --- /dev/null +++ b/apidocs/gate/lib/interaction/process/package-use.html @@ -0,0 +1,208 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.lib.interaction.process | ++ |
| gate.plugin.learningframework.engines | ++ |
| Class and Description | +
|---|
| Process4JsonStream
+ Minimalist class for exchanging objects through JSON
+
+ NOTE: at the moment, reading from the process can block forever, there is
+ no timeout!
+ |
+
| Process4ObjectStream
+ Minimalist class for exchanging objects through obejct streams with a command line process.
+ |
+
| Process4StringStream
+ Minimalist class for exchanging String lines
+
+ This just sends or retrieves arbitrary lines of String which could be
+ JSON we already have or want to parse ourself, or anything else.
+ |
+
| ProcessBase
+ Minimalist base class for exchanging objects with a command line process.
+ |
+
| ProcessSimple
+ Minimalist class for running an external command.
+ |
+
| Class and Description | +
|---|
| ProcessBase
+ Minimalist base class for exchanging objects with a command line process.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/AbstractDocumentProcessor.html b/apidocs/gate/plugin/learningframework/AbstractDocumentProcessor.html new file mode 100644 index 0000000..529b8c7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/AbstractDocumentProcessor.html @@ -0,0 +1,978 @@ + + + + + + +public abstract class AbstractDocumentProcessor
+extends gate.creole.AbstractLanguageAnalyser
+implements gate.creole.ControllerAwarePR, gate.util.Benchmarkable
+gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected gate.Controller |
+controller |
+
protected int |
+duplicateId |
+
protected Throwable |
+lastError |
+
protected AtomicInteger |
+nDuplicates |
+
protected AtomicInteger |
+remainingDuplicates |
+
protected AtomicInteger |
+seenDocuments |
+
AtomicInteger |
+seenDocumentsThisDuplicate |
+
protected ConcurrentHashMap<String,Object> |
+sharedData |
+
protected static Object |
+SYNC_OBJECT |
+
protected Object |
+syncObject |
+
corpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
AbstractDocumentProcessor() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+benchmarkCheckpoint(long startTime,
+ String name) |
+
void |
+controllerExecutionAborted(gate.Controller arg0,
+ Throwable arg1)
+Handle the controller execution aborted callback.
+ |
+
void |
+controllerExecutionFinished(gate.Controller arg0) |
+
void |
+controllerExecutionStarted(gate.Controller arg0) |
+
abstract void |
+controllerFinished(gate.Controller ctrl,
+ Throwable thrw)
+Callback for when each controller finishes on a corpus.
+ |
+
abstract void |
+controllerStarted(gate.Controller ctrl)
+Callback for when each controller gets started on a corpus.
+ |
+
void |
+execute() |
+
String |
+getBenchmarkId() |
+
int |
+getDuplicateId() |
+
Throwable |
+getLastError() |
+
AtomicInteger |
+getNDuplicates() |
+
AtomicInteger |
+getRemainingDuplicates() |
+
AtomicInteger |
+getSeenDocuments() |
+
ConcurrentHashMap<String,Object> |
+getSharedData() |
+
Object |
+getSyncObject() |
+
gate.Resource |
+init() |
+
protected abstract void |
+process(gate.Document document)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setBenchmarkId(String string) |
+
void |
+setLastError(Throwable x) |
+
void |
+setNDuplicates(AtomicInteger n) |
+
void |
+setRemainingDuplicates(AtomicInteger n) |
+
void |
+setSeenDocuments(AtomicInteger n) |
+
void |
+setSharedData(ConcurrentHashMap<String,Object> v) |
+
void |
+setSyncObject(Object val) |
+
getCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected AtomicInteger seenDocuments+
public AtomicInteger seenDocumentsThisDuplicate+
protected gate.Controller controller+
protected static final Object SYNC_OBJECT+
protected AtomicInteger nDuplicates+
protected AtomicInteger remainingDuplicates+
protected Throwable lastError+
protected ConcurrentHashMap<String,Object> sharedData+
protected Object syncObject+
protected int duplicateId+
public AbstractDocumentProcessor()+
@Sharable +public void setSeenDocuments(AtomicInteger n)+
public AtomicInteger getSeenDocuments()+
@Sharable +public void setNDuplicates(AtomicInteger n)+
public AtomicInteger getNDuplicates()+
@Sharable +public void setRemainingDuplicates(AtomicInteger n)+
public AtomicInteger getRemainingDuplicates()+
@Sharable +public void setLastError(Throwable x)+
public Throwable getLastError()+
@Sharable +public void setSharedData(ConcurrentHashMap<String,Object> v)+
public ConcurrentHashMap<String,Object> getSharedData()+
@Sharable +public void setSyncObject(Object val)+
public Object getSyncObject()+
public int getDuplicateId()+
public gate.Resource init() + throws gate.creole.ResourceInstantiationException+
init in interface gate.Resourceinit in class gate.creole.AbstractProcessingResourcegate.creole.ResourceInstantiationExceptionpublic void execute() + throws gate.creole.ExecutionException+
execute in interface gate.Executableexecute in class gate.creole.AbstractProcessingResourcegate.creole.ExecutionExceptionpublic void controllerExecutionAborted(gate.Controller arg0, + Throwable arg1) + throws gate.creole.ExecutionException+
controllerExecutionAborted in interface gate.creole.ControllerAwarePRarg0 - controller invoking the callbackarg1 - throwable representing the error that was encounteredgate.creole.ExecutionException - can be thrownpublic void controllerExecutionFinished(gate.Controller arg0) + throws gate.creole.ExecutionException+
controllerExecutionFinished in interface gate.creole.ControllerAwarePRgate.creole.ExecutionExceptionpublic void controllerExecutionStarted(gate.Controller arg0) + throws gate.creole.ExecutionException+
controllerExecutionStarted in interface gate.creole.ControllerAwarePRgate.creole.ExecutionExceptionprotected abstract void process(gate.Document document)+
document - the document to get processedpublic abstract void controllerStarted(gate.Controller ctrl)+
ctrl - the controller instancepublic abstract void controllerFinished(gate.Controller ctrl, + Throwable thrw)+
ctrl - the controller instancethrw - the Throwable indicating the error or null for normal completionprotected void benchmarkCheckpoint(long startTime, + String name)+
public String getBenchmarkId()+
getBenchmarkId in interface gate.util.Benchmarkablepublic void setBenchmarkId(String string)+
setBenchmarkId in interface gate.util.BenchmarkableCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/EvaluationMethod.html b/apidocs/gate/plugin/learningframework/EvaluationMethod.html new file mode 100644 index 0000000..0c38b7f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/EvaluationMethod.html @@ -0,0 +1,343 @@ + + + + + + +public enum EvaluationMethod +extends Enum<EvaluationMethod>+
| Enum Constant and Description | +
|---|
CROSSVALIDATION |
+
HOLDOUT |
+
| Modifier and Type | +Method and Description | +
|---|---|
static EvaluationMethod |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static EvaluationMethod[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final EvaluationMethod CROSSVALIDATION+
public static final EvaluationMethod HOLDOUT+
public static EvaluationMethod[] values()+
+for (EvaluationMethod c : EvaluationMethod.values()) + System.out.println(c); +
public static EvaluationMethod valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/Globals.html b/apidocs/gate/plugin/learningframework/Globals.html new file mode 100644 index 0000000..b4eda61 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/Globals.html @@ -0,0 +1,402 @@ + + + + + + +public class Globals +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+dataBasename |
+
static String |
+headerBasename |
+
static String |
+outputClassFeature |
+
static String |
+outputProbFeature |
+
static String |
+outputSequenceSpanIDFeature |
+
static String |
+savedModelDirectory |
+
static String |
+tempOutputASName |
+
static String |
+trainFilename |
+
public static final String outputClassFeature+
public static final String outputProbFeature+
public static final String outputSequenceSpanIDFeature+
public static final String tempOutputASName+
public static final String savedModelDirectory+
public static final String trainFilename+
public static final String dataBasename+
public static final String headerBasename+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LFUtils.html b/apidocs/gate/plugin/learningframework/LFUtils.html new file mode 100644 index 0000000..c983a65 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LFUtils.html @@ -0,0 +1,542 @@ + + + + + + +public class LFUtils +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Boolean |
+anyToBooleanOrElse(Object any,
+ Boolean orElse)
+If it is not a boolean, then if it is a string, anything that is not
+ "true" or "True" is false, if it is a number, then anything that
+ is not 0.0 is true.
+ |
+
static double |
+anyToDoubleOrElse(Object any,
+ double orElse)
+Convert the object to a double or, if it is null or not convertible, use the orElse value.
+ |
+
static String |
+anyToStringOrElse(Object any,
+ String orElse)
+Convert any object to a String representation
+ |
+
static boolean |
+exists(URL url)
+Returns true if the URL can be opened for reading.
+ |
+
static String |
+getName(URL url)
+Return the last path component of a hierarchical path of URL.
+ |
+
static String |
+getParent(URL url)
+Return the parent path for a URL.
+ |
+
static URL |
+getParentURL(URL url)
+Return the parent path for a URL.
+ |
+
static boolean |
+isFile(URL url)
+Return truen if the URL is a file URL.
+ |
+
static URL |
+newURL(String str)
+Create a URL from the String.
+ |
+
static URL |
+newURL(URL dirURL,
+ String fileName)
+Equivalent of creating a new file from a directory file and name string.
+ |
+
static URL |
+newURLOld(URL dirURL,
+ String fileName)
+Return URL for the file inside the dir URL.
+ |
+
public static double anyToDoubleOrElse(Object any, + double orElse)+
any - what to convertorElse - default valuepublic static String anyToStringOrElse(Object any, + String orElse)+
any - the objectorElse - default valuepublic static Boolean anyToBooleanOrElse(Object any, + Boolean orElse)+
any - any objectorElse - default valuepublic static URL newURL(String str)+
str - the string representationpublic static URL newURL(URL dirURL, + String fileName)+
+ Note: if the dirURL contains a query and/or a fragment, those parts are + lost in the resulting URL.
dirURL - directory URLfileName - file namepublic static String getName(URL url)+
url - the URLpublic static URL getParentURL(URL url)+
url - the urlpublic static String getParent(URL url)+
url - the urlpublic static boolean exists(URL url)+
url - the urlpublic static boolean isFile(URL url)+
url - the urlpublic static URL newURLOld(URL dirURL, + String fileName)+
dirURL - URLfileName - filenameCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_ApplyChunking.html b/apidocs/gate/plugin/learningframework/LF_ApplyChunking.html new file mode 100644 index 0000000..a331bd5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_ApplyChunking.html @@ -0,0 +1,674 @@ + + + + + + +@CreoleResource(name="LF_ApplyChunking", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyChunking", + comment="Apply a trained chunking model to documents") +public class LF_ApplyChunking +extends LearningFrameworkPRBase+
+ Training, evaluation and application of ML in GATE.
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
protected String |
+outputASName |
+
protected String |
+sequenceSpan |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_ApplyChunking() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
Double |
+getConfidenceThreshold() |
+
URL |
+getDataDirectory() |
+
String |
+getOutputASName() |
+
String |
+getSequenceSpan() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setConfidenceThreshold(Double confidenceThreshold) |
+
void |
+setDataDirectory(URL output) |
+
void |
+setOutputASName(String oasn) |
+
void |
+setSequenceSpan(String seq) |
+
controllerFinished, getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected String outputASName+
protected String sequenceSpan+
@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(defaultValue="LearningFramework") +public void setOutputASName(String oasn)+
public String getOutputASName()+
@RunTime + @Optional + @CreoleParameter(comment="The minimum confidence/probability for including an annotation at application time. In the case of NER, the confidence threshold is applied to the average for the entire entity. If empty, ignore.") +public void setConfidenceThreshold(Double confidenceThreshold)+
public Double getConfidenceThreshold()+
@RunTime + @Optional + @CreoleParameter(comment="For sequence learners, an annotation type defining a meaningful sequence span. Ignored by non-sequence learners. Needs to be in the input AS.") +public void setSequenceSpan(String seq)+
public String getSequenceSpan()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_ApplyClassification.html b/apidocs/gate/plugin/learningframework/LF_ApplyClassification.html new file mode 100644 index 0000000..6e8b774 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_ApplyClassification.html @@ -0,0 +1,760 @@ + + + + + + +@CreoleResource(name="LF_ApplyClassification", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyClassification", + comment="Apply a trained classification model to documents") +public class LF_ApplyClassification +extends LearningFrameworkPRBase+
+ Training, evaluation and application of ML in GATE.
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
protected URL |
+oldDataDirectory |
+
protected String |
+outputASName |
+
protected String |
+serverUrl |
+
protected String |
+targetFeature |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_ApplyClassification() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
Double |
+getConfidenceThreshold() |
+
URL |
+getDataDirectory() |
+
String |
+getOutputASName() |
+
String |
+getSequenceSpan() |
+
String |
+getServerUrl() |
+
String |
+getTargetFeature() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setConfidenceThreshold(Double confidenceThreshold) |
+
void |
+setDataDirectory(URL output) |
+
void |
+setOutputASName(String oasn) |
+
void |
+setSequenceSpan(String seq) |
+
void |
+setServerUrl(String url) |
+
void |
+setTargetFeature(String name) |
+
controllerFinished, getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected URL oldDataDirectory+
protected String outputASName+
protected String targetFeature+
protected String serverUrl+
public LF_ApplyClassification()+
@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="If identical to the input AS, existing annotations are updated", + defaultValue="LearningFramework") +public void setOutputASName(String oasn)+
public String getOutputASName()+
@RunTime + @Optional + @CreoleParameter(comment="The minimum confidence/probability for including an annotation at application time. If empty, ignore.") +public void setConfidenceThreshold(Double confidenceThreshold)+
public Double getConfidenceThreshold()+
@RunTime + @Optional + @CreoleParameter(comment="Name of class feature to add to the original instance annotations. Default is the name that was used for training.", + defaultValue="") +public void setTargetFeature(String name)+
public String getTargetFeature()+
@RunTime + @Optional + @CreoleParameter(comment="For sequence learners, an annotation type defining a meaningful sequence span. Ignored by non-sequence learners. ") +public void setSequenceSpan(String seq)+
public String getSequenceSpan()+
@RunTime + @Optional + @CreoleParameter(comment="Classify from a server instead of a stored model") +public void setServerUrl(String url)+
public String getServerUrl()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_ApplyRegression.html b/apidocs/gate/plugin/learningframework/LF_ApplyRegression.html new file mode 100644 index 0000000..683f7f5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_ApplyRegression.html @@ -0,0 +1,676 @@ + + + + + + +@CreoleResource(name="LF_ApplyRegression", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyRegression", + comment="Apply a trained regression model to documents") +public class LF_ApplyRegression +extends LearningFrameworkPRBase+
+ Training, evaluation and application of ML in GATE.
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
protected String |
+outputASName |
+
protected String |
+targetFeature |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_ApplyRegression() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
URL |
+getDataDirectory() |
+
String |
+getOutputASName() |
+
String |
+getServerUrl() |
+
String |
+getTargetFeature() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setDataDirectory(URL output) |
+
void |
+setOutputASName(String oasn) |
+
void |
+setServerUrl(String url) |
+
void |
+setTargetFeature(String name) |
+
controllerFinished, getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected String outputASName+
protected String targetFeature+
@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="If identical to the input AS, existing annotations are updated", + defaultValue="LearningFramework") +public void setOutputASName(String oasn)+
public String getOutputASName()+
@RunTime + @Optional + @CreoleParameter(comment="Name of class feature to add to the original instance annotations", + defaultValue="") +public void setTargetFeature(String name)+
public String getTargetFeature()+
@RunTime + @Optional + @CreoleParameter(comment="Classify from a server instead of a stored model") +public void setServerUrl(String url)+
public String getServerUrl()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_ApplyTopicModel.html b/apidocs/gate/plugin/learningframework/LF_ApplyTopicModel.html new file mode 100644 index 0000000..22f9c8b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_ApplyTopicModel.html @@ -0,0 +1,650 @@ + + + + + + +@CreoleResource(name="LF_ApplyTopicModel", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyTopicModel", + comment="Apply a trained topic model to document annotations") +public class LF_ApplyTopicModel +extends LearningFrameworkPRBase+
+ Training, evaluation and application of ML in GATE.
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_ApplyTopicModel() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
URL |
+getDataDirectory() |
+
String |
+getFeaturePrefix() |
+
String |
+getTokenAnnotationType() |
+
String |
+getTokenFeature() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setDataDirectory(URL output) |
+
void |
+setFeaturePrefix(String val) |
+
void |
+setTokenAnnotationType(String val) |
+
void |
+setTokenFeature(String val) |
+
controllerFinished, getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterrupted@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @CreoleParameter(comment="The annotation type representing the words/tokens to use", + defaultValue="Token") +public void setTokenAnnotationType(String val)+
public String getTokenAnnotationType()+
@RunTime + @Optional + @CreoleParameter(comment="The feature containing the token string to use, if empty, use document content", + defaultValue="string") +public void setTokenFeature(String val)+
public String getTokenFeature()+
@RunTime + @Optional + @CreoleParameter(comment="Prefix of the feature names written to the instance annotations", + defaultValue="LDA_") +public void setFeaturePrefix(String val)+
public String getFeaturePrefix()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_EvaluateClassification.html b/apidocs/gate/plugin/learningframework/LF_EvaluateClassification.html new file mode 100644 index 0000000..753d155 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_EvaluateClassification.html @@ -0,0 +1,993 @@ + + + + + + +@CreoleResource(name="LF_EvaluateClassification", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_EvaluateClassification", + comment="Evaluate an algorithm and parameter settings for classification") +public class LF_EvaluateClassification +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+classAnnotationType |
+
protected EvaluationMethod |
+evaluationMethod |
+
protected String |
+instanceWeightFeature |
+
protected int |
+numberOfFolds |
+
protected int |
+numberOfRepeats |
+
protected ScalingMethod |
+scaleFeatures |
+
protected String |
+sequenceSpan |
+
protected String |
+targetFeature |
+
protected double |
+trainingFraction |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_EvaluateClassification() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
String |
+getClassAnnotationType() |
+
EvaluationMethod |
+getEvaluationMethod() |
+
URL |
+getFeatureSpecURL() |
+
String |
+getInstanceWeightFeature() |
+
Integer |
+getNumberOfFolds() |
+
Integer |
+getNumberOfRepeats() |
+
ScalingMethod |
+getScaleFeatures() |
+
String |
+getSequenceSpan() |
+
String |
+getTargetFeature() |
+
AlgorithmClassification |
+getTrainingAlgorithm() |
+
Double |
+getTrainingFraction() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setClassAnnotationType(String classType) |
+
void |
+setEvaluationMethod(EvaluationMethod val) |
+
void |
+setFeatureSpecURL(URL featureSpecURL) |
+
void |
+setInstanceWeightFeature(String val) |
+
void |
+setNumberOfFolds(Integer val) |
+
void |
+setNumberOfRepeats(Integer val) |
+
void |
+setScaleFeatures(ScalingMethod sf) |
+
void |
+setSequenceSpan(String seq) |
+
void |
+setTargetFeature(String classFeature) |
+
void |
+setTrainingAlgorithm(AlgorithmClassification algo) |
+
void |
+setTrainingFraction(Double val) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected ScalingMethod scaleFeatures+
protected String targetFeature+
protected String sequenceSpan+
protected EvaluationMethod evaluationMethod+
protected int numberOfFolds+
protected double trainingFraction+
protected int numberOfRepeats+
protected String classAnnotationType+
protected String instanceWeightFeature+
public LF_EvaluateClassification()+
@RunTime + @CreoleParameter(comment="The feature specification file.") +public void setFeatureSpecURL(URL featureSpecURL)+
public URL getFeatureSpecURL()+
@RunTime + @Optional + @CreoleParameter(comment="The algorithm to be used for training the classifier") +public void setTrainingAlgorithm(AlgorithmClassification algo)+
public AlgorithmClassification getTrainingAlgorithm()+
@RunTime + @CreoleParameter(defaultValue="NONE", + comment="If and how to scale features. ") +public void setScaleFeatures(ScalingMethod sf)+
public ScalingMethod getScaleFeatures()+
@RunTime + @Optional + @CreoleParameter(comment="The feature containing the class label") +public void setTargetFeature(String classFeature)+
public String getTargetFeature()+
@RunTime + @Optional + @CreoleParameter(comment="For sequence learners, an annotation type defining a meaningful sequence span. Ignored by non-sequence learners.") +public void setSequenceSpan(String seq)+
public String getSequenceSpan()+
@RunTime + @Optional + @CreoleParameter(comment="Evaluation Method, not all algorithms may support all methods", + defaultValue="CROSSVALIDATION") +public void setEvaluationMethod(EvaluationMethod val)+
public EvaluationMethod getEvaluationMethod()+
@RunTime + @Optional + @CreoleParameter(comment="Number of folds for the cross validation", + defaultValue="10") +public void setNumberOfFolds(Integer val)+
public Integer getNumberOfFolds()+
@RunTime + @Optional + @CreoleParameter(comment="Fraction of instances to use for training, > 0.0 and < 1.0", + defaultValue="0.6667") +public void setTrainingFraction(Double val)+
public Double getTrainingFraction()+
@RunTime + @Optional + @CreoleParameter(comment="Number of times to perform holdout evaluation to get an average", + defaultValue="1") +public void setNumberOfRepeats(Integer val)+
public Integer getNumberOfRepeats()+
@RunTime + @Optional + @CreoleParameter(comment="Annotation type containing/indicating the class.") +public void setClassAnnotationType(String classType)+
public String getClassAnnotationType()+
@RunTime + @Optional + @CreoleParameter(comment="The feature that constains the instance weight. If empty, no instance weights are used", + defaultValue="") +public void setInstanceWeightFeature(String val)+
public String getInstanceWeightFeature()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_EvaluateRegression.html b/apidocs/gate/plugin/learningframework/LF_EvaluateRegression.html new file mode 100644 index 0000000..aaddd58 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_EvaluateRegression.html @@ -0,0 +1,922 @@ + + + + + + +@CreoleResource(name="LF_EvaluateRegression", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_EvaluateRegression", + comment="Evaluate an algorithm and parameter settings for regression") +public class LF_EvaluateRegression +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected EvaluationMethod |
+evaluationMethod |
+
protected String |
+instanceWeightFeature |
+
protected int |
+numberOfFolds |
+
protected int |
+numberOfRepeats |
+
protected ScalingMethod |
+scaleFeatures |
+
protected String |
+sequenceSpan |
+
protected String |
+targetFeature |
+
protected double |
+trainingFraction |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_EvaluateRegression() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
EvaluationMethod |
+getEvaluationMethod() |
+
URL |
+getFeatureSpecURL() |
+
String |
+getInstanceWeightFeature() |
+
Integer |
+getNumberOfFolds() |
+
Integer |
+getNumberOfRepeats() |
+
ScalingMethod |
+getScaleFeatures() |
+
String |
+getTargetFeature() |
+
AlgorithmRegression |
+getTrainingAlgorithm() |
+
Double |
+getTrainingFraction() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setEvaluationMethod(EvaluationMethod val) |
+
void |
+setFeatureSpecURL(URL featureSpecURL) |
+
void |
+setInstanceWeightFeature(String val) |
+
void |
+setNumberOfFolds(Integer val) |
+
void |
+setNumberOfRepeats(Integer val) |
+
void |
+setScaleFeatures(ScalingMethod sf) |
+
void |
+setTargetFeature(String targetFeature) |
+
void |
+setTrainingAlgorithm(AlgorithmRegression algo) |
+
void |
+setTrainingFraction(Double val) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected ScalingMethod scaleFeatures+
protected String targetFeature+
protected String sequenceSpan+
protected EvaluationMethod evaluationMethod+
protected int numberOfFolds+
protected double trainingFraction+
protected int numberOfRepeats+
protected String instanceWeightFeature+
@RunTime + @CreoleParameter(comment="The feature specification file.") +public void setFeatureSpecURL(URL featureSpecURL)+
public URL getFeatureSpecURL()+
@RunTime + @Optional + @CreoleParameter(comment="The algorithm to be used for training the classifier") +public void setTrainingAlgorithm(AlgorithmRegression algo)+
public AlgorithmRegression getTrainingAlgorithm()+
@RunTime + @CreoleParameter(defaultValue="NONE", + comment="If and how to scale features. ") +public void setScaleFeatures(ScalingMethod sf)+
public ScalingMethod getScaleFeatures()+
@RunTime + @Optional + @CreoleParameter(comment="The feature containing the target label") +public void setTargetFeature(String targetFeature)+
public String getTargetFeature()+
@RunTime + @Optional + @CreoleParameter(comment="Evaluation Method, not all algorithms may support all methods", + defaultValue="CROSSVALIDATION") +public void setEvaluationMethod(EvaluationMethod val)+
public EvaluationMethod getEvaluationMethod()+
@RunTime + @Optional + @CreoleParameter(comment="Number of folds for the cross validation", + defaultValue="10") +public void setNumberOfFolds(Integer val)+
public Integer getNumberOfFolds()+
@RunTime + @Optional + @CreoleParameter(comment="Fraction of instances to use for training, > 0.0 and < 1.0", + defaultValue="0.6667") +public void setTrainingFraction(Double val)+
public Double getTrainingFraction()+
@RunTime + @Optional + @CreoleParameter(comment="Number of times to perform holdout evaluation to get an average", + defaultValue="1") +public void setNumberOfRepeats(Integer val)+
public Integer getNumberOfRepeats()+
@RunTime + @Optional + @CreoleParameter(comment="The feature that constains the instance weight. If empty, no instance weights are used", + defaultValue="") +public void setInstanceWeightFeature(String val)+
public String getInstanceWeightFeature()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_Export.html b/apidocs/gate/plugin/learningframework/LF_Export.html new file mode 100644 index 0000000..c7ab9b6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_Export.html @@ -0,0 +1,960 @@ + + + + + + +@CreoleResource(name="LF_Export", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_Export", + comment="Export training instances in various formats for external training and analysis") +public class LF_Export +extends LF_ExportBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected List<String> |
+classAnnotationTypes |
+
protected Set<String> |
+classAnnotationTypesSet |
+
protected URL |
+dataDirectory |
+
protected String |
+instanceWeightFeature |
+
protected ScalingMethod |
+scaleFeatures |
+
protected String |
+sequenceSpan |
+
protected String |
+targetFeature |
+
protected TargetType |
+targetType |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
List<String> |
+getClassAnnotationTypes() |
+
URL |
+getDataDirectory() |
+
Exporter |
+getExporter() |
+
URL |
+getFeatureSpecURL() |
+
String |
+getInstanceWeightFeature() |
+
ScalingMethod |
+getScaleFeatures() |
+
SeqEncoderEnum |
+getSeqEncoder() |
+
String |
+getSequenceSpan() |
+
String |
+getTargetFeature() |
+
TargetType |
+getTargetType() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setClassAnnotationTypes(List<String> classTypes) |
+
void |
+setDataDirectory(URL output) |
+
void |
+setExporter(Exporter value) |
+
void |
+setFeatureSpecURL(URL featureSpecURL) |
+
void |
+setInstanceWeightFeature(String val) |
+
void |
+setScaleFeatures(ScalingMethod sf) |
+
void |
+setSeqEncoder(SeqEncoderEnum val)
+The sequence to classification algorithm to use.
+ |
+
void |
+setSequenceSpan(String seq) |
+
void |
+setTargetFeature(String classFeature) |
+
void |
+setTargetType(TargetType val) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected String instanceWeightFeature+
protected ScalingMethod scaleFeatures+
protected String targetFeature+
protected TargetType targetType+
protected String sequenceSpan+
@RunTime + @Optional + @CreoleParameter(comment="The directory where all data will be stored and read from (default is current dir of Java process)") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="The feature that constains the instance weight. If empty, no instance weights are used", + defaultValue="") +public void setInstanceWeightFeature(String val)+
public String getInstanceWeightFeature()+
@RunTime + @CreoleParameter(comment="The feature specification file.") +public void setFeatureSpecURL(URL featureSpecURL)+
public URL getFeatureSpecURL()+
@RunTime + @Optional + @CreoleParameter(defaultValue="NONE", + comment="If and how to scale features. ") +public void setScaleFeatures(ScalingMethod sf)+
public ScalingMethod getScaleFeatures()+
@RunTime + @Optional + @CreoleParameter(comment="If specified, export as classification or regression problem") +public void setTargetFeature(String classFeature)+
public String getTargetFeature()+
@RunTime + @Optional + @CreoleParameter(comment="If specified, annotation types which indicate the class for sequence tagging") +public void setClassAnnotationTypes(List<String> classTypes)+
@RunTime + @Optional + @CreoleParameter(comment="Target type: classification or regression problem?", + defaultValue="NOMINAL") +public void setTargetType(TargetType val)+
public TargetType getTargetType()+
@RunTime + @Optional + @CreoleParameter(comment="Sequence tagging export is not yet supported") +public void setSequenceSpan(String seq)+
public String getSequenceSpan()+
@RunTime + @CreoleParameter(comment="Export format, some formats allow finer configuration via the algorithmParameters") +public void setExporter(Exporter value)+
public Exporter getExporter()+
@RunTime + @Optional + @CreoleParameter(comment="The sequence to classification algorithm to use.") +public void setSeqEncoder(SeqEncoderEnum val)+
val - which sequence encoder to usepublic SeqEncoderEnum getSeqEncoder()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_ExportBase.html b/apidocs/gate/plugin/learningframework/LF_ExportBase.html new file mode 100644 index 0000000..5bedb24 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_ExportBase.html @@ -0,0 +1,434 @@ + + + + + + +public abstract class LF_ExportBase +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListeneralgorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_ExportBase() |
+
controllerFinished, getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, controllerStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, process, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_ExportText.html b/apidocs/gate/plugin/learningframework/LF_ExportText.html new file mode 100644 index 0000000..598afe1 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_ExportText.html @@ -0,0 +1,884 @@ + + + + + + +@CreoleResource(name="LF_ExportText", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_ExportText", + comment="Simple exporter for text-only formats, no fancy features") +public class LF_ExportText +extends AbstractDocumentProcessor+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+containingAnnotation |
+
protected URL |
+dataDirectory |
+
protected Boolean |
+includeDocumentId |
+
protected String |
+inputASName |
+
protected String |
+targetFeature |
+
protected String |
+tokenAnnotation |
+
protected String |
+tokenFeature |
+
controller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_ExportText() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
String |
+getContainingAnnotation() |
+
URL |
+getDataDirectory() |
+
ExporterText |
+getExporter() |
+
Boolean |
+getIncludeDocumentId() |
+
String |
+getInputASName() |
+
String |
+getTargetFeature() |
+
String |
+getTokenAnnotation() |
+
String |
+getTokenFeature() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
protected void |
+processOne(long from,
+ long to,
+ gate.Annotation containing,
+ gate.AnnotationSet inputAS,
+ gate.Document doc) |
+
void |
+setContainingAnnotation(String val) |
+
void |
+setDataDirectory(URL output) |
+
void |
+setExporter(ExporterText value) |
+
void |
+setIncludeDocumentId(Boolean val) |
+
void |
+setInputASName(String iasn) |
+
void |
+setTargetFeature(String classFeature) |
+
void |
+setTokenAnnotation(String val) |
+
void |
+setTokenFeature(String val) |
+
benchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected String inputASName+
protected String containingAnnotation+
protected String tokenAnnotation+
protected Boolean includeDocumentId+
protected String tokenFeature+
protected String targetFeature+
@RunTime + @Optional + @CreoleParameter(comment="Input annotation set, empty means default set", + defaultValue="") +public void setInputASName(String iasn)+
public String getInputASName()+
@RunTime + @Optional + @CreoleParameter(comment="The directory where the exported data file or files will be stored") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="If specified, each containing annotation identifies a document or sequence") +public void setContainingAnnotation(String val)+
public String getContainingAnnotation()+
@RunTime + @Optional + @CreoleParameter(comment="The annotation where the text comes from, if not specified, document content", + defaultValue="Token") +public void setTokenAnnotation(String val)+
public String getTokenAnnotation()+
@RunTime + @Optional + @CreoleParameter(comment="If true, the first field is a document/sequence name/id", + defaultValue="false") +public void setIncludeDocumentId(Boolean val)+
public Boolean getIncludeDocumentId()+
@RunTime + @Optional + @CreoleParameter(comment="If specified, use feature, otherwise covered document", + defaultValue="string") +public void setTokenFeature(String val)+
public String getTokenFeature()+
@RunTime + @Optional + @CreoleParameter(comment="If specified, export a target field, otherwise, text only", + defaultValue="") +public void setTargetFeature(String classFeature)+
public String getTargetFeature()+
@RunTime + @CreoleParameter(comment="Export format, some formats allow finer configuration via the algorithmParameters") +public void setExporter(ExporterText value)+
public ExporterText getExporter()+
protected void processOne(long from, + long to, + gate.Annotation containing, + gate.AnnotationSet inputAS, + gate.Document doc)+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class AbstractDocumentProcessorarg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_GenFeatures_Affixes.html b/apidocs/gate/plugin/learningframework/LF_GenFeatures_Affixes.html new file mode 100644 index 0000000..37e9857 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_GenFeatures_Affixes.html @@ -0,0 +1,1179 @@ + + + + + + +@CreoleResource(name="LF_GenFeatures_Affixes", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_GenFeatures_Affixes", + comment="Generate features: prefixes and suffixes") +public class LF_GenFeatures_Affixes +extends AbstractDocumentProcessor+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected Boolean |
+genPrefixes |
+
protected Boolean |
+genSuffixes |
+
protected String |
+inputASName |
+
protected String |
+instanceType |
+
protected String |
+mappingLanguage |
+
protected Locale |
+mappingLocale |
+
protected Boolean |
+mapToUpper |
+
protected Integer |
+maxPrefixLength |
+
protected Integer |
+maxSuffixLength |
+
protected Integer |
+minNonPrefixLength |
+
protected Integer |
+minNonSuffixLength |
+
protected Integer |
+minPrefixLength |
+
protected Integer |
+minSuffixLength |
+
protected String |
+prefixFeatureName |
+
protected String |
+stringFeature |
+
protected String |
+suffixFeatureName |
+
controller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_GenFeatures_Affixes() |
+
benchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected Boolean genPrefixes+
protected String prefixFeatureName+
protected Integer minPrefixLength+
protected Integer maxPrefixLength+
protected Integer minNonPrefixLength+
protected Boolean genSuffixes+
protected String suffixFeatureName+
protected Integer minSuffixLength+
protected Integer maxSuffixLength+
protected Integer minNonSuffixLength+
protected String inputASName+
protected String instanceType+
protected String stringFeature+
protected Boolean mapToUpper+
protected String mappingLanguage+
protected Locale mappingLocale+
public LF_GenFeatures_Affixes()+
@RunTime + @CreoleParameter(comment="If prefixes should get generated", + defaultValue="false") +public void setGenPrefixes(Boolean val)+
public Boolean getGenPrefixes()+
@RunTime + @CreoleParameter(comment="The name pattern to use for the feature names for prefixes", + defaultValue="pref") +public void setPrefixFeatureName(String val)+
public String getPrefixFeatureName()+
@RunTime + @CreoleParameter(comment="Minimum number of characters of a prefix to get generated", + defaultValue="2") +public void setMinPrefixLength(Integer val)+
public Integer getMinPrefixLength()+
@RunTime + @CreoleParameter(comment="Maximum number of characters of a prefix to get generated", + defaultValue="4") +public void setMaxPrefixLength(Integer val)+
public Integer getMaxPrefixLength()+
@RunTime + @CreoleParameter(comment="Minimum number of non prefix characters that must remain for a prefix to get generated", + defaultValue="2") +public void setMinNonPrefixLength(Integer val)+
public Integer getMinNonPrefixLength()+
@RunTime + @CreoleParameter(comment="If suffixes should get generated", + defaultValue="false") +public void setGenSuffixes(Boolean val)+
public Boolean getGenSuffixes()+
@RunTime + @CreoleParameter(comment="The name pattern to use for the feature names for suffixes", + defaultValue="suf") +public void setSuffixFeatureName(String val)+
public String getSuffixFeatureName()+
@RunTime + @CreoleParameter(comment="Minimum number of characters of a suffix to get generated", + defaultValue="2") +public void setMinSuffixLength(Integer val)+
public Integer getMinSuffixLength()+
@RunTime + @CreoleParameter(comment="Maximum number of characters of a suffix to get generated", + defaultValue="4") +public void setMaxSuffixLength(Integer val)+
public Integer getMaxSuffixLength()+
@RunTime + @CreoleParameter(comment="Minimum number of non suffix characters that must remain for a suffix to get generated", + defaultValue="2") +public void setMinNonSuffixLength(Integer val)+
public Integer getMinNonSuffixLength()+
@RunTime + @Optional + @CreoleParameter +public void setInputASName(String iasn)+
public String getInputASName()+
@RunTime + @CreoleParameter(defaultValue="Token", + comment="The annotation type to be treated as instance.") +public void setInstanceType(String inst)+
public String getInstanceType()+
@RunTime + @Optional + @CreoleParameter(defaultValue="", + comment="Where to take the word string from, empty means underlying document string") +public void setStringFeature(String val)+
public String getStringFeature()+
@RunTime + @CreoleParameter(defaultValue="false", + comment="Fals: Use original string, true: first map to all upper case") +public void setMapToUpper(Boolean val)+
public Boolean getMapToUpper()+
@RunTime + @Optional + @CreoleParameter(comment="Language to use for mapping to upper case, if empty, use system setting", + defaultValue="en") +public void setMappingLanguage(String val)+
public String getMappingLanguage()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller ctrl, + Throwable thrw)+
AbstractDocumentProcessorcontrollerFinished in class AbstractDocumentProcessorctrl - the controller instancethrw - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_GenFeatures_Misc.html b/apidocs/gate/plugin/learningframework/LF_GenFeatures_Misc.html new file mode 100644 index 0000000..3e9eae0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_GenFeatures_Misc.html @@ -0,0 +1,745 @@ + + + + + + +@CreoleResource(name="LF_GenFeatures_Misc", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_GenFeatures_Misc", + comment="Generate various kinds of features") +public class LF_GenFeatures_Misc +extends AbstractDocumentProcessor+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected Boolean |
+genWordShape |
+
protected Boolean |
+genWordShapeShort |
+
protected String |
+inputASName |
+
protected String |
+instanceType |
+
protected String |
+stringFeature |
+
controller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_GenFeatures_Misc() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
Boolean |
+getGenWordShape() |
+
Boolean |
+getGenWordShapeShort() |
+
String |
+getInputASName() |
+
String |
+getInstanceType() |
+
String |
+getStringFeature() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setGenWordShape(Boolean val) |
+
void |
+setGenWordShapeShort(Boolean val) |
+
void |
+setInputASName(String iasn) |
+
void |
+setInstanceType(String inst) |
+
void |
+setStringFeature(String val) |
+
benchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected Boolean genWordShape+
protected Boolean genWordShapeShort+
protected String inputASName+
protected String instanceType+
protected String stringFeature+
@RunTime + @CreoleParameter(comment="Generate word shape", + defaultValue="false") +public void setGenWordShape(Boolean val)+
public Boolean getGenWordShape()+
@RunTime + @CreoleParameter(comment="Generate short word shape", + defaultValue="true") +public void setGenWordShapeShort(Boolean val)+
public Boolean getGenWordShapeShort()+
@RunTime + @Optional + @CreoleParameter +public void setInputASName(String iasn)+
public String getInputASName()+
@RunTime + @CreoleParameter(defaultValue="Token", + comment="The annotation type to be treated as instance.") +public void setInstanceType(String inst)+
public String getInstanceType()+
@RunTime + @Optional + @CreoleParameter(defaultValue="", + comment="Where to take the word string from, empty means underlying document string") +public void setStringFeature(String val)+
public String getStringFeature()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class AbstractDocumentProcessorarg0 - the controller instancet - the Throwable indicating the error or null for normal completionpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_TrainChunking.html b/apidocs/gate/plugin/learningframework/LF_TrainChunking.html new file mode 100644 index 0000000..4bfc474 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_TrainChunking.html @@ -0,0 +1,827 @@ + + + + + + +@CreoleResource(name="LF_TrainChunking", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_TrainChunking", + comment="Train a machine learning model for chunking") +public class LF_TrainChunking +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected List<String> |
+classAnnotationTypes |
+
protected Set<String> |
+classAnnotationTypesSet |
+
protected URL |
+dataDirectory |
+
protected ScalingMethod |
+scaleFeatures |
+
protected String |
+sequenceSpan |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_TrainChunking() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
List<String> |
+getClassAnnotationTypes() |
+
URL |
+getDataDirectory() |
+
URL |
+getFeatureSpecURL() |
+
ScalingMethod |
+getScaleFeatures() |
+
SeqEncoderEnum |
+getSeqEncoder() |
+
String |
+getSequenceSpan() |
+
AlgorithmClassification |
+getTrainingAlgorithm() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setClassAnnotationTypes(List<String> classTypes) |
+
void |
+setDataDirectory(URL output) |
+
void |
+setFeatureSpecURL(URL featureSpecURL) |
+
void |
+setScaleFeatures(ScalingMethod sf) |
+
void |
+setSeqEncoder(SeqEncoderEnum val)
+The algorithm to create classification labels from chunks to use.
+ |
+
void |
+setSequenceSpan(String seq) |
+
void |
+setTrainingAlgorithm(AlgorithmClassification algo) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected ScalingMethod scaleFeatures+
protected String sequenceSpan+
@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="The feature specification file.") +public void setFeatureSpecURL(URL featureSpecURL)+
public URL getFeatureSpecURL()+
@RunTime + @Optional + @CreoleParameter(comment="The algorithm to be used for training.") +public void setTrainingAlgorithm(AlgorithmClassification algo)+
public AlgorithmClassification getTrainingAlgorithm()+
@RunTime + @Optional + @CreoleParameter(comment="The sequence to classification algorithm to use.", + defaultValue="BIO") +public void setSeqEncoder(SeqEncoderEnum val)+
val - One of the pre-defined enumspublic SeqEncoderEnum getSeqEncoder()+
@RunTime + @CreoleParameter(defaultValue="NONE", + comment="If and how to scale features. ") +public void setScaleFeatures(ScalingMethod sf)+
public ScalingMethod getScaleFeatures()+
@RunTime + @Optional + @CreoleParameter(comment="For sequence learners, an annotation type defining a meaningful sequence span. Ignored by non-sequence learners.") +public void setSequenceSpan(String seq)+
public String getSequenceSpan()+
@RunTime + @CreoleParameter(comment="Annotation types which indicate the class, at least one required.") +public void setClassAnnotationTypes(List<String> classTypes)+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_TrainClassification.html b/apidocs/gate/plugin/learningframework/LF_TrainClassification.html new file mode 100644 index 0000000..2f6ae58 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_TrainClassification.html @@ -0,0 +1,821 @@ + + + + + + +@CreoleResource(name="LF_TrainClassification", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_TrainClassification", + comment="Train a machine learning model for classification") +public class LF_TrainClassification +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
protected String |
+instanceWeightFeature |
+
protected ScalingMethod |
+scaleFeatures |
+
protected String |
+sequenceSpan |
+
protected String |
+targetFeature |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_TrainClassification() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
URL |
+getDataDirectory() |
+
URL |
+getFeatureSpecURL() |
+
String |
+getInstanceWeightFeature() |
+
ScalingMethod |
+getScaleFeatures() |
+
String |
+getSequenceSpan() |
+
String |
+getTargetFeature() |
+
AlgorithmClassification |
+getTrainingAlgorithm() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setDataDirectory(URL output) |
+
void |
+setFeatureSpecURL(URL featureSpecURL) |
+
void |
+setInstanceWeightFeature(String val) |
+
void |
+setScaleFeatures(ScalingMethod sf) |
+
void |
+setSequenceSpan(String seq) |
+
void |
+setTargetFeature(String classFeature) |
+
void |
+setTrainingAlgorithm(AlgorithmClassification algo) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected String instanceWeightFeature+
protected ScalingMethod scaleFeatures+
protected String targetFeature+
protected String sequenceSpan+
public LF_TrainClassification()+
@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="The feature that constains the instance weight. If empty, no instance weights are used", + defaultValue="") +public void setInstanceWeightFeature(String val)+
public String getInstanceWeightFeature()+
@RunTime + @Optional + @CreoleParameter(comment="The feature specification file. If empty, only use [InstanceAnnotation].string") +public void setFeatureSpecURL(URL featureSpecURL)+
public URL getFeatureSpecURL()+
@RunTime + @Optional + @CreoleParameter(comment="The algorithm to be used for training the classifier") +public void setTrainingAlgorithm(AlgorithmClassification algo)+
public AlgorithmClassification getTrainingAlgorithm()+
@RunTime + @CreoleParameter(defaultValue="NONE", + comment="If and how to scale features. ") +public void setScaleFeatures(ScalingMethod sf)+
public ScalingMethod getScaleFeatures()+
@RunTime + @Optional + @CreoleParameter(comment="The feature containing the class label") +public void setTargetFeature(String classFeature)+
public String getTargetFeature()+
@RunTime + @Optional + @CreoleParameter(comment="For sequence learners, an annotation type defining a meaningful sequence span. Ignored by non-sequence learners.") +public void setSequenceSpan(String seq)+
public String getSequenceSpan()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_TrainRegression.html b/apidocs/gate/plugin/learningframework/LF_TrainRegression.html new file mode 100644 index 0000000..e054283 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_TrainRegression.html @@ -0,0 +1,778 @@ + + + + + + +@CreoleResource(name="LF_TrainRegression", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_TrainRegression", + comment="Train a machine learning model for regression") +public class LF_TrainRegression +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
protected String |
+instanceWeightFeature |
+
protected ScalingMethod |
+scaleFeatures |
+
protected String |
+targetFeature |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_TrainRegression() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
URL |
+getDataDirectory() |
+
URL |
+getFeatureSpecURL() |
+
String |
+getInstanceWeightFeature() |
+
ScalingMethod |
+getScaleFeatures() |
+
String |
+getTargetFeature() |
+
AlgorithmRegression |
+getTrainingAlgorithm() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setDataDirectory(URL output) |
+
void |
+setFeatureSpecURL(URL featureSpecURL) |
+
void |
+setInstanceWeightFeature(String val) |
+
void |
+setScaleFeatures(ScalingMethod sf) |
+
void |
+setTargetFeature(String classFeature) |
+
void |
+setTrainingAlgorithm(AlgorithmRegression algo) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected URL dataDirectory+
protected String instanceWeightFeature+
protected ScalingMethod scaleFeatures+
protected String targetFeature+
@RunTime + @CreoleParameter(comment="The directory where all data will be stored and read from") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @Optional + @CreoleParameter(comment="The feature that constains the instance weight. If empty, no instance weights are used", + defaultValue="") +public void setInstanceWeightFeature(String val)+
public String getInstanceWeightFeature()+
@RunTime + @CreoleParameter(comment="The feature specification file.") +public void setFeatureSpecURL(URL featureSpecURL)+
public URL getFeatureSpecURL()+
@RunTime + @Optional + @CreoleParameter(comment="The algorithm to be used for training.") +public void setTrainingAlgorithm(AlgorithmRegression algo)+
public AlgorithmRegression getTrainingAlgorithm()+
@RunTime + @CreoleParameter(defaultValue="NONE", + comment="If and how to scale features. ") +public void setScaleFeatures(ScalingMethod sf)+
public ScalingMethod getScaleFeatures()+
@RunTime + @Optional + @CreoleParameter(comment="The feature containing the target value") +public void setTargetFeature(String classFeature)+
public String getTargetFeature()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LF_TrainTopicModel.html b/apidocs/gate/plugin/learningframework/LF_TrainTopicModel.html new file mode 100644 index 0000000..1b36581 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LF_TrainTopicModel.html @@ -0,0 +1,742 @@ + + + + + + +@CreoleResource(name="LF_TrainTopicModel", + helpURL="https://gatenlp.github.io/gateplugin-LearningFramework/LF_TrainTopicModel", + comment="Train a topic model") +public class LF_TrainTopicModel +extends LearningFrameworkPRBase+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected URL |
+dataDirectory |
+
algorithmParameters, algorithmParamtersChanged, inputASName, instanceTypecontroller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LF_TrainTopicModel() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller arg0,
+ Throwable t)
+Callback for when each controller finishes on a corpus.
+ |
+
void |
+controllerStarted(gate.Controller controller)
+Callback for when each controller gets started on a corpus.
+ |
+
Boolean |
+getApplyAfterTraining() |
+
URL |
+getDataDirectory() |
+
String |
+getFeaturePrefix() |
+
String |
+getTokenAnnotationType() |
+
String |
+getTokenFeature() |
+
AlgorithmClustering |
+getTrainingAlgorithm() |
+
void |
+process(gate.Document doc)
+The new method to implement by PRs which derive from this class.
+ |
+
void |
+setApplyAfterTraining(Boolean val) |
+
void |
+setDataDirectory(URL output) |
+
void |
+setFeaturePrefix(String val) |
+
void |
+setTokenAnnotationType(String val) |
+
void |
+setTokenFeature(String val) |
+
void |
+setTrainingAlgorithm(AlgorithmClustering algo) |
+
getAlgorithmParameters, getAlgorithmParametersIsChanged, getInputASName, getInstanceType, setAlgorithmParameters, setInputASName, setInstanceTypebenchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterrupted@RunTime + @Optional + @CreoleParameter(comment="The directory where all data will be stored and read from, if not specified, uses current running directory") +public void setDataDirectory(URL output)+
public URL getDataDirectory()+
@RunTime + @CreoleParameter(comment="The annotation type representing the words/tokens to use", + defaultValue="Token") +public void setTokenAnnotationType(String val)+
public String getTokenAnnotationType()+
@RunTime + @Optional + @CreoleParameter(comment="The feature containing the token string to use, if empty, use document content", + defaultValue="string") +public void setTokenFeature(String val)+
public String getTokenFeature()+
@RunTime + @Optional + @CreoleParameter(comment="The topic modeling algorithm to be used for training.") +public void setTrainingAlgorithm(AlgorithmClustering algo)+
public AlgorithmClustering getTrainingAlgorithm()+
@RunTime + @CreoleParameter(comment="After training the model, calculate and apply topic distributions to the training documents", + defaultValue="false") +public void setApplyAfterTraining(Boolean val)+
public Boolean getApplyAfterTraining()+
@RunTime + @Optional + @CreoleParameter(comment="Prefix of the feature names written to the instance annotations", + defaultValue="LDA_") +public void setFeaturePrefix(String val)+
public String getFeaturePrefix()+
public void process(gate.Document doc)+
AbstractDocumentProcessorprocess in class AbstractDocumentProcessordoc - the document to get processedpublic void controllerStarted(gate.Controller controller)+
AbstractDocumentProcessorcontrollerStarted in class AbstractDocumentProcessorcontroller - the controller instancepublic void controllerFinished(gate.Controller arg0, + Throwable t)+
AbstractDocumentProcessorcontrollerFinished in class LearningFrameworkPRBasearg0 - the controller instancet - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/LearningFrameworkPRBase.html b/apidocs/gate/plugin/learningframework/LearningFrameworkPRBase.html new file mode 100644 index 0000000..1a3bc35 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/LearningFrameworkPRBase.html @@ -0,0 +1,637 @@ + + + + + + +public abstract class LearningFrameworkPRBase +extends AbstractDocumentProcessor+
gate.creole.AbstractProcessingResource.InternalStatusListener, gate.creole.AbstractProcessingResource.IntervalProgressListener| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+algorithmParameters |
+
protected boolean |
+algorithmParamtersChanged |
+
protected String |
+inputASName |
+
protected String |
+instanceType |
+
controller, duplicateId, lastError, nDuplicates, remainingDuplicates, seenDocuments, seenDocumentsThisDuplicate, sharedData, SYNC_OBJECT, syncObjectcorpus, documentinterruptednamefeaturesANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME| Constructor and Description | +
|---|
LearningFrameworkPRBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+controllerFinished(gate.Controller ctrl,
+ Throwable thrw)
+Callback for when each controller finishes on a corpus.
+ |
+
String |
+getAlgorithmParameters() |
+
boolean |
+getAlgorithmParametersIsChanged() |
+
String |
+getInputASName() |
+
String |
+getInstanceType() |
+
void |
+setAlgorithmParameters(String learnerParams) |
+
void |
+setInputASName(String iasn) |
+
void |
+setInstanceType(String inst) |
+
benchmarkCheckpoint, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, controllerStarted, execute, getBenchmarkId, getDuplicateId, getLastError, getNDuplicates, getRemainingDuplicates, getSeenDocuments, getSharedData, getSyncObject, init, process, setBenchmarkId, setLastError, setNDuplicates, setRemainingDuplicates, setSeenDocuments, setSharedData, setSyncObjectgetCorpus, getDocument, setCorpus, setDocumentaddProgressListener, addStatusListener, cleanup, fireProcessFinished, fireProgressChanged, fireStatusChanged, getRuntimeParameterValues, getRuntimeParameterValues, interrupt, isInterrupted, reInit, removeProgressListener, removeStatusListenercheckParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitreInitcleanup, getParameterValue, setParameterValue, setParameterValuesgetFeatures, setFeaturesgetName, setNameinterrupt, isInterruptedprotected String inputASName+
protected String instanceType+
protected String algorithmParameters+
protected boolean algorithmParamtersChanged+
public LearningFrameworkPRBase()+
@RunTime + @Optional + @CreoleParameter +public void setInputASName(String iasn)+
public String getInputASName()+
@RunTime + @Optional + @CreoleParameter(defaultValue="Token", + comment="The annotation type to be treated as instance. This is required for some algorithms.") +public void setInstanceType(String inst)+
public String getInstanceType()+
@RunTime + @Optional + @CreoleParameter(comment="Some of the learners take parameters. Parameters can be entered here. For example, the LibSVM supports parameters.", + defaultValue="") +public void setAlgorithmParameters(String learnerParams)+
public String getAlgorithmParameters()+
public boolean getAlgorithmParametersIsChanged()+
public void controllerFinished(gate.Controller ctrl, + Throwable thrw)+
AbstractDocumentProcessorcontrollerFinished in class AbstractDocumentProcessorctrl - the controller instancethrw - the Throwable indicating the error or null for normal completionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/ModelApplication.html b/apidocs/gate/plugin/learningframework/ModelApplication.html new file mode 100644 index 0000000..e8f349f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/ModelApplication.html @@ -0,0 +1,601 @@ + + + + + + +public class ModelApplication +extends Object+
| Constructor and Description | +
|---|
ModelApplication(gate.Annotation instance,
+ double targetAssigned) |
+
ModelApplication(gate.Annotation instance,
+ String classAssigned,
+ Double confidenceScore) |
+
ModelApplication(gate.Annotation instance,
+ String classAssigned,
+ Double confidenceScore,
+ Integer sequenceSpanID) |
+
ModelApplication(gate.Annotation instance,
+ String classAssigned,
+ Double confidenceScore,
+ List<String> classes,
+ List<Double> confidences) |
+
ModelApplication(gate.Annotation instance,
+ String classAssigned,
+ Double confidenceScore,
+ List<String> classes,
+ List<Double> confidences,
+ Integer sequenceSpanID) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+addSurroundingAnnotations(gate.AnnotationSet unused,
+ gate.AnnotationSet instanceAS,
+ gate.AnnotationSet outputAS,
+ String outputAnnType,
+ Double minConfidence,
+ SeqEncoder seqEncoder)
+From an annotation set with e.g.
+ |
+
static void |
+applyClassification(gate.Document doc,
+ List<ModelApplication> gcs,
+ String targetFeature,
+ gate.AnnotationSet outputAS,
+ Double minConfidence)
+Utility function to apply a list of ModelApplication to a document.
+ |
+
String |
+getClassAssigned() |
+
List<String> |
+getClassList() |
+
List<Double> |
+getConfidenceList() |
+
Double |
+getConfidenceScore() |
+
gate.Annotation |
+getInstance() |
+
Double |
+getNumericTargetAssigned() |
+
Integer |
+getSeqSpanID() |
+
boolean |
+isNumericTarget() |
+
void |
+setClassAssigned(String classAssigned) |
+
void |
+setConfidenceScore(Double confidenceScore) |
+
void |
+setInstance(gate.Annotation instance) |
+
void |
+setSeqSpanID(Integer sequenceSpanID) |
+
String |
+toString() |
+
public ModelApplication(gate.Annotation instance, + String classAssigned, + Double confidenceScore)+
public ModelApplication(gate.Annotation instance, + double targetAssigned)+
public ModelApplication(gate.Annotation instance, + String classAssigned, + Double confidenceScore, + List<String> classes, + List<Double> confidences)+
public ModelApplication(gate.Annotation instance, + String classAssigned, + Double confidenceScore, + Integer sequenceSpanID)+
public gate.Annotation getInstance()+
public void setInstance(gate.Annotation instance)+
public String getClassAssigned()+
public void setClassAssigned(String classAssigned)+
public Double getConfidenceScore()+
public void setConfidenceScore(Double confidenceScore)+
public Integer getSeqSpanID()+
public void setSeqSpanID(Integer sequenceSpanID)+
public boolean isNumericTarget()+
public Double getNumericTargetAssigned()+
public static void applyClassification(gate.Document doc, + List<ModelApplication> gcs, + String targetFeature, + gate.AnnotationSet outputAS, + Double minConfidence)+
doc - document where the classifications are carried out (only needed for logging)gcs - the list of classificationstargetFeature - the name of the target featureoutputAS - the annotation set where to place copies or null for updating existing annotationsminConfidence - the minimum confidence score a classification must havepublic static void addSurroundingAnnotations(gate.AnnotationSet unused, + gate.AnnotationSet instanceAS, + gate.AnnotationSet outputAS, + String outputAnnType, + Double minConfidence, + SeqEncoder seqEncoder)+
unused - currently unused, API will changeinstanceAS - instance annotation setoutputAS - output annotation setoutputAnnType - output annotation typeminConfidence - minimum confidence for making prediction, if null alwaysseqEncoder - sequence encoder instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/ScalingMethod.html b/apidocs/gate/plugin/learningframework/ScalingMethod.html new file mode 100644 index 0000000..25db72c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/ScalingMethod.html @@ -0,0 +1,355 @@ + + + + + + +public enum ScalingMethod +extends Enum<ScalingMethod>+
| Enum Constant and Description | +
|---|
MEANVARIANCE_ALL_FEATURES |
+
MINMAX_ALL_FEATURES |
+
NONE |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ScalingMethod |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ScalingMethod[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ScalingMethod NONE+
public static final ScalingMethod MEANVARIANCE_ALL_FEATURES+
public static final ScalingMethod MINMAX_ALL_FEATURES+
public static ScalingMethod[] values()+
+for (ScalingMethod c : ScalingMethod.values()) + System.out.println(c); +
public static ScalingMethod valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/AbstractDocumentProcessor.html b/apidocs/gate/plugin/learningframework/class-use/AbstractDocumentProcessor.html new file mode 100644 index 0000000..97ae8e1 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/AbstractDocumentProcessor.html @@ -0,0 +1,244 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LearningFrameworkPRBase
+Base class for all LearningFramework PRs providing the shared parameters.
+ |
+
class |
+LF_ApplyChunking
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_ApplyClassification
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_ApplyRegression
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_ApplyTopicModel
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_EvaluateClassification |
+
class |
+LF_EvaluateRegression |
+
class |
+LF_Export |
+
class |
+LF_ExportBase
+Base class for all Training classes, inherits from LF_Base.
+ |
+
class |
+LF_ExportText
+Very simple PR to export text only in ad-hoc formats.
+ |
+
class |
+LF_GenFeatures_Affixes |
+
class |
+LF_GenFeatures_Misc |
+
class |
+LF_TrainChunking |
+
class |
+LF_TrainClassification |
+
class |
+LF_TrainRegression |
+
class |
+LF_TrainTopicModel |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/EvaluationMethod.html b/apidocs/gate/plugin/learningframework/class-use/EvaluationMethod.html new file mode 100644 index 0000000..f8409d9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/EvaluationMethod.html @@ -0,0 +1,317 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected EvaluationMethod |
+LF_EvaluateRegression.evaluationMethod |
+
protected EvaluationMethod |
+LF_EvaluateClassification.evaluationMethod |
+
| Modifier and Type | +Method and Description | +
|---|---|
EvaluationMethod |
+LF_EvaluateRegression.getEvaluationMethod() |
+
EvaluationMethod |
+LF_EvaluateClassification.getEvaluationMethod() |
+
static EvaluationMethod |
+EvaluationMethod.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static EvaluationMethod[] |
+EvaluationMethod.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_EvaluateRegression.setEvaluationMethod(EvaluationMethod val) |
+
void |
+LF_EvaluateClassification.setEvaluationMethod(EvaluationMethod val) |
+
| Modifier and Type | +Method and Description | +
|---|---|
EvaluationResult |
+EngineMBSklearnBase.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineDVFileJson.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBPythonNetworksBase.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
abstract EvaluationResult |
+Engine.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBTopicsLDA.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBWekaWrapper.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBMalletClass.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineLibSVM.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats)
+Perform an evaluation.
+ |
+
EvaluationResult |
+EngineMBMalletSeq.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBServer.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/Globals.html b/apidocs/gate/plugin/learningframework/class-use/Globals.html new file mode 100644 index 0000000..f3e70b1 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/Globals.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LFUtils.html b/apidocs/gate/plugin/learningframework/class-use/LFUtils.html new file mode 100644 index 0000000..7881e6b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LFUtils.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_ApplyChunking.html b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyChunking.html new file mode 100644 index 0000000..2d4661b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyChunking.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_ApplyClassification.html b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyClassification.html new file mode 100644 index 0000000..b425044 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyClassification.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_ApplyRegression.html b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyRegression.html new file mode 100644 index 0000000..79e21fa --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyRegression.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_ApplyTopicModel.html b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyTopicModel.html new file mode 100644 index 0000000..f8e335e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_ApplyTopicModel.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_EvaluateClassification.html b/apidocs/gate/plugin/learningframework/class-use/LF_EvaluateClassification.html new file mode 100644 index 0000000..cda0499 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_EvaluateClassification.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_EvaluateRegression.html b/apidocs/gate/plugin/learningframework/class-use/LF_EvaluateRegression.html new file mode 100644 index 0000000..d25b21d --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_EvaluateRegression.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_Export.html b/apidocs/gate/plugin/learningframework/class-use/LF_Export.html new file mode 100644 index 0000000..1ff0651 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_Export.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_ExportBase.html b/apidocs/gate/plugin/learningframework/class-use/LF_ExportBase.html new file mode 100644 index 0000000..2d55782 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_ExportBase.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LF_Export |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_ExportText.html b/apidocs/gate/plugin/learningframework/class-use/LF_ExportText.html new file mode 100644 index 0000000..323a3d4 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_ExportText.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_GenFeatures_Affixes.html b/apidocs/gate/plugin/learningframework/class-use/LF_GenFeatures_Affixes.html new file mode 100644 index 0000000..f161356 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_GenFeatures_Affixes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_GenFeatures_Misc.html b/apidocs/gate/plugin/learningframework/class-use/LF_GenFeatures_Misc.html new file mode 100644 index 0000000..af63d34 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_GenFeatures_Misc.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_TrainChunking.html b/apidocs/gate/plugin/learningframework/class-use/LF_TrainChunking.html new file mode 100644 index 0000000..5507b2f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_TrainChunking.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_TrainClassification.html b/apidocs/gate/plugin/learningframework/class-use/LF_TrainClassification.html new file mode 100644 index 0000000..4d10476 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_TrainClassification.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_TrainRegression.html b/apidocs/gate/plugin/learningframework/class-use/LF_TrainRegression.html new file mode 100644 index 0000000..0f8225a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_TrainRegression.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LF_TrainTopicModel.html b/apidocs/gate/plugin/learningframework/class-use/LF_TrainTopicModel.html new file mode 100644 index 0000000..b7d4080 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LF_TrainTopicModel.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/LearningFrameworkPRBase.html b/apidocs/gate/plugin/learningframework/class-use/LearningFrameworkPRBase.html new file mode 100644 index 0000000..862ad5c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/LearningFrameworkPRBase.html @@ -0,0 +1,224 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LF_ApplyChunking
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_ApplyClassification
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_ApplyRegression
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_ApplyTopicModel
+
+ Training, evaluation and application of ML in GATE.
+ |
+
class |
+LF_EvaluateClassification |
+
class |
+LF_EvaluateRegression |
+
class |
+LF_Export |
+
class |
+LF_ExportBase
+Base class for all Training classes, inherits from LF_Base.
+ |
+
class |
+LF_TrainChunking |
+
class |
+LF_TrainClassification |
+
class |
+LF_TrainRegression |
+
class |
+LF_TrainTopicModel |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/ModelApplication.html b/apidocs/gate/plugin/learningframework/class-use/ModelApplication.html new file mode 100644 index 0000000..71b7349 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/ModelApplication.html @@ -0,0 +1,262 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+ModelApplication.applyClassification(gate.Document doc,
+ List<ModelApplication> gcs,
+ String targetFeature,
+ gate.AnnotationSet outputAS,
+ Double minConfidence)
+Utility function to apply a list of ModelApplication to a document.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+EngineMBSklearnBase.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineDVFileJson.applyModel(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineMBPythonNetworksBase.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
abstract List<ModelApplication> |
+Engine.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
List<ModelApplication> |
+EngineMBTopicsLDA.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineMBWekaWrapper.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineMBMalletClass.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineLibSVM.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineMBMalletSeq.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
List<ModelApplication> |
+EngineMBServer.applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/class-use/ScalingMethod.html b/apidocs/gate/plugin/learningframework/class-use/ScalingMethod.html new file mode 100644 index 0000000..05087ce --- /dev/null +++ b/apidocs/gate/plugin/learningframework/class-use/ScalingMethod.html @@ -0,0 +1,339 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected ScalingMethod |
+LF_EvaluateRegression.scaleFeatures |
+
protected ScalingMethod |
+LF_EvaluateClassification.scaleFeatures |
+
protected ScalingMethod |
+LF_TrainRegression.scaleFeatures |
+
protected ScalingMethod |
+LF_Export.scaleFeatures |
+
protected ScalingMethod |
+LF_TrainChunking.scaleFeatures |
+
protected ScalingMethod |
+LF_TrainClassification.scaleFeatures |
+
| Modifier and Type | +Method and Description | +
|---|---|
ScalingMethod |
+LF_EvaluateRegression.getScaleFeatures() |
+
ScalingMethod |
+LF_EvaluateClassification.getScaleFeatures() |
+
ScalingMethod |
+LF_TrainRegression.getScaleFeatures() |
+
ScalingMethod |
+LF_Export.getScaleFeatures() |
+
ScalingMethod |
+LF_TrainChunking.getScaleFeatures() |
+
ScalingMethod |
+LF_TrainClassification.getScaleFeatures() |
+
static ScalingMethod |
+ScalingMethod.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ScalingMethod[] |
+ScalingMethod.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_EvaluateRegression.setScaleFeatures(ScalingMethod sf) |
+
void |
+LF_EvaluateClassification.setScaleFeatures(ScalingMethod sf) |
+
void |
+LF_TrainRegression.setScaleFeatures(ScalingMethod sf) |
+
void |
+LF_Export.setScaleFeatures(ScalingMethod sf) |
+
void |
+LF_TrainChunking.setScaleFeatures(ScalingMethod sf) |
+
void |
+LF_TrainClassification.setScaleFeatures(ScalingMethod sf) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected ScalingMethod |
+CorpusRepresentationMalletRelated.scalingMethod |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected ScalingMethod |
+FeatureInfo.globalScalingMethod |
+
| Modifier and Type | +Method and Description | +
|---|---|
ScalingMethod |
+FeatureInfo.getGlobalScalingMethod()
+Get the global scaling method.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+FeatureInfo.setGlobalScalingMethod(ScalingMethod sm)
+Set the global scaling method.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/Attribute.html b/apidocs/gate/plugin/learningframework/data/Attribute.html new file mode 100644 index 0000000..ad36776 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/Attribute.html @@ -0,0 +1,444 @@ + + + + + + +public class Attribute +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
cc.mallet.types.Alphabet |
+alphabet
+Dictionary of possible values and their codes if the attribute/feature
+ is nominal and coded as number
+ |
+
CodeAs |
+codeAs
+If the attribute/feature is nominal, how the value is coded
+ |
+
Datatype |
+datatype
+The type of the values of the attribute/feature
+ |
+
int |
+index
+Index/location of the attribute in a (sparse) feature vector.
+ |
+
MissingValueTreatment |
+mvTreatment |
+
String |
+name
+Name of the attribute
+ |
+
| Constructor and Description | +
|---|
Attribute(String name,
+ int index,
+ Datatype datatype,
+ CodeAs codeAs,
+ MissingValueTreatment mvt,
+ LFAlphabet alphabet) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
int |
+hashCode() |
+
String |
+toString() |
+
public String name+
public int index+
public Datatype datatype+
public CodeAs codeAs+
public MissingValueTreatment mvTreatment+
public cc.mallet.types.Alphabet alphabet+
public Attribute(String name, + int index, + Datatype datatype, + CodeAs codeAs, + MissingValueTreatment mvt, + LFAlphabet alphabet)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/Attributes.AttributeIterator.html b/apidocs/gate/plugin/learningframework/data/Attributes.AttributeIterator.html new file mode 100644 index 0000000..71f8c9a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/Attributes.AttributeIterator.html @@ -0,0 +1,310 @@ + + + + + + +| Constructor and Description | +
|---|
AttributeIterator() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+hasNext() |
+
Attribute |
+next() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEachRemaining, removeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/Attributes.html b/apidocs/gate/plugin/learningframework/data/Attributes.html new file mode 100644 index 0000000..f79b4ae --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/Attributes.html @@ -0,0 +1,473 @@ + + + + + + +| Modifier and Type | +Class and Description | +
|---|---|
class |
+Attributes.AttributeIterator |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected List<Attribute> |
+attributes |
+
protected Map<String,Integer> |
+name2index |
+
protected Attribute |
+targetAttribute |
+
| Constructor and Description | +
|---|
Attributes(cc.mallet.pipe.Pipe pipe,
+ String instanceType)
+Generate the attributes object from the information in the pipe.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Attribute |
+getAttribute(int index)
+Return the independent attribute with the given index.
+ |
+
Attribute |
+getAttribute(String name)
+Get the independent Attribute object for the attribute with that name.
+ |
+
Attribute |
+getTargetAttribute()
+Get the target Attribute.
+ |
+
Iterator<Attribute> |
+iterator() |
+
int |
+nAttributes() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEach, spliteratorprotected Attribute targetAttribute+
public Attributes(cc.mallet.pipe.Pipe pipe, + String instanceType)+
pipe - mallet pipeinstanceType - instance typepublic Attribute getAttribute(String name)+
name - name of attribute to retrievepublic Attribute getAttribute(int index)+
index - index of attribute to retrievepublic int nAttributes()+
public Attribute getTargetAttribute()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentation.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentation.html new file mode 100644 index 0000000..a0560d3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentation.html @@ -0,0 +1,447 @@ + + + + + + +public abstract class CorpusRepresentation +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected TargetType |
+targetType |
+
| Constructor and Description | +
|---|
CorpusRepresentation() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
abstract void |
+finishAdding() |
+
abstract Object |
+getRepresentation()
+Returns whatever object the concrete representation uses to represent the instances.
+ |
+
TargetType |
+getTargetType()
+Get the target type set for this corpus.
+ |
+
abstract int |
+nrInstances()
+Returns the number of training instances added to this CR so far.
+ |
+
void |
+setTargetType(TargetType val)
+Set the target type for the corpus representation.
+ |
+
abstract void |
+startAdding() |
+
protected TargetType targetType+
public abstract Object getRepresentation()+
public abstract void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
public abstract void finishAdding()+
public abstract void startAdding()+
public abstract int nrInstances()+
public TargetType getTargetType()+
public void setTargetType(TargetType val)+
val - the target typeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationLibSVM.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationLibSVM.html new file mode 100644 index 0000000..15c285b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationLibSVM.html @@ -0,0 +1,562 @@ + + + + + + +public class CorpusRepresentationLibSVM +extends CorpusRepresentationMalletRelated+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentationMallet |
+crm |
+
protected libsvm.svm_problem |
+data |
+
featureInfo, pipe, scalingMethodtargetType| Constructor and Description | +
|---|
CorpusRepresentationLibSVM(CorpusRepresentationMallet other) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
void |
+finishAdding() |
+
static libsvm.svm_problem |
+getFromMallet(CorpusRepresentationMallet crm)
+Create libsvm representation from Mallet.
+ |
+
Object |
+getRepresentation()
+Returns whatever object the concrete representation uses to represent the instances.
+ |
+
libsvm.svm_problem |
+getRepresentationLibSVM()
+Return the libsvm internal representation of the corpus.
+ |
+
cc.mallet.types.InstanceList |
+getRepresentationMallet() |
+
TargetType |
+getTargetType()
+Get the target type set for this corpus.
+ |
+
static libsvm.svm_node[] |
+libSVMInstanceIndepFromMalletInstance(cc.mallet.types.Instance malletInstance) |
+
int |
+nrInstances()
+Returns the number of training instances added to this CR so far.
+ |
+
void |
+setTargetType(TargetType val)
+Set the target type for the corpus representation.
+ |
+
startAddingprotected libsvm.svm_problem data+
protected CorpusRepresentationMallet crm+
public CorpusRepresentationLibSVM(CorpusRepresentationMallet other)+
public libsvm.svm_problem getRepresentationLibSVM()+
public Object getRepresentation()+
CorpusRepresentationgetRepresentation in class CorpusRepresentationpublic static libsvm.svm_node[] libSVMInstanceIndepFromMalletInstance(cc.mallet.types.Instance malletInstance)+
public static libsvm.svm_problem getFromMallet(CorpusRepresentationMallet crm)+
crm - mallet representationpublic cc.mallet.types.InstanceList getRepresentationMallet()+
getRepresentationMallet in class CorpusRepresentationMalletRelatedpublic void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
add in class CorpusRepresentationpublic void finishAdding()+
finishAdding in class CorpusRepresentationpublic int nrInstances()+
CorpusRepresentationnrInstances in class CorpusRepresentationpublic TargetType getTargetType()+
CorpusRepresentationgetTargetType in class CorpusRepresentationpublic void setTargetType(TargetType val)+
CorpusRepresentationsetTargetType in class CorpusRepresentationval - the target typeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMallet.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMallet.html new file mode 100644 index 0000000..308ffda --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMallet.html @@ -0,0 +1,465 @@ + + + + + + +public abstract class CorpusRepresentationMallet +extends CorpusRepresentationMalletRelated+
| Modifier and Type | +Field and Description | +
|---|---|
protected cc.mallet.types.InstanceList |
+instances |
+
featureInfo, pipe, scalingMethodtargetType| Constructor and Description | +
|---|
CorpusRepresentationMallet() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract void |
+finishAdding()
+Finish adding data to the CR.
+ |
+
LFPipe |
+getPipe() |
+
Object |
+getRepresentation()
+Returns whatever object the concrete representation uses to represent the instances.
+ |
+
cc.mallet.types.InstanceList |
+getRepresentationMallet() |
+
void |
+savePipe(File directory) |
+
void |
+startGrowth()
+Enable the addition of new features or feature values when instances are added.
+ |
+
void |
+stopGrowth()
+Prevent the addition of new features or feature values when instances are added.
+ |
+
startAddingadd, getTargetType, nrInstances, setTargetTypepublic CorpusRepresentationMallet()+
public cc.mallet.types.InstanceList getRepresentationMallet()+
getRepresentationMallet in class CorpusRepresentationMalletRelatedpublic Object getRepresentation()+
CorpusRepresentationgetRepresentation in class CorpusRepresentationpublic LFPipe getPipe()+
public void stopGrowth()+
public void startGrowth()+
public void savePipe(File directory)+
public abstract void finishAdding()+
finishAdding in class CorpusRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletLDA.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletLDA.html new file mode 100644 index 0000000..70d8ba3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletLDA.html @@ -0,0 +1,474 @@ + + + + + + +public class CorpusRepresentationMalletLDA +extends CorpusRepresentationMallet+
instancesfeatureInfo, pipe, scalingMethodtargetType| Constructor and Description | +
|---|
CorpusRepresentationMalletLDA(FeatureInfo fi) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String tokenFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
void |
+finishAdding()
+Finish adding data to the CR.
+ |
+
cc.mallet.types.Instance |
+getInstanceFor(long from,
+ long to,
+ gate.AnnotationSet tokenAS,
+ String tokenFeatureName)
+Get a Mallet FeatureSequence Instance for the tokens in the span.
+ |
+
static CorpusRepresentationMalletLDA |
+load(URL directory)
+Create a new instance based on the pipe stored in directory.
+ |
+
int |
+nrInstances()
+Returns the number of training instances added to this CR so far.
+ |
+
getPipe, getRepresentation, getRepresentationMallet, savePipe, startGrowth, stopGrowthstartAddinggetTargetType, setTargetTypepublic CorpusRepresentationMalletLDA(FeatureInfo fi)+
public static CorpusRepresentationMalletLDA load(URL directory)+
directory - directory with the saved modelpublic void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String tokenFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
add in class CorpusRepresentationinstancesAS - instance/document annotation set or nullsequenceAS - not usedinputAS - set of token annotationsclassAS - not suedtokenFeatureName - the feature to use for the token string or empty to use the document texttargetType - not used, expected to be Target.NONEinstanceWeightFeature - ignorednameFeatureName - not usedseqEncoder - not usedpublic void finishAdding()+
CorpusRepresentationMalletfinishAdding in class CorpusRepresentationMalletpublic cc.mallet.types.Instance getInstanceFor(long from, + long to, + gate.AnnotationSet tokenAS, + String tokenFeatureName)+
from - start offsetto - end offsettokenAS - annotation set containing the token-like annotationstokenFeatureName - feature in the token-like annotations to use or empty for document textpublic int nrInstances()+
CorpusRepresentationnrInstances in class CorpusRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletRelated.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletRelated.html new file mode 100644 index 0000000..0149d6d --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletRelated.html @@ -0,0 +1,381 @@ + + + + + + +public abstract class CorpusRepresentationMalletRelated +extends CorpusRepresentation+
| Modifier and Type | +Field and Description | +
|---|---|
protected FeatureInfo |
+featureInfo |
+
protected LFPipe |
+pipe |
+
protected ScalingMethod |
+scalingMethod |
+
targetType| Constructor and Description | +
|---|
CorpusRepresentationMalletRelated() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract cc.mallet.types.InstanceList |
+getRepresentationMallet() |
+
void |
+startAdding() |
+
add, finishAdding, getRepresentation, getTargetType, nrInstances, setTargetTypeprotected FeatureInfo featureInfo+
protected ScalingMethod scalingMethod+
protected LFPipe pipe+
public CorpusRepresentationMalletRelated()+
public abstract cc.mallet.types.InstanceList getRepresentationMallet()+
public void startAdding()+
startAdding in class CorpusRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletSeq.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletSeq.html new file mode 100644 index 0000000..40e1aea --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletSeq.html @@ -0,0 +1,490 @@ + + + + + + +public class CorpusRepresentationMalletSeq +extends CorpusRepresentationMallet+
instancesfeatureInfo, pipe, scalingMethodtargetType| Constructor and Description | +
|---|
CorpusRepresentationMalletSeq(FeatureInfo fi) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
void |
+finishAdding()
+Finish adding data to the CR.
+ |
+
cc.mallet.types.Instance |
+getInstanceForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Get a single Instance for a sequence annotation.
+ |
+
static CorpusRepresentationMalletSeq |
+load(URL directory)
+Create a new instance based on the pipe stored in directory.
+ |
+
int |
+nrInstances()
+Returns the number of training instances added to this CR so far.
+ |
+
getPipe, getRepresentation, getRepresentationMallet, savePipe, startGrowth, stopGrowthstartAddinggetTargetType, setTargetTypepublic CorpusRepresentationMalletSeq(FeatureInfo fi)+
public static CorpusRepresentationMalletSeq load(URL directory)+
directory - directory with the saved modelpublic void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
add in class CorpusRepresentationinstancesAS - instance annotation setsequenceAS - sequence annotation setinputAS - input annotation setclassAS - class annotation settargetFeatureName - feature name of targettargetType - type of targetinstanceWeightFeature - ignored, this is only relevant for classification/regressionnameFeatureName - feature for instance name, not used at the momentseqEncoder - sequence encoder instancepublic void finishAdding()+
CorpusRepresentationMalletfinishAdding in class CorpusRepresentationMalletpublic cc.mallet.types.Instance getInstanceForSequence(gate.AnnotationSet instancesAS, + gate.Annotation sequenceAnnotation, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String nameFeatureName, + SeqEncoder seqEncoder)+
instancesAS - instance annotation setsequenceAnnotation - sequence annotation setinputAS - input annotation setclassAS - class annotation settargetFeatureName - name of target featuretargetType - type of targetnameFeatureName - name featureseqEncoder - sequence encoder instancepublic int nrInstances()+
CorpusRepresentationnrInstances in class CorpusRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletTarget.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletTarget.html new file mode 100644 index 0000000..a4a18f0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationMalletTarget.html @@ -0,0 +1,520 @@ + + + + + + +public class CorpusRepresentationMalletTarget +extends CorpusRepresentationMallet+
| Modifier and Type | +Field and Description | +
|---|---|
protected boolean |
+finishAddingCalled |
+
instancesfeatureInfo, pipe, scalingMethodtargetType| Constructor and Description | +
|---|
CorpusRepresentationMalletTarget(FeatureInfo fi,
+ TargetType targetType)
+Constructor for creating a new CorpusRepresentation from a FeatureInfo.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
cc.mallet.types.Instance |
+extractIndependentFeatures(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Get an Instance with the independent features only.
+ |
+
void |
+finishAdding()
+Finish adding instances to the CR.
+ |
+
static CorpusRepresentationMalletTarget |
+load(URL directory)
+Create a new CRMT instance based on the pipe stored in directory.
+ |
+
int |
+nrInstances()
+Returns the number of training instances added to this CR so far.
+ |
+
getPipe, getRepresentation, getRepresentationMallet, savePipe, startGrowth, stopGrowthstartAddinggetTargetType, setTargetTypepublic CorpusRepresentationMalletTarget(FeatureInfo fi, + TargetType targetType)+
fi - FeatureInfo instancetargetType - type of targetpublic static CorpusRepresentationMalletTarget load(URL directory)+
directory - directory URLpublic cc.mallet.types.Instance extractIndependentFeatures(gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS)+
instanceAnnotation - instance annotationinputAS - input annotation setpublic void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
add in class CorpusRepresentationinstancesAS - instance annotation setsequenceAS - sequence annotation setinputAS - input annotation setclassAS - class annotation settargetFeatureName - target feature nametargetType - type of targetinstanceWeightFeature - feature for the instance weight or nullnameFeatureName - feature for the instance name or nullseqEncoder - sequence encoder instancepublic void finishAdding()+
finishAdding in class CorpusRepresentationMalletpublic int nrInstances()+
CorpusRepresentationnrInstances in class CorpusRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationVolatileBase.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationVolatileBase.html new file mode 100644 index 0000000..bb6f3c7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationVolatileBase.html @@ -0,0 +1,387 @@ + + + + + + +public abstract class CorpusRepresentationVolatileBase +extends CorpusRepresentation+
targetType| Constructor and Description | +
|---|
CorpusRepresentationVolatileBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
abstract void |
+finishAdding()
+Finish adding data to the CR.
+ |
+
void |
+startGrowth()
+Enable the addition of new features or feature values when instances are added.
+ |
+
void |
+stopGrowth()
+Prevent the addition of new features or feature values when instances are added.
+ |
+
getRepresentation, getTargetType, nrInstances, setTargetType, startAddingpublic CorpusRepresentationVolatileBase()+
public void stopGrowth()+
public void startGrowth()+
public abstract void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
add in class CorpusRepresentationpublic abstract void finishAdding()+
finishAdding in class CorpusRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/CorpusRepresentationVolatileDense2JsonStream.html b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationVolatileDense2JsonStream.html new file mode 100644 index 0000000..c370eb5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/CorpusRepresentationVolatileDense2JsonStream.html @@ -0,0 +1,857 @@ + + + + + + +public class CorpusRepresentationVolatileDense2JsonStream +extends CorpusRepresentationVolatileBase+
+ This tries to handle both sequence and non-sequence corpora.
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+DATA_FILE_NAME |
+
protected Boolean |
+isSequence |
+
static String |
+META_FILE_NAME |
+
targetType| Constructor and Description | +
|---|
CorpusRepresentationVolatileDense2JsonStream(File outDir,
+ FeatureInfo featureInfo)
+The constructor needs to specify the file where to save the instances to.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances from the document.
+ |
+
void |
+addToStatsForFeatures(InstanceRepresentation inst)
+Update the feature stastistics from the instance.
+ |
+
void |
+finishAdding()
+Finish adding data to the CR.
+ |
+
File |
+getDataFile() |
+
File |
+getMetaFile() |
+
int |
+getNrFeatures() |
+
Object |
+getRepresentation()
+Returns whatever object the concrete representation uses to represent the instances.
+ |
+
List<String> |
+getTargetLabels() |
+
List<InstanceRepresentation> |
+instancesForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ SeqEncoder seqEncoder) |
+
String |
+internal2Json(InstanceRepresentation inst,
+ boolean noTarget)
+Convert the instance to json.
+ |
+
String |
+internal2Json(List<InstanceRepresentation> instseq,
+ boolean noTarget)
+Convert a list of instances to json.
+ |
+
void |
+json4metadata(Writer writer)
+Write the complete json representation for the metadata to the writer.
+ |
+
InstanceRepresentation |
+labeledAnnotation2Instance(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ SeqEncoder seqEncoder)
+Convert a labeled instance annotation to an instance representation.
+ |
+
int |
+nrInstances()
+Returns the number of training instances added to this CR so far.
+ |
+
void |
+saveMetadata()
+Save the current metadata.
+ |
+
void |
+startAdding()
+Switch on adding for the corpus representation.
+ |
+
void |
+startGrowth()
+Enable the addition of new features or feature values when instances are
+ added.
+ |
+
void |
+stopGrowth()
+Prevent the addition of new features or feature values when instances are
+ added.
+ |
+
InstanceRepresentation |
+unlabeledAnnotation2Instance(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS,
+ String instanceWeightFeature)
+Convert an unlabeled instance annotation to an InstanceRepresentation.
+ |
+
List<InstanceRepresentation> |
+unlabeledInstancesForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS) |
+
void |
+writeData(String json) |
+
getTargetType, setTargetTypepublic static final String DATA_FILE_NAME+
public static final String META_FILE_NAME+
protected Boolean isSequence+
public CorpusRepresentationVolatileDense2JsonStream(File outDir, + FeatureInfo featureInfo)+
outDir - directory where to save the instancesfeatureInfo - FeatureInfo instancepublic int getNrFeatures()+
public File getDataFile()+
public File getMetaFile()+
public int nrInstances()+
CorpusRepresentationnrInstances in class CorpusRepresentationpublic void stopGrowth()+
stopGrowth in class CorpusRepresentationVolatileBasepublic void startGrowth()+
startGrowth in class CorpusRepresentationVolatileBasepublic void add(gate.AnnotationSet instancesAS, + gate.AnnotationSet sequenceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + String nameFeatureName, + SeqEncoder seqEncoder)+
+ NOTE: this method is automatically synchronized and should be save to use + from multiple threads +
+ !!!TODO: explain which methods are used by this to convert to dense + internal instance representation and then to the final output format.
add in class CorpusRepresentationVolatileBaseinstancesAS - instance annotation setsequenceAS - sequence annotation setinputAS - input annotation setclassAS - class annotation settargetFeatureName - target feature nametargetType - type of targetinstanceWeightFeature - weight feature namenameFeatureName - name feature nameseqEncoder - sequence encoder instancepublic void writeData(String json)+
public List<InstanceRepresentation> instancesForSequence(gate.AnnotationSet instancesAS, + gate.Annotation sequenceAnnotation, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + SeqEncoder seqEncoder)+
public List<InstanceRepresentation> unlabeledInstancesForSequence(gate.AnnotationSet instancesAS, + gate.Annotation sequenceAnnotation, + gate.AnnotationSet inputAS)+
public InstanceRepresentation labeledAnnotation2Instance(gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS, + gate.AnnotationSet classAS, + String targetFeatureName, + TargetType targetType, + String instanceWeightFeature, + SeqEncoder seqEncoder)+
instanceAnnotation - instance annotationinputAS - input annotation setclassAS - class annotation settargetFeatureName - name of target featuretargetType - type of targetinstanceWeightFeature - instance weight feature, currently unusedseqEncoder - sequence encoder instancepublic InstanceRepresentation unlabeledAnnotation2Instance(gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS, + String instanceWeightFeature)+
instanceAnnotation - instance annotationinputAS - input annotation setinstanceWeightFeature - instance weight feature, currently unusedpublic void addToStatsForFeatures(InstanceRepresentation inst)+
inst - instance from which to updatepublic String internal2Json(InstanceRepresentation inst, + boolean noTarget)+
inst - instance to convertnoTarget - - if true, does not include the target(s) and does not use outermost list for
+ indep / target pairpublic String internal2Json(List<InstanceRepresentation> instseq, + boolean noTarget)+
instseq - list of instance representationsnoTarget - whether or not to include the targetpublic void startAdding()+
startAdding in class CorpusRepresentationpublic void finishAdding()+
finishAdding in class CorpusRepresentationVolatileBasepublic Object getRepresentation()+
CorpusRepresentationgetRepresentation in class CorpusRepresentationpublic void json4metadata(Writer writer)+
writer - where to write the JSON topublic void saveMetadata()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/InstanceRepresentation.html b/apidocs/gate/plugin/learningframework/data/InstanceRepresentation.html new file mode 100644 index 0000000..a86799b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/InstanceRepresentation.html @@ -0,0 +1,476 @@ + + + + + + +public interface InstanceRepresentation
+| Modifier and Type | +Field and Description | +
|---|---|
static String |
+HASMISSINGVALUE_FLAG |
+
static String |
+INSTANCE_WEIGHT |
+
static String |
+TARGET_COSTS |
+
static String |
+TARGET_VALUE |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+getFeature(String name) |
+
double |
+getInstanceWeight() |
+
Object |
+getTargetValue() |
+
boolean |
+hasFeature(String name) |
+
boolean |
+hasMissing() |
+
boolean |
+hasTarget() |
+
int |
+numFeatures() |
+
InstanceRepresentation |
+setFeature(String name,
+ Object value) |
+
InstanceRepresentation |
+setHasMissing(boolean flag) |
+
InstanceRepresentation |
+setInstanceWeight(double weight) |
+
InstanceRepresentation |
+setTargetCosts(Object value) |
+
InstanceRepresentation |
+setTargetValue(Object value) |
+
static final String TARGET_VALUE+
static final String TARGET_COSTS+
static final String INSTANCE_WEIGHT+
static final String HASMISSINGVALUE_FLAG+
InstanceRepresentation setFeature(String name, + Object value)+
boolean hasFeature(String name)+
int numFeatures()+
InstanceRepresentation setTargetValue(Object value)+
boolean hasTarget()+
InstanceRepresentation setTargetCosts(Object value)+
Object getTargetValue()+
InstanceRepresentation setInstanceWeight(double weight)+
double getInstanceWeight()+
InstanceRepresentation setHasMissing(boolean flag)+
boolean hasMissing()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/InstanceRepresentationDenseVolatile.html b/apidocs/gate/plugin/learningframework/data/InstanceRepresentationDenseVolatile.html new file mode 100644 index 0000000..f938cbf --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/InstanceRepresentationDenseVolatile.html @@ -0,0 +1,558 @@ + + + + + + +public class InstanceRepresentationDenseVolatile +extends Object +implements InstanceRepresentation+
+ This representation just wraps a HashMap for storing all features and target + properties. +
+ NOTE: this does not support removing features for now!
| Modifier and Type | +Field and Description | +
|---|---|
protected Map<String,Object> |
+map |
+
protected int |
+numFeatures |
+
HASMISSINGVALUE_FLAG, INSTANCE_WEIGHT, TARGET_COSTS, TARGET_VALUE| Constructor and Description | +
|---|
InstanceRepresentationDenseVolatile() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+getFeature(String name) |
+
double |
+getInstanceWeight() |
+
Object |
+getTargetValue() |
+
boolean |
+hasFeature(String name) |
+
boolean |
+hasMissing() |
+
boolean |
+hasTarget() |
+
int |
+numFeatures() |
+
InstanceRepresentation |
+setFeature(String name,
+ Object value) |
+
InstanceRepresentation |
+setHasMissing(boolean flag) |
+
InstanceRepresentation |
+setInstanceWeight(double weight) |
+
InstanceRepresentation |
+setTargetCosts(Object value) |
+
InstanceRepresentation |
+setTargetValue(Object value) |
+
String |
+toString() |
+
public InstanceRepresentationDenseVolatile()+
public InstanceRepresentation setFeature(String name, + Object value)+
setFeature in interface InstanceRepresentationpublic int numFeatures()+
numFeatures in interface InstanceRepresentationpublic Object getFeature(String name)+
getFeature in interface InstanceRepresentationpublic InstanceRepresentation setTargetValue(Object value)+
setTargetValue in interface InstanceRepresentationpublic Object getTargetValue()+
getTargetValue in interface InstanceRepresentationpublic InstanceRepresentation setTargetCosts(Object value)+
setTargetCosts in interface InstanceRepresentationpublic InstanceRepresentation setInstanceWeight(double weight)+
setInstanceWeight in interface InstanceRepresentationpublic double getInstanceWeight()+
getInstanceWeight in interface InstanceRepresentationpublic boolean hasFeature(String name)+
hasFeature in interface InstanceRepresentationpublic boolean hasTarget()+
hasTarget in interface InstanceRepresentationpublic InstanceRepresentation setHasMissing(boolean flag)+
setHasMissing in interface InstanceRepresentationpublic boolean hasMissing()+
hasMissing in interface InstanceRepresentationCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/Attribute.html b/apidocs/gate/plugin/learningframework/data/class-use/Attribute.html new file mode 100644 index 0000000..de3a53a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/Attribute.html @@ -0,0 +1,223 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected Attribute |
+Attributes.targetAttribute |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected List<Attribute> |
+Attributes.attributes |
+
| Modifier and Type | +Method and Description | +
|---|---|
Attribute |
+Attributes.getAttribute(int index)
+Return the independent attribute with the given index.
+ |
+
Attribute |
+Attributes.getAttribute(String name)
+Get the independent Attribute object for the attribute with that name.
+ |
+
Attribute |
+Attributes.getTargetAttribute()
+Get the target Attribute.
+ |
+
Attribute |
+Attributes.AttributeIterator.next() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Iterator<Attribute> |
+Attributes.iterator() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/Attributes.AttributeIterator.html b/apidocs/gate/plugin/learningframework/data/class-use/Attributes.AttributeIterator.html new file mode 100644 index 0000000..24d24d0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/Attributes.AttributeIterator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/Attributes.html b/apidocs/gate/plugin/learningframework/data/class-use/Attributes.html new file mode 100644 index 0000000..2376317 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/Attributes.html @@ -0,0 +1,200 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+CorpusExporterMRJsonBase.featureVector2String(cc.mallet.types.FeatureVector fv,
+ int nrFeatures,
+ Attributes attrs,
+ boolean asString)
+Return String representation of the feature vector.
+ |
+
String |
+CorpusExporterMRJsonTarget.instance2String(cc.mallet.types.Instance inst,
+ cc.mallet.types.LabelAlphabet targetAlphabet,
+ Attributes attrs,
+ int nrFeatures,
+ boolean asString,
+ boolean filterMV)
+Convert instance to string.
+ |
+
String |
+CorpusExporterMRJsonSeq.instance2String(cc.mallet.types.Instance inst,
+ cc.mallet.types.LabelAlphabet targetAlphabet,
+ Attributes attrs,
+ int nrFeatures,
+ boolean asString,
+ boolean filterMV)
+Convert instance to string representation.
+ |
+
String |
+CorpusExporterMRARFF.instance2WekaArffLine(cc.mallet.types.Instance inst,
+ Attributes attrs)
+Convert an instance to the ARFF representation.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentation.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentation.html new file mode 100644 index 0000000..d5212b5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentation.html @@ -0,0 +1,281 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusRepresentationLibSVM |
+
class |
+CorpusRepresentationMallet
+Common base class for Mallet for classification and Mallet for sequence tagging.
+ |
+
class |
+CorpusRepresentationMalletLDA |
+
class |
+CorpusRepresentationMalletRelated
+The base class of all classes that are somehow related or dependent on the
+ Mallet instance list and Mallet pipes.
+ |
+
class |
+CorpusRepresentationMalletSeq |
+
class |
+CorpusRepresentationMalletTarget
+This represents a corpus in Mallet format where we have a single feature vector and single
+ target.
+ |
+
class |
+CorpusRepresentationVolatileBase
+Common base class for non Mallet volatile representations.
+ |
+
class |
+CorpusRepresentationVolatileDense2JsonStream
+Common base class for non Mallet volatile representations.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CorpusRepresentation |
+EngineDVFileJson.getCorpusRepresentation() |
+
abstract CorpusRepresentation |
+Engine.getCorpusRepresentation()
+Get the corpus representation for the engine.
+ |
+
CorpusRepresentation |
+EngineMB.getCorpusRepresentation() |
+
protected CorpusRepresentation |
+Engine.recreateCorpusRepresentation(File dir)
+Re-create and return the corpus representation that was stored for this engine.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentation |
+CorpusExporter.corpusRepresentation |
+
| Modifier and Type | +Method and Description | +
|---|---|
CorpusRepresentation |
+CorpusExporter.getCorpusRepresentation()
+Return a corpus representation ce to use with this exporter.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationLibSVM.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationLibSVM.html new file mode 100644 index 0000000..d97454a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationLibSVM.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMallet.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMallet.html new file mode 100644 index 0000000..7c425ac --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMallet.html @@ -0,0 +1,251 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusRepresentationMalletLDA |
+
class |
+CorpusRepresentationMalletSeq |
+
class |
+CorpusRepresentationMalletTarget
+This represents a corpus in Mallet format where we have a single feature vector and single
+ target.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentationMallet |
+CorpusRepresentationLibSVM.crm |
+
| Modifier and Type | +Method and Description | +
|---|---|
static libsvm.svm_problem |
+CorpusRepresentationLibSVM.getFromMallet(CorpusRepresentationMallet crm)
+Create libsvm representation from Mallet.
+ |
+
| Constructor and Description | +
|---|
CorpusRepresentationLibSVM(CorpusRepresentationMallet other) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentationMallet |
+EngineMB.corpusRepresentation |
+
| Modifier and Type | +Method and Description | +
|---|---|
CorpusRepresentationMallet |
+EngineMBMallet.getCorpusRepresentationMallet() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletLDA.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletLDA.html new file mode 100644 index 0000000..aaab794 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletLDA.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusRepresentationMalletLDA |
+CorpusRepresentationMalletLDA.load(URL directory)
+Create a new instance based on the pipe stored in directory.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletRelated.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletRelated.html new file mode 100644 index 0000000..f5e4e08 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletRelated.html @@ -0,0 +1,187 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusRepresentationLibSVM |
+
class |
+CorpusRepresentationMallet
+Common base class for Mallet for classification and Mallet for sequence tagging.
+ |
+
class |
+CorpusRepresentationMalletLDA |
+
class |
+CorpusRepresentationMalletSeq |
+
class |
+CorpusRepresentationMalletTarget
+This represents a corpus in Mallet format where we have a single feature vector and single
+ target.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletSeq.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletSeq.html new file mode 100644 index 0000000..945190a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletSeq.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusRepresentationMalletSeq |
+CorpusRepresentationMalletSeq.load(URL directory)
+Create a new instance based on the pipe stored in directory.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletTarget.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletTarget.html new file mode 100644 index 0000000..af415d1 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationMalletTarget.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusRepresentationMalletTarget |
+CorpusRepresentationMalletTarget.load(URL directory)
+Create a new CRMT instance based on the pipe stored in directory.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected AbstractMap.SimpleEntry<String,Integer> |
+EngineMBPythonNetworksBase.findOutMode(CorpusRepresentationMalletTarget crm) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationVolatileBase.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationVolatileBase.html new file mode 100644 index 0000000..4725515 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationVolatileBase.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusRepresentationVolatileDense2JsonStream
+Common base class for non Mallet volatile representations.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationVolatileDense2JsonStream.html b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationVolatileDense2JsonStream.html new file mode 100644 index 0000000..8426cce --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/CorpusRepresentationVolatileDense2JsonStream.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentationVolatileDense2JsonStream |
+EngineDVFileJson.corpusRepresentation |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/InstanceRepresentation.html b/apidocs/gate/plugin/learningframework/data/class-use/InstanceRepresentation.html new file mode 100644 index 0000000..a21efe9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/InstanceRepresentation.html @@ -0,0 +1,401 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+InstanceRepresentationDenseVolatile
+Representation of a dense-representation, non-lasting learning instance.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
InstanceRepresentation |
+CorpusRepresentationVolatileDense2JsonStream.labeledAnnotation2Instance(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ SeqEncoder seqEncoder)
+Convert a labeled instance annotation to an instance representation.
+ |
+
InstanceRepresentation |
+InstanceRepresentation.setFeature(String name,
+ Object value) |
+
InstanceRepresentation |
+InstanceRepresentationDenseVolatile.setFeature(String name,
+ Object value) |
+
InstanceRepresentation |
+InstanceRepresentation.setHasMissing(boolean flag) |
+
InstanceRepresentation |
+InstanceRepresentationDenseVolatile.setHasMissing(boolean flag) |
+
InstanceRepresentation |
+InstanceRepresentation.setInstanceWeight(double weight) |
+
InstanceRepresentation |
+InstanceRepresentationDenseVolatile.setInstanceWeight(double weight) |
+
InstanceRepresentation |
+InstanceRepresentation.setTargetCosts(Object value) |
+
InstanceRepresentation |
+InstanceRepresentationDenseVolatile.setTargetCosts(Object value) |
+
InstanceRepresentation |
+InstanceRepresentation.setTargetValue(Object value) |
+
InstanceRepresentation |
+InstanceRepresentationDenseVolatile.setTargetValue(Object value) |
+
InstanceRepresentation |
+CorpusRepresentationVolatileDense2JsonStream.unlabeledAnnotation2Instance(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS,
+ String instanceWeightFeature)
+Convert an unlabeled instance annotation to an InstanceRepresentation.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<InstanceRepresentation> |
+CorpusRepresentationVolatileDense2JsonStream.instancesForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ SeqEncoder seqEncoder) |
+
List<InstanceRepresentation> |
+CorpusRepresentationVolatileDense2JsonStream.unlabeledInstancesForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+CorpusRepresentationVolatileDense2JsonStream.addToStatsForFeatures(InstanceRepresentation inst)
+Update the feature stastistics from the instance.
+ |
+
String |
+CorpusRepresentationVolatileDense2JsonStream.internal2Json(InstanceRepresentation inst,
+ boolean noTarget)
+Convert the instance to json.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+CorpusRepresentationVolatileDense2JsonStream.internal2Json(List<InstanceRepresentation> instseq,
+ boolean noTarget)
+Convert a list of instances to json.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static InstanceRepresentation |
+FeatureExtractionDense.extractClassForSeqTagging(InstanceRepresentation inst,
+ gate.AnnotationSet classAS,
+ gate.Annotation instanceAnnotation,
+ SeqEncoder seqEncoder)
+Extract the class for an instance for sequence tagging.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractClassTarget(InstanceRepresentation inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract the class label for the given instance annotation.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractFeature(InstanceRepresentation inst,
+ FeatureSpecAttribute att,
+ gate.AnnotationSet inputAS,
+ gate.Annotation instanceAnnotation)
+Dispatch to the proper helper method for extracting a feature of that type.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractNumericTarget(InstanceRepresentation inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract a numeric target and update instance representation.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static InstanceRepresentation |
+FeatureExtractionDense.extractClassForSeqTagging(InstanceRepresentation inst,
+ gate.AnnotationSet classAS,
+ gate.Annotation instanceAnnotation,
+ SeqEncoder seqEncoder)
+Extract the class for an instance for sequence tagging.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractClassTarget(InstanceRepresentation inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract the class label for the given instance annotation.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractFeature(InstanceRepresentation inst,
+ FeatureSpecAttribute att,
+ gate.AnnotationSet inputAS,
+ gate.Annotation instanceAnnotation)
+Dispatch to the proper helper method for extracting a feature of that type.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractNumericTarget(InstanceRepresentation inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract a numeric target and update instance representation.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/class-use/InstanceRepresentationDenseVolatile.html b/apidocs/gate/plugin/learningframework/data/class-use/InstanceRepresentationDenseVolatile.html new file mode 100644 index 0000000..d074611 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/class-use/InstanceRepresentationDenseVolatile.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/package-frame.html b/apidocs/gate/plugin/learningframework/data/package-frame.html new file mode 100644 index 0000000..5483b9d --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +| Interface | +Description | +
|---|---|
| InstanceRepresentation | +
+ Common interface to our own representations of learning instances.
+ |
+
| Class | +Description | +
|---|---|
| Attribute | +
+ Class that describes a single attribute/feature.
+ |
+
| Attributes | +
+ Describes all Attributes/features of a dataset.
+ |
+
| CorpusRepresentation | +
+ The base class of all classes that handle the representation of instances.
+ |
+
| CorpusRepresentationLibSVM | ++ |
| CorpusRepresentationMallet | +
+ Common base class for Mallet for classification and Mallet for sequence tagging.
+ |
+
| CorpusRepresentationMalletLDA | ++ |
| CorpusRepresentationMalletRelated | +
+ The base class of all classes that are somehow related or dependent on the
+ Mallet instance list and Mallet pipes.
+ |
+
| CorpusRepresentationMalletSeq | ++ |
| CorpusRepresentationMalletTarget | +
+ This represents a corpus in Mallet format where we have a single feature vector and single
+ target.
+ |
+
| CorpusRepresentationVolatileBase | +
+ Common base class for non Mallet volatile representations.
+ |
+
| CorpusRepresentationVolatileDense2JsonStream | +
+ Common base class for non Mallet volatile representations.
+ |
+
| InstanceRepresentationDenseVolatile | +
+ Representation of a dense-representation, non-lasting learning instance.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/package-tree.html b/apidocs/gate/plugin/learningframework/data/package-tree.html new file mode 100644 index 0000000..2343bf8 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/package-tree.html @@ -0,0 +1,167 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/data/package-use.html b/apidocs/gate/plugin/learningframework/data/package-use.html new file mode 100644 index 0000000..c4c7f94 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/data/package-use.html @@ -0,0 +1,283 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| gate.plugin.learningframework.features | ++ |
| Class and Description | +
|---|
| Attribute
+ Class that describes a single attribute/feature.
+ |
+
| CorpusRepresentation
+ The base class of all classes that handle the representation of instances.
+ |
+
| CorpusRepresentationMallet
+ Common base class for Mallet for classification and Mallet for sequence tagging.
+ |
+
| CorpusRepresentationMalletLDA | +
| CorpusRepresentationMalletRelated
+ The base class of all classes that are somehow related or dependent on the
+ Mallet instance list and Mallet pipes.
+ |
+
| CorpusRepresentationMalletSeq | +
| CorpusRepresentationMalletTarget
+ This represents a corpus in Mallet format where we have a single feature vector and single
+ target.
+ |
+
| CorpusRepresentationVolatileBase
+ Common base class for non Mallet volatile representations.
+ |
+
| InstanceRepresentation
+ Common interface to our own representations of learning instances.
+ |
+
| Class and Description | +
|---|
| CorpusRepresentation
+ The base class of all classes that handle the representation of instances.
+ |
+
| CorpusRepresentationMallet
+ Common base class for Mallet for classification and Mallet for sequence tagging.
+ |
+
| CorpusRepresentationMalletTarget
+ This represents a corpus in Mallet format where we have a single feature vector and single
+ target.
+ |
+
| CorpusRepresentationVolatileDense2JsonStream
+ Common base class for non Mallet volatile representations.
+ |
+
| Class and Description | +
|---|
| Attributes
+ Describes all Attributes/features of a dataset.
+ |
+
| CorpusRepresentation
+ The base class of all classes that handle the representation of instances.
+ |
+
| Class and Description | +
|---|
| InstanceRepresentation
+ Common interface to our own representations of learning instances.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/Algorithm.html b/apidocs/gate/plugin/learningframework/engines/Algorithm.html new file mode 100644 index 0000000..534da83 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/Algorithm.html @@ -0,0 +1,271 @@ + + + + + + +public interface Algorithm
+| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+getAlgorithmKind() |
+
Class<?> |
+getEngineClass() |
+
Class<?> |
+getTrainerClass() |
+
void |
+setTrainerClass(Class<?> trainerClass) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/AlgorithmClassification.html b/apidocs/gate/plugin/learningframework/engines/AlgorithmClassification.html new file mode 100644 index 0000000..8fff553 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/AlgorithmClassification.html @@ -0,0 +1,620 @@ + + + + + + +public enum AlgorithmClassification +extends Enum<AlgorithmClassification> +implements Algorithm+
| Enum Constant and Description | +
|---|
CostclaWrapper_CL_MR |
+
KerasWrapper_CL_DR |
+
KerasWrapper_SEQ_DR |
+
LibSVM_CL_MR |
+
MalletBalancedWinnow_CL_MR |
+
MalletC45_CL_MR |
+
MalletCRF_SEQ_MR |
+
MalletCRFSG_SEQ_MR |
+
MalletCRFVG_SEQ_MR |
+
MalletDecisionTree_CL_MR |
+
MalletMaxEnt_CL_MR |
+
MalletMEMM_SEQ_MR |
+
MalletNaiveBayes_CL_MR |
+
MalletNaiveBayesEM_CL_MR |
+
MalletWinnow_CL_MR |
+
PytorchWrapper_CL_DR |
+
PytorchWrapper_SEQ_DR |
+
SklearnWrapper_CL_MR |
+
WekaWrapper_CL_MR |
+
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+getAlgorithmKind() |
+
Class<?> |
+getEngineClass() |
+
Class<?> |
+getTrainerClass() |
+
void |
+setTrainerClass(Class<?> trainerClass) |
+
static AlgorithmClassification |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmClassification[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AlgorithmClassification CostclaWrapper_CL_MR+
public static final AlgorithmClassification KerasWrapper_CL_DR+
public static final AlgorithmClassification KerasWrapper_SEQ_DR+
public static final AlgorithmClassification LibSVM_CL_MR+
public static final AlgorithmClassification MalletBalancedWinnow_CL_MR+
public static final AlgorithmClassification MalletC45_CL_MR+
public static final AlgorithmClassification MalletCRF_SEQ_MR+
public static final AlgorithmClassification MalletCRFSG_SEQ_MR+
public static final AlgorithmClassification MalletCRFVG_SEQ_MR+
public static final AlgorithmClassification MalletDecisionTree_CL_MR+
public static final AlgorithmClassification MalletMEMM_SEQ_MR+
public static final AlgorithmClassification MalletMaxEnt_CL_MR+
public static final AlgorithmClassification MalletNaiveBayesEM_CL_MR+
public static final AlgorithmClassification MalletNaiveBayes_CL_MR+
public static final AlgorithmClassification MalletWinnow_CL_MR+
public static final AlgorithmClassification PytorchWrapper_CL_DR+
public static final AlgorithmClassification PytorchWrapper_SEQ_DR+
public static final AlgorithmClassification SklearnWrapper_CL_MR+
public static final AlgorithmClassification WekaWrapper_CL_MR+
public static AlgorithmClassification[] values()+
+for (AlgorithmClassification c : AlgorithmClassification.values()) + System.out.println(c); +
public static AlgorithmClassification valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getEngineClass()+
getEngineClass in interface Algorithmpublic Class<?> getTrainerClass()+
getTrainerClass in interface Algorithmpublic AlgorithmKind getAlgorithmKind()+
getAlgorithmKind in interface Algorithmpublic void setTrainerClass(Class<?> trainerClass)+
setTrainerClass in interface AlgorithmCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/AlgorithmClustering.html b/apidocs/gate/plugin/learningframework/engines/AlgorithmClustering.html new file mode 100644 index 0000000..1c43705 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/AlgorithmClustering.html @@ -0,0 +1,416 @@ + + + + + + +public enum AlgorithmClustering +extends Enum<AlgorithmClustering> +implements Algorithm+
| Enum Constant and Description | +
|---|
GensimWrapper_CLUS_DR |
+
MalletLDA_CLUS_MR |
+
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+getAlgorithmKind() |
+
Class<?> |
+getEngineClass() |
+
Class<?> |
+getTrainerClass() |
+
void |
+setTrainerClass(Class<?> trainerClass) |
+
static AlgorithmClustering |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmClustering[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AlgorithmClustering GensimWrapper_CLUS_DR+
public static final AlgorithmClustering MalletLDA_CLUS_MR+
public static AlgorithmClustering[] values()+
+for (AlgorithmClustering c : AlgorithmClustering.values()) + System.out.println(c); +
public static AlgorithmClustering valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getEngineClass()+
getEngineClass in interface Algorithmpublic Class<?> getTrainerClass()+
getTrainerClass in interface Algorithmpublic AlgorithmKind getAlgorithmKind()+
getAlgorithmKind in interface Algorithmpublic void setTrainerClass(Class<?> trainerClass)+
setTrainerClass in interface AlgorithmCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/AlgorithmKind.html b/apidocs/gate/plugin/learningframework/engines/AlgorithmKind.html new file mode 100644 index 0000000..1204706 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/AlgorithmKind.html @@ -0,0 +1,372 @@ + + + + + + +public enum AlgorithmKind +extends Enum<AlgorithmKind>+
| Enum Constant and Description | +
|---|
CLASSIFIER |
+
CLUSTERING |
+
REGRESSOR |
+
SEQUENCE_TAGGER |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AlgorithmKind |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmKind[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AlgorithmKind CLASSIFIER+
public static final AlgorithmKind SEQUENCE_TAGGER+
public static final AlgorithmKind REGRESSOR+
public static final AlgorithmKind CLUSTERING+
public static AlgorithmKind[] values()+
+for (AlgorithmKind c : AlgorithmKind.values()) + System.out.println(c); +
public static AlgorithmKind valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/AlgorithmRegression.html b/apidocs/gate/plugin/learningframework/engines/AlgorithmRegression.html new file mode 100644 index 0000000..7a3aa76 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/AlgorithmRegression.html @@ -0,0 +1,440 @@ + + + + + + +public enum AlgorithmRegression +extends Enum<AlgorithmRegression> +implements Algorithm+
| Enum Constant and Description | +
|---|
LibSVM_RG_MR |
+
PytorchWrapper_RG_DR |
+
SklearnWrapper_RG_MR |
+
WekaWrapper_RG_MR |
+
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+getAlgorithmKind() |
+
Class<?> |
+getEngineClass() |
+
Class<?> |
+getTrainerClass() |
+
void |
+setTrainerClass(Class<?> trainerClass) |
+
static AlgorithmRegression |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmRegression[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final AlgorithmRegression LibSVM_RG_MR+
public static final AlgorithmRegression PytorchWrapper_RG_DR+
public static final AlgorithmRegression SklearnWrapper_RG_MR+
public static final AlgorithmRegression WekaWrapper_RG_MR+
public static AlgorithmRegression[] values()+
+for (AlgorithmRegression c : AlgorithmRegression.values()) + System.out.println(c); +
public static AlgorithmRegression valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getEngineClass()+
getEngineClass in interface Algorithmpublic Class<?> getTrainerClass()+
getTrainerClass in interface Algorithmpublic AlgorithmKind getAlgorithmKind()+
getAlgorithmKind in interface Algorithmpublic void setTrainerClass(Class<?> trainerClass)+
setTrainerClass in interface AlgorithmCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/Engine.html b/apidocs/gate/plugin/learningframework/engines/Engine.html new file mode 100644 index 0000000..63fec61 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/Engine.html @@ -0,0 +1,887 @@ + + + + + + +public abstract class Engine +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected Algorithm |
+algorithm |
+
protected FeatureInfo |
+featureInfo |
+
static String |
+FILENAME_MODEL |
+
static String |
+FILENAME_PIPE |
+
protected Info |
+info
+The corpus representation to use with the concrete instance of the engine.
+ |
+
protected Object |
+model
+The model is the result of the training step and is what is stored/loaded.
+ |
+
protected Object |
+trainer
+The trainer is the instance of something that can be used to create a trained model.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
static Engine |
+create(Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType,
+ URL directory)
+A factory method to create a new instance of an engine with the given backend algorithm.
+ |
+
abstract EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
Algorithm |
+getAlgorithm() |
+
abstract CorpusRepresentation |
+getCorpusRepresentation()
+Get the corpus representation for the engine.
+ |
+
FeatureInfo |
+getFeatureInfo() |
+
Info |
+getInfo()
+Return the info instance for this Engine.
+ |
+
Object |
+getModel() |
+
Object |
+getTrainer() |
+
abstract void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected abstract void |
+initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+initWhenLoading(URL directory,
+ String parms)
+The details of how to initialise a specific instance of an Engine subclass.
+ |
+
static Engine |
+load(URL directory,
+ String parms)
+A factory method to return the engine which is stored in the given directory.
+ |
+
protected abstract void |
+loadAndSetCorpusRepresentation(URL directory)
+Re-create the corpus representation we need for this engine.
+ |
+
protected abstract void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
protected CorpusRepresentation |
+recreateCorpusRepresentation(File dir)
+Re-create and return the corpus representation that was stored for this engine.
+ |
+
protected abstract void |
+saveCorpusRepresentation(File directory)
+Save the corpus representation used by the engine instance in some way to the directory.
+ |
+
void |
+saveEngine(File directory)
+Save an engine to a directory.
+ |
+
protected abstract void |
+saveModel(File directory) |
+
String |
+toString() |
+
abstract void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
public static final String FILENAME_MODEL+
public static final String FILENAME_PIPE+
protected Info info+
protected FeatureInfo featureInfo+
protected Algorithm algorithm+
protected Object model+
+ TODO: maybe we can make this engine specific and only provide the declaration of an + abstract getModel method here?
protected Object trainer+
public Info getInfo()+
public FeatureInfo getFeatureInfo()+
public abstract CorpusRepresentation getCorpusRepresentation()+
public Algorithm getAlgorithm()+
public Object getModel()+
public Object getTrainer()+
public static Engine create(Algorithm algorithm, + String parms, + FeatureInfo featureInfo, + TargetType targetType, + URL directory)+
algorithm - algorithm to useparms - algorithm parametersfeatureInfo - feature info instancetargetType - type of targetdirectory - data/model directory URLpublic static Engine load(URL directory, + String parms)+
+ NOTE: this will also be used for creating an Engine for those situations + where an external model was trained. For this the user has to provide + an info.yaml file manually. This file must contain the Engine class, + all other entries can be missing. +
directory - data/model directory URLparms - algorithm parameterspublic void saveEngine(File directory)+
+ The saving of a specific Engine subclass is influenced by its implementation of the following + methods: +
directory - TODOprotected abstract void initWhenCreating(URL directory, + Algorithm algorithm, + String parms, + FeatureInfo featureInfo, + TargetType targetType)+
protected void initWhenLoading(URL directory, + String parms)+
directory - model/data directory URLparms - algorithm parametersprotected abstract void loadAndSetCorpusRepresentation(URL directory)+
directory - model/data directory URLprotected abstract void loadModel(URL directory, + String parms)+
directory - model/data/ directory URLparms - parametersprotected abstract void saveCorpusRepresentation(File directory)+
directory - model/data directory URLprotected abstract void saveModel(File directory)+
public abstract void trainModel(File dataDirectory, + String instanceType, + String parms)+
dataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic abstract EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+
public abstract List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
instanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic abstract void initializeAlgorithm(Algorithm algorithm, + String parms)+
protected CorpusRepresentation recreateCorpusRepresentation(File dir)+
dir - data/mdoel directory URLCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineDV.html b/apidocs/gate/plugin/learningframework/engines/EngineDV.html new file mode 100644 index 0000000..bda7c56 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineDV.html @@ -0,0 +1,275 @@ + + + + + + +public abstract class EngineDV +extends Engine+
algorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainerapplyModel, create, evaluate, getAlgorithm, getCorpusRepresentation, getFeatureInfo, getInfo, getModel, getTrainer, initializeAlgorithm, initWhenCreating, initWhenLoading, load, loadAndSetCorpusRepresentation, loadModel, recreateCorpusRepresentation, saveCorpusRepresentation, saveEngine, saveModel, toString, trainModelCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineDVFileJson.OsType.html b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJson.OsType.html new file mode 100644 index 0000000..b56fd50 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJson.OsType.html @@ -0,0 +1,348 @@ + + + + + + +public static enum EngineDVFileJson.OsType +extends Enum<EngineDVFileJson.OsType>+
| Enum Constant and Description | +
|---|
LINUXLIKE |
+
WINDOWSLIKE |
+
| Modifier and Type | +Method and Description | +
|---|---|
static EngineDVFileJson.OsType |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static EngineDVFileJson.OsType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final EngineDVFileJson.OsType WINDOWSLIKE+
public static final EngineDVFileJson.OsType LINUXLIKE+
public static EngineDVFileJson.OsType[] values()+
+for (EngineDVFileJson.OsType c : EngineDVFileJson.OsType.values()) + System.out.println(c); +
public static EngineDVFileJson.OsType valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineDVFileJson.html b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJson.html new file mode 100644 index 0000000..9a88e40 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJson.html @@ -0,0 +1,834 @@ + + + + + + +public abstract class EngineDVFileJson +extends EngineDV+
+ See Wiki
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+EngineDVFileJson.OsType
+Known OS types.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+COMMAND_BASE_APPLY |
+
protected String |
+COMMAND_BASE_TRAIN |
+
protected CorpusRepresentationVolatileDense2JsonStream |
+corpusRepresentation |
+
protected File |
+dataDir |
+
protected String |
+MODEL_BASENAME |
+
protected ProcessBase |
+process |
+
protected String |
+WRAPPER_NAME |
+
algorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineDVFileJson() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
protected String |
+getCommandPathApply()
+Get the command path to run for application.
+ |
+
protected String |
+getCommandPathTrain()
+Get the command path to run for training.
+ |
+
CorpusRepresentation |
+getCorpusRepresentation()
+Get the corpus representation for the engine.
+ |
+
protected String |
+getDefaultPythonBin() |
+
protected EngineDVFileJson.OsType |
+getOsType()
+Return LINUXLIKE, WINDOWSLIKE, or throw an exception for anything else
+ |
+
protected String |
+getShellExtension()
+Get the shell extensions for the operating system.
+ |
+
Map<String,String> |
+getWrapperConfig()
+Read a WRAPPERNAME.yaml file from the data dir, if it exists.
+ |
+
protected String |
+getWrapperHome() |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+loadAndSetCorpusRepresentation(URL directory)
+Re-create the corpus representation we need for this engine.
+ |
+
protected void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
protected void |
+saveCorpusRepresentation(File directory)
+Save the corpus representation used by the engine instance in some way to the directory.
+ |
+
protected void |
+saveModel(File directory) |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
protected void |
+updateInfo() |
+
create, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringprotected String WRAPPER_NAME+
protected String MODEL_BASENAME+
protected String COMMAND_BASE_TRAIN+
protected String COMMAND_BASE_APPLY+
protected File dataDir+
protected ProcessBase process+
protected CorpusRepresentationVolatileDense2JsonStream corpusRepresentation+
protected String getWrapperHome()+
protected String getCommandPathTrain()+
protected String getCommandPathApply()+
protected String getShellExtension()+
protected EngineDVFileJson.OsType getOsType()+
public Map<String,String> getWrapperConfig()+
public CorpusRepresentation getCorpusRepresentation()+
EnginegetCorpusRepresentation in class Engineprotected void initWhenCreating(URL directory, + Algorithm algorithm, + String parms, + FeatureInfo featureInfo, + TargetType targetType)+
initWhenCreating in class Engineprotected void loadAndSetCorpusRepresentation(URL directory)+
EngineloadAndSetCorpusRepresentation in class Enginedirectory - model/data directory URLprotected String getDefaultPythonBin()+
protected void loadModel(URL directory, + String parms)+
Engineprotected void saveCorpusRepresentation(File directory)+
EnginesaveCorpusRepresentation in class Enginedirectory - model/data directory URLprotected void saveModel(File directory)+ +
public void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
public List<ModelApplication> applyModel(gate.AnnotationSet instancesAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstancesAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class Engineprotected void updateInfo()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineDVFileJsonKeras.html b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJsonKeras.html new file mode 100644 index 0000000..ca564bd --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJsonKeras.html @@ -0,0 +1,310 @@ + + + + + + +public class EngineDVFileJsonKeras +extends EngineDVFileJson+
EngineDVFileJson.OsTypeCOMMAND_BASE_APPLY, COMMAND_BASE_TRAIN, corpusRepresentation, dataDir, MODEL_BASENAME, process, WRAPPER_NAMEalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineDVFileJsonKeras() |
+
applyModel, evaluate, getCommandPathApply, getCommandPathTrain, getCorpusRepresentation, getDefaultPythonBin, getOsType, getShellExtension, getWrapperConfig, getWrapperHome, initializeAlgorithm, initWhenCreating, loadAndSetCorpusRepresentation, loadModel, saveCorpusRepresentation, saveModel, trainModel, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineDVFileJsonPyTorch.html b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJsonPyTorch.html new file mode 100644 index 0000000..b514813 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineDVFileJsonPyTorch.html @@ -0,0 +1,310 @@ + + + + + + +public class EngineDVFileJsonPyTorch +extends EngineDVFileJson+
EngineDVFileJson.OsTypeCOMMAND_BASE_APPLY, COMMAND_BASE_TRAIN, corpusRepresentation, dataDir, MODEL_BASENAME, process, WRAPPER_NAMEalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineDVFileJsonPyTorch() |
+
applyModel, evaluate, getCommandPathApply, getCommandPathTrain, getCorpusRepresentation, getDefaultPythonBin, getOsType, getShellExtension, getWrapperConfig, getWrapperHome, initializeAlgorithm, initWhenCreating, loadAndSetCorpusRepresentation, loadModel, saveCorpusRepresentation, saveModel, trainModel, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineKerasWrapper.html b/apidocs/gate/plugin/learningframework/engines/EngineKerasWrapper.html new file mode 100644 index 0000000..43987ed --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineKerasWrapper.html @@ -0,0 +1,317 @@ + + + + + + +public class EngineKerasWrapper +extends EngineMBPythonNetworksBase+
corpusExporter, ENV_WRAPPER_HOME, MODEL_BASENAME, MODEL_INSTANCE, process, PROP_WRAPPER_HOME, SCRIPT_APPLY_BASENAME, SCRIPT_EVAL_BASENAME, SCRIPT_TRAIN_BASENAME, shellcmd, shellparms, WRAPPER_NAME, wrapperhome, YAML_FILE, YAML_SETTING_WRAPPER_HOMEcorpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineKerasWrapper() |
+
applyModel, evaluate, findOutMode, findWrapperCommand, initializeAlgorithm, initWhenCreating, loadModel, saveModel, trainModelgetCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineLibSVM.html b/apidocs/gate/plugin/learningframework/engines/EngineLibSVM.html new file mode 100644 index 0000000..3132335 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineLibSVM.html @@ -0,0 +1,535 @@ + + + + + + +public class EngineLibSVM +extends EngineMB+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineLibSVM() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats)
+Perform an evaluation.
+ |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
void |
+saveModel(File directory) |
+
static void |
+shuffle(int[] idx,
+ Random rgen)
+Shuffle array of indices in place.
+ |
+
void |
+split(libsvm.svm_problem all,
+ libsvm.svm_problem train,
+ libsvm.svm_problem test,
+ int[] idx)
+Fill training and test instances arrays from the full corpus representation.
+ |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
getCorpusRepresentation, initWhenCreating, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringpublic void loadModel(URL directory, + String parms)+
Enginepublic void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class Enginepublic void saveModel(File directory)+ +
public EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+
evaluate in class EnginealgorithmParameters - algorithm parametersevaluationMethod - evaluation methodnumberOfFolds - number of folds, if relevanttrainingFraction - training fraction, if relevantnumberOfRepeats - number of repetitionspublic static void shuffle(int[] idx, + Random rgen)+
idx - array of indicesrgen - random generator instancepublic void split(libsvm.svm_problem all, + libsvm.svm_problem train, + libsvm.svm_problem test, + int[] idx)+
all - full corpus svm representationtrain - training set svm representationtest - test set svm representationidx - indices of instances for the setsCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMB.html b/apidocs/gate/plugin/learningframework/engines/EngineMB.html new file mode 100644 index 0000000..47b4bad --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMB.html @@ -0,0 +1,445 @@ + + + + + + +public abstract class EngineMB +extends Engine+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentationMallet |
+corpusRepresentation |
+
algorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Modifier and Type | +Method and Description | +
|---|---|
CorpusRepresentation |
+getCorpusRepresentation()
+Get the corpus representation for the engine.
+ |
+
protected void |
+initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+loadAndSetCorpusRepresentation(URL directory)
+Re-create the corpus representation we need for this engine.
+ |
+
protected void |
+saveCorpusRepresentation(File directory)
+Save the corpus representation used by the engine instance in some way to the directory.
+ |
+
protected void |
+updateInfo() |
+
applyModel, create, evaluate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initializeAlgorithm, initWhenLoading, load, loadModel, recreateCorpusRepresentation, saveEngine, saveModel, toString, trainModelprotected CorpusRepresentationMallet corpusRepresentation+
public CorpusRepresentation getCorpusRepresentation()+
EnginegetCorpusRepresentation in class Engineprotected void updateInfo()+
protected void saveCorpusRepresentation(File directory)+
EnginesaveCorpusRepresentation in class Enginedirectory - model/data directory URLprotected void loadAndSetCorpusRepresentation(URL directory)+
EngineloadAndSetCorpusRepresentation in class Enginedirectory - model/data directory URLprotected void initWhenCreating(URL directory, + Algorithm algorithm, + String parameters, + FeatureInfo fi, + TargetType tt)+
initWhenCreating in class EngineCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBCostclaWrapper.html b/apidocs/gate/plugin/learningframework/engines/EngineMBCostclaWrapper.html new file mode 100644 index 0000000..72b13a7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBCostclaWrapper.html @@ -0,0 +1,308 @@ + + + + + + +public class EngineMBCostclaWrapper +extends EngineMBSklearnBase+
corpusExporter, ENV_WRAPPER_HOME, MODEL_BASENAME, MODEL_INSTANCE, process, PROP_WRAPPER_HOME, SCRIPT_APPLY_BASENAME, SCRIPT_EVAL_BASENAME, SCRIPT_TRAIN_BASENAME, shellcmd, shellparms, WRAPPER_NAME, wrapperhome, YAML_FILE, YAML_SETTING_WRAPPER_HOMEcorpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBCostclaWrapper() |
+
applyModel, evaluate, findWrapperCommand, initializeAlgorithm, initWhenCreating, loadModel, saveModel, trainModelgetCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBMallet.html b/apidocs/gate/plugin/learningframework/engines/EngineMBMallet.html new file mode 100644 index 0000000..d1817da --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBMallet.html @@ -0,0 +1,347 @@ + + + + + + +public abstract class EngineMBMallet +extends EngineMB+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBMallet() |
+
| Modifier and Type | +Method and Description | +
|---|---|
CorpusRepresentationMallet |
+getCorpusRepresentationMallet() |
+
protected void |
+saveModel(File directory) |
+
getCorpusRepresentation, initWhenCreating, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfoapplyModel, create, evaluate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initializeAlgorithm, initWhenLoading, load, loadModel, recreateCorpusRepresentation, saveEngine, toString, trainModelCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBMalletClass.html b/apidocs/gate/plugin/learningframework/engines/EngineMBMalletClass.html new file mode 100644 index 0000000..e3a9649 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBMalletClass.html @@ -0,0 +1,467 @@ + + + + + + +public class EngineMBMalletClass +extends EngineMBMallet+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBMalletClass() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
getCorpusRepresentationMallet, saveModelgetCorpusRepresentation, initWhenCreating, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringpublic void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class Engineprotected void loadModel(URL directory, + String parms)+
Enginepublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBMalletSeq.html b/apidocs/gate/plugin/learningframework/engines/EngineMBMalletSeq.html new file mode 100644 index 0000000..40570b6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBMalletSeq.html @@ -0,0 +1,494 @@ + + + + + + +public class EngineMBMalletSeq +extends EngineMBMallet+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBMalletSeq() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+loadAndSetCorpusRepresentation(URL directory)
+Re-create the corpus representation we need for this engine.
+ |
+
protected void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
void |
+trainModel(File DataDirectory,
+ String instanceType,
+ String options)
+Train a model from the instances.
+ |
+
getCorpusRepresentationMallet, saveModelgetCorpusRepresentation, initWhenCreating, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringpublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class Enginepublic void trainModel(File DataDirectory, + String instanceType, + String options)+
EnginetrainModel in class EngineDataDirectory - model/data directory URLinstanceType - instance annotation typeoptions - parametersprotected void loadAndSetCorpusRepresentation(URL directory)+
EngineloadAndSetCorpusRepresentation in class EngineMBdirectory - model/data directory URLpublic List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parametersprotected void loadModel(URL directory, + String parms)+
Enginepublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBPythonNetworksBase.html b/apidocs/gate/plugin/learningframework/engines/EngineMBPythonNetworksBase.html new file mode 100644 index 0000000..46172f1 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBPythonNetworksBase.html @@ -0,0 +1,759 @@ + + + + + + +public abstract class EngineMBPythonNetworksBase +extends EngineMB+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusExporter |
+corpusExporter |
+
protected String |
+ENV_WRAPPER_HOME |
+
protected String |
+MODEL_BASENAME |
+
protected Object |
+MODEL_INSTANCE |
+
protected ProcessBase |
+process |
+
protected String |
+PROP_WRAPPER_HOME |
+
protected String |
+SCRIPT_APPLY_BASENAME |
+
protected String |
+SCRIPT_EVAL_BASENAME |
+
protected String |
+SCRIPT_TRAIN_BASENAME |
+
protected String |
+shellcmd |
+
protected String |
+shellparms |
+
protected String |
+WRAPPER_NAME |
+
protected String |
+wrapperhome |
+
protected String |
+YAML_FILE |
+
protected String |
+YAML_SETTING_WRAPPER_HOME |
+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBPythonNetworksBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
protected AbstractMap.SimpleEntry<String,Integer> |
+findOutMode(CorpusRepresentationMalletTarget crm) |
+
protected File |
+findWrapperCommand(File dataDirectory,
+ boolean apply)
+Try to find the script running the Wrapper command.
+ |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+loadModel(URL directoryURL,
+ String parms)
+Load a stored model into the engine.
+ |
+
protected void |
+saveModel(File directory) |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
getCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringprotected String WRAPPER_NAME+
protected String ENV_WRAPPER_HOME+
protected String PROP_WRAPPER_HOME+
protected String YAML_FILE+
protected String YAML_SETTING_WRAPPER_HOME+
protected String SCRIPT_APPLY_BASENAME+
protected String SCRIPT_TRAIN_BASENAME+
protected String SCRIPT_EVAL_BASENAME+
protected String MODEL_BASENAME+
protected Object MODEL_INSTANCE+
protected ProcessBase process+
protected String shellcmd+
protected String shellparms+
protected String wrapperhome+
protected CorpusExporter corpusExporter+
public EngineMBPythonNetworksBase()+
protected void initWhenCreating(URL directory, + Algorithm algorithm, + String parameters, + FeatureInfo fi, + TargetType tt)+
initWhenCreating in class EngineMBprotected File findWrapperCommand(File dataDirectory, + boolean apply)+
dataDirectory - model/data directoryapply - true if apply, otherwise trainprotected void loadModel(URL directoryURL, + String parms)+
Engineprotected void saveModel(File directory)+ +
public void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
public List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class Engineprotected AbstractMap.SimpleEntry<String,Integer> findOutMode(CorpusRepresentationMalletTarget crm)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBServer.html b/apidocs/gate/plugin/learningframework/engines/EngineMBServer.html new file mode 100644 index 0000000..11c69fb --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBServer.html @@ -0,0 +1,528 @@ + + + + + + +public class EngineMBServer +extends EngineMB+
| Modifier and Type | +Field and Description | +
|---|---|
protected String |
+serverUrl |
+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBServer(URL directory,
+ String serverUrl) |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
protected void |
+saveModel(File directory) |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
getCorpusRepresentation, initWhenCreating, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringprotected void loadModel(URL directory, + String parms)+
Engineprotected void saveModel(File directory)+ +
public void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
public List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class EngineCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBSklearnBase.html b/apidocs/gate/plugin/learningframework/engines/EngineMBSklearnBase.html new file mode 100644 index 0000000..95eeca3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBSklearnBase.html @@ -0,0 +1,755 @@ + + + + + + +public abstract class EngineMBSklearnBase +extends EngineMB+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusExporter |
+corpusExporter |
+
protected String |
+ENV_WRAPPER_HOME |
+
protected String |
+MODEL_BASENAME |
+
protected Object |
+MODEL_INSTANCE |
+
protected ProcessBase |
+process |
+
protected String |
+PROP_WRAPPER_HOME |
+
protected String |
+SCRIPT_APPLY_BASENAME |
+
protected String |
+SCRIPT_EVAL_BASENAME |
+
protected String |
+SCRIPT_TRAIN_BASENAME |
+
protected String |
+shellcmd |
+
protected String |
+shellparms |
+
protected String |
+WRAPPER_NAME |
+
protected String |
+wrapperhome |
+
protected String |
+YAML_FILE |
+
protected String |
+YAML_SETTING_WRAPPER_HOME |
+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBSklearnBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
protected File |
+findWrapperCommand(File dataDirectory,
+ boolean apply)
+Try to find the script running the sklearn-Wrapper command.
+ |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+loadModel(URL directoryURL,
+ String parms)
+Load a stored model into the engine.
+ |
+
protected void |
+saveModel(File directory) |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
getCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringprotected String WRAPPER_NAME+
protected String ENV_WRAPPER_HOME+
protected String PROP_WRAPPER_HOME+
protected String YAML_FILE+
protected String YAML_SETTING_WRAPPER_HOME+
protected String SCRIPT_APPLY_BASENAME+
protected String SCRIPT_TRAIN_BASENAME+
protected String SCRIPT_EVAL_BASENAME+
protected String MODEL_BASENAME+
protected Object MODEL_INSTANCE+
protected ProcessBase process+
protected String shellcmd+
protected String shellparms+
protected String wrapperhome+
protected CorpusExporter corpusExporter+
protected void initWhenCreating(URL directory, + Algorithm algorithm, + String parameters, + FeatureInfo fi, + TargetType tt)+
initWhenCreating in class EngineMBprotected File findWrapperCommand(File dataDirectory, + boolean apply)+
dataDirectory - data/model directory fileapply - true for application, false for trainingprotected void loadModel(URL directoryURL, + String parms)+
Engineprotected void saveModel(File directory)+ +
public void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
public List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class EngineCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBSklearnWrapper.html b/apidocs/gate/plugin/learningframework/engines/EngineMBSklearnWrapper.html new file mode 100644 index 0000000..e2b6d43 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBSklearnWrapper.html @@ -0,0 +1,317 @@ + + + + + + +public class EngineMBSklearnWrapper +extends EngineMBSklearnBase+
corpusExporter, ENV_WRAPPER_HOME, MODEL_BASENAME, MODEL_INSTANCE, process, PROP_WRAPPER_HOME, SCRIPT_APPLY_BASENAME, SCRIPT_EVAL_BASENAME, SCRIPT_TRAIN_BASENAME, shellcmd, shellparms, WRAPPER_NAME, wrapperhome, YAML_FILE, YAML_SETTING_WRAPPER_HOMEcorpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBSklearnWrapper() |
+
applyModel, evaluate, findWrapperCommand, initializeAlgorithm, initWhenCreating, loadModel, saveModel, trainModelgetCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBTensorFlowWrapper.html b/apidocs/gate/plugin/learningframework/engines/EngineMBTensorFlowWrapper.html new file mode 100644 index 0000000..25f3fee --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBTensorFlowWrapper.html @@ -0,0 +1,317 @@ + + + + + + +public class EngineMBTensorFlowWrapper +extends EngineMBPythonNetworksBase+
corpusExporter, ENV_WRAPPER_HOME, MODEL_BASENAME, MODEL_INSTANCE, process, PROP_WRAPPER_HOME, SCRIPT_APPLY_BASENAME, SCRIPT_EVAL_BASENAME, SCRIPT_TRAIN_BASENAME, shellcmd, shellparms, WRAPPER_NAME, wrapperhome, YAML_FILE, YAML_SETTING_WRAPPER_HOMEcorpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBTensorFlowWrapper() |
+
applyModel, evaluate, findOutMode, findWrapperCommand, initializeAlgorithm, initWhenCreating, loadModel, saveModel, trainModelgetCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBTopicsLDA.html b/apidocs/gate/plugin/learningframework/engines/EngineMBTopicsLDA.html new file mode 100644 index 0000000..e1ffa76 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBTopicsLDA.html @@ -0,0 +1,660 @@ + + + + + + +public class EngineMBTopicsLDA +extends EngineMBMallet+
| Modifier and Type | +Field and Description | +
|---|---|
protected cc.mallet.topics.ParallelTopicModel |
+tm |
+
protected cc.mallet.topics.TopicModelDiagnostics |
+tmd |
+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBTopicsLDA() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
void |
+applyTopicModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet tokenAS,
+ String tokenFeature,
+ String featurePrefix,
+ String parms) |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
cc.mallet.topics.ParallelTopicModel |
+getTopicModel() |
+
cc.mallet.topics.TopicModelDiagnostics |
+getTopicModelDiagnostics() |
+
List<Map<String,Double>> |
+getTopicWordScores(cc.mallet.topics.ParallelTopicModel tm) |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+initWhenLoading(URL dir,
+ String parms)
+The details of how to initialise a specific instance of an Engine subclass.
+ |
+
protected void |
+loadAndSetCorpusRepresentation(URL directory)
+Re-create the corpus representation we need for this engine.
+ |
+
protected void |
+loadModel(URL directory,
+ String parms)
+Load a stored model into the engine.
+ |
+
void |
+printTopTopicWords(cc.mallet.topics.ParallelTopicModel tm,
+ PrintStream pw,
+ int numTopWords) |
+
protected void |
+saveModel(File directory) |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parmString)
+Train a model from the instances.
+ |
+
getCorpusRepresentationMalletgetCorpusRepresentation, initWhenCreating, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, load, recreateCorpusRepresentation, saveEngine, toStringprotected cc.mallet.topics.TopicModelDiagnostics tmd+
protected cc.mallet.topics.ParallelTopicModel tm+
public cc.mallet.topics.ParallelTopicModel getTopicModel()+
public cc.mallet.topics.TopicModelDiagnostics getTopicModelDiagnostics()+
public List<Map<String,Double>> getTopicWordScores(cc.mallet.topics.ParallelTopicModel tm)+
public void printTopTopicWords(cc.mallet.topics.ParallelTopicModel tm, + PrintStream pw, + int numTopWords)+
public void trainModel(File dataDirectory, + String instanceType, + String parmString)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparmString - parametersprotected void saveModel(File directory)+
saveModel in class EngineMBMalletprotected void loadAndSetCorpusRepresentation(URL directory)+
EngineloadAndSetCorpusRepresentation in class EngineMBdirectory - model/data directory URLprotected void loadModel(URL directory, + String parms)+
Enginepublic List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void applyTopicModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet tokenAS, + String tokenFeature, + String featurePrefix, + String parms)+
public void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class Enginepublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
protected void initWhenLoading(URL dir, + String parms)+
EngineinitWhenLoading in class Enginedir - model/data directory URLparms - algorithm parametersCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EngineMBWekaWrapper.html b/apidocs/gate/plugin/learningframework/engines/EngineMBWekaWrapper.html new file mode 100644 index 0000000..f0b11d3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EngineMBWekaWrapper.html @@ -0,0 +1,567 @@ + + + + + + +public class EngineMBWekaWrapper +extends EngineMB+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusExporter |
+corpusExporter |
+
protected String |
+ENV_WRAPPER_HOME |
+
protected ProcessBase |
+process |
+
corpusRepresentationalgorithm, featureInfo, FILENAME_MODEL, FILENAME_PIPE, info, model, trainer| Constructor and Description | +
|---|
EngineMBWekaWrapper() |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<ModelApplication> |
+applyModel(gate.AnnotationSet instanceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet sequenceAS,
+ String parms)
+Classify all instance annotations.
+ |
+
EvaluationResult |
+evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
void |
+initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+loadModel(URL directoryURL,
+ String parms)
+Load a stored model into the engine.
+ |
+
protected void |
+saveModel(File directory) |
+
void |
+trainModel(File dataDirectory,
+ String instanceType,
+ String parms)
+Train a model from the instances.
+ |
+
getCorpusRepresentation, loadAndSetCorpusRepresentation, saveCorpusRepresentation, updateInfocreate, getAlgorithm, getFeatureInfo, getInfo, getModel, getTrainer, initWhenLoading, load, recreateCorpusRepresentation, saveEngine, toStringprotected ProcessBase process+
protected final String ENV_WRAPPER_HOME+
protected CorpusExporter corpusExporter+
protected void initWhenCreating(URL directory, + Algorithm algorithm, + String parameters, + FeatureInfo fi, + TargetType tt)+
initWhenCreating in class EngineMBprotected void loadModel(URL directoryURL, + String parms)+
Engineprotected void saveModel(File directory)+ +
public void trainModel(File dataDirectory, + String instanceType, + String parms)+
EnginetrainModel in class EnginedataDirectory - model/data directory URLinstanceType - instance annotation typeparms - parameterspublic EvaluationResult evaluate(String algorithmParameters, + EvaluationMethod evaluationMethod, + int numberOfFolds, + double trainingFraction, + int numberOfRepeats)+ +
public List<ModelApplication> applyModel(gate.AnnotationSet instanceAS, + gate.AnnotationSet inputAS, + gate.AnnotationSet sequenceAS, + String parms)+
EngineapplyModel in class EngineinstanceAS - instance annotation setinputAS - input annotation setsequenceAS - sequence annotation setparms - parameterspublic void initializeAlgorithm(Algorithm algorithm, + String parms)+
initializeAlgorithm in class EngineCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResult.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResult.html new file mode 100644 index 0000000..1d994ec --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResult.html @@ -0,0 +1,248 @@ + + + + + + +public class EvaluationResult +extends Object+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResultClHO.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResultClHO.html new file mode 100644 index 0000000..58aef90 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResultClHO.html @@ -0,0 +1,361 @@ + + + + + + +public class EvaluationResultClHO +extends EvaluationResultClassification+
| Modifier and Type | +Field and Description | +
|---|---|
int |
+nrRepeats |
+
boolean |
+stratified |
+
double |
+trainingFraction |
+
accuracyEstimate, nrCorrect, nrIncorrect| Constructor and Description | +
|---|
EvaluationResultClHO() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResultClXval.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResultClXval.html new file mode 100644 index 0000000..9d935e8 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResultClXval.html @@ -0,0 +1,348 @@ + + + + + + +public class EvaluationResultClXval +extends EvaluationResultClassification+
| Modifier and Type | +Field and Description | +
|---|---|
int |
+nrFolds |
+
boolean |
+stratified |
+
accuracyEstimate, nrCorrect, nrIncorrect| Constructor and Description | +
|---|
EvaluationResultClXval() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResultClassification.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResultClassification.html new file mode 100644 index 0000000..b3e3ba7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResultClassification.html @@ -0,0 +1,315 @@ + + + + + + +public abstract class EvaluationResultClassification +extends EvaluationResult+
| Modifier and Type | +Field and Description | +
|---|---|
double |
+accuracyEstimate |
+
int |
+nrCorrect |
+
int |
+nrIncorrect |
+
| Constructor and Description | +
|---|
EvaluationResultClassification() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResultRegression.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResultRegression.html new file mode 100644 index 0000000..a386ab2 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResultRegression.html @@ -0,0 +1,328 @@ + + + + + + +public abstract class EvaluationResultRegression +extends EvaluationResult+
| Modifier and Type | +Field and Description | +
|---|---|
double |
+nrTotal |
+
double |
+rmse |
+
double |
+sumAbsErr |
+
double |
+sumSqrErr |
+
| Constructor and Description | +
|---|
EvaluationResultRegression() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResultRgHO.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResultRgHO.html new file mode 100644 index 0000000..63b7d2b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResultRgHO.html @@ -0,0 +1,348 @@ + + + + + + +public class EvaluationResultRgHO +extends EvaluationResultRegression+
| Modifier and Type | +Field and Description | +
|---|---|
int |
+nrRepeats |
+
double |
+trainingFraction |
+
| Constructor and Description | +
|---|
EvaluationResultRgHO() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/EvaluationResultRgXval.html b/apidocs/gate/plugin/learningframework/engines/EvaluationResultRgXval.html new file mode 100644 index 0000000..bbdf0ba --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/EvaluationResultRgXval.html @@ -0,0 +1,335 @@ + + + + + + +public class EvaluationResultRgXval +extends EvaluationResultRegression+
| Modifier and Type | +Field and Description | +
|---|---|
int |
+nrFolds |
+
| Constructor and Description | +
|---|
EvaluationResultRgXval() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/Info.html b/apidocs/gate/plugin/learningframework/engines/Info.html new file mode 100644 index 0000000..5ec8b85 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/Info.html @@ -0,0 +1,629 @@ + + + + + + +public class Info +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
String |
+algorithmClass |
+
String |
+algorithmName |
+
String |
+classAnnotationType |
+
List<String> |
+classAnnotationTypes |
+
List<String> |
+classLabels |
+
String |
+engineClass |
+
static String |
+FILENAME_INFO |
+
String |
+modelClass |
+
int |
+nrTargetValues |
+
int |
+nrTrainingDimensions |
+
int |
+nrTrainingDocuments |
+
int |
+nrTrainingInstances |
+
String |
+seqEncoderClass |
+
String |
+seqEncoderOptions |
+
String |
+targetFeature |
+
String |
+task |
+
String |
+trainerClass |
+
String |
+trainingCorpusName |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object other)
+TODO: NOTE: this is incomplete!! Should contain all fields that are also in the hashCode method!
+ For now we have only included the fields we need for the unit test.
+ |
+
int |
+hashCode() |
+
static Info |
+load(URL directory)
+Load from directory.
+ |
+
void |
+save(File directory)
+Save to directory.
+ |
+
String |
+toString() |
+
public static final String FILENAME_INFO+
public String engineClass+
public String algorithmClass+
public String algorithmName+
public String trainerClass+
public String modelClass+
public String task+
public int nrTrainingInstances+
public int nrTrainingDocuments+
public int nrTrainingDimensions+
public int nrTargetValues+
public String trainingCorpusName+
public String targetFeature+
public String classAnnotationType+
public String seqEncoderClass+
public String seqEncoderOptions+
public boolean equals(Object other)+
public void save(File directory)+
directory - directory to save to.public static Info load(URL directory)+
directory - directory to load fromCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/Parms.html b/apidocs/gate/plugin/learningframework/engines/Parms.html new file mode 100644 index 0000000..053cc40 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/Parms.html @@ -0,0 +1,372 @@ + + + + + + +public class Parms +extends Object+
| Constructor and Description | +
|---|
Parms(String parmString,
+ String... names)
+Create a Parms object that contains the parsed values from the parmString.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+getValue(String name)
+Get the value of the parameter.
+ |
+
Object |
+getValueOrElse(String name,
+ Object elseValue)
+Get the value of the parameter or some default value/
+ |
+
int |
+size()
+Get number of values.
+ |
+
public Parms(String parmString, + String... names)+
names - strings indicating short/long name and type of parameter to findparmString - string with the parameterspublic Object getValue(String name)+
name - parameter namepublic Object getValueOrElse(String name, + Object elseValue)+
name - parameter nameelseValue - default valuepublic int size()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/Utils4Engines.html b/apidocs/gate/plugin/learningframework/engines/Utils4Engines.html new file mode 100644 index 0000000..33259e0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/Utils4Engines.html @@ -0,0 +1,312 @@ + + + + + + +public class Utils4Engines +extends Object+
| Constructor and Description | +
|---|
Utils4Engines() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+copyResources(File targetDir,
+ String root)
+Copy resources from plugin jar to target directory.
+ |
+
static void |
+copyWrapper(String wrapperName,
+ File targetDirectory)
+Copy wrapper from plugin JAR to directory.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/Algorithm.html b/apidocs/gate/plugin/learningframework/engines/class-use/Algorithm.html new file mode 100644 index 0000000..9ff29b5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/Algorithm.html @@ -0,0 +1,317 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AlgorithmClassification |
+
class |
+AlgorithmClustering |
+
class |
+AlgorithmRegression |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected Algorithm |
+Engine.algorithm |
+
| Modifier and Type | +Method and Description | +
|---|---|
Algorithm |
+Engine.getAlgorithm() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Engine |
+Engine.create(Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType,
+ URL directory)
+A factory method to create a new instance of an engine with the given backend algorithm.
+ |
+
void |
+EngineMBSklearnBase.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineDVFileJson.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineMBPythonNetworksBase.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
abstract void |
+Engine.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineMBTopicsLDA.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineMBWekaWrapper.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineMBMalletClass.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineLibSVM.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineMBMalletSeq.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
void |
+EngineMBServer.initializeAlgorithm(Algorithm algorithm,
+ String parms) |
+
protected void |
+EngineMBSklearnBase.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+EngineDVFileJson.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+EngineMBPythonNetworksBase.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected abstract void |
+Engine.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+EngineMBWekaWrapper.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+EngineMB.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmClassification.html b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmClassification.html new file mode 100644 index 0000000..f1e9ded --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmClassification.html @@ -0,0 +1,226 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmClassification |
+LF_EvaluateClassification.getTrainingAlgorithm() |
+
AlgorithmClassification |
+LF_TrainChunking.getTrainingAlgorithm() |
+
AlgorithmClassification |
+LF_TrainClassification.getTrainingAlgorithm() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_EvaluateClassification.setTrainingAlgorithm(AlgorithmClassification algo) |
+
void |
+LF_TrainChunking.setTrainingAlgorithm(AlgorithmClassification algo) |
+
void |
+LF_TrainClassification.setTrainingAlgorithm(AlgorithmClassification algo) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AlgorithmClassification |
+AlgorithmClassification.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmClassification[] |
+AlgorithmClassification.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmClustering.html b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmClustering.html new file mode 100644 index 0000000..606a0a6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmClustering.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmClustering |
+LF_TrainTopicModel.getTrainingAlgorithm() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_TrainTopicModel.setTrainingAlgorithm(AlgorithmClustering algo) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AlgorithmClustering |
+AlgorithmClustering.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmClustering[] |
+AlgorithmClustering.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmKind.html b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmKind.html new file mode 100644 index 0000000..ece7534 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmKind.html @@ -0,0 +1,217 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+Algorithm.getAlgorithmKind() |
+
AlgorithmKind |
+AlgorithmClustering.getAlgorithmKind() |
+
AlgorithmKind |
+AlgorithmRegression.getAlgorithmKind() |
+
AlgorithmKind |
+AlgorithmClassification.getAlgorithmKind() |
+
static AlgorithmKind |
+AlgorithmKind.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmKind[] |
+AlgorithmKind.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+Exporter.getAlgorithmKind() |
+
AlgorithmKind |
+ExporterText.getAlgorithmKind() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmRegression.html b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmRegression.html new file mode 100644 index 0000000..2ab0698 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/AlgorithmRegression.html @@ -0,0 +1,218 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmRegression |
+LF_EvaluateRegression.getTrainingAlgorithm() |
+
AlgorithmRegression |
+LF_TrainRegression.getTrainingAlgorithm() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_EvaluateRegression.setTrainingAlgorithm(AlgorithmRegression algo) |
+
void |
+LF_TrainRegression.setTrainingAlgorithm(AlgorithmRegression algo) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static AlgorithmRegression |
+AlgorithmRegression.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static AlgorithmRegression[] |
+AlgorithmRegression.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/Engine.html b/apidocs/gate/plugin/learningframework/engines/class-use/Engine.html new file mode 100644 index 0000000..0445873 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/Engine.html @@ -0,0 +1,286 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineDV
+Common base class for all Engines which use the Dense Volatile representation
+ |
+
class |
+EngineDVFileJson
+Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
class |
+EngineDVFileJsonKeras
+Keras wrapper for dense vector representation
+ |
+
class |
+EngineDVFileJsonPyTorch
+Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
class |
+EngineKerasWrapper
+An engine that represents Python Keras through en external process.
+ |
+
class |
+EngineLibSVM |
+
class |
+EngineMB
+Common base class for all Engines which use the Mallet Corpus Representation.
+ |
+
class |
+EngineMBCostclaWrapper |
+
class |
+EngineMBMallet
+Base class for all engines which wrap a Mallet algorithm.
+ |
+
class |
+EngineMBMalletClass |
+
class |
+EngineMBMalletSeq |
+
class |
+EngineMBPythonNetworksBase
+Base class for engines that represent Python Neural Network learning algorithms.
+ |
+
class |
+EngineMBServer
+An engine that represents a server for ML application.
+ |
+
class |
+EngineMBSklearnBase
+An engine that represents Python Scikit Learn through en external process.
+ |
+
class |
+EngineMBSklearnWrapper
+An engine that represents Python Scikit Learn through en external process.
+ |
+
class |
+EngineMBTensorFlowWrapper
+An engine that represents Python TensorFlow through en external process.
+ |
+
class |
+EngineMBTopicsLDA |
+
class |
+EngineMBWekaWrapper
+An engine that represents Weka through en external process.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Engine |
+Engine.create(Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType,
+ URL directory)
+A factory method to create a new instance of an engine with the given backend algorithm.
+ |
+
static Engine |
+Engine.load(URL directory,
+ String parms)
+A factory method to return the engine which is stored in the given directory.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineDV.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDV.html new file mode 100644 index 0000000..4b50d6f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDV.html @@ -0,0 +1,180 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineDVFileJson
+Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
class |
+EngineDVFileJsonKeras
+Keras wrapper for dense vector representation
+ |
+
class |
+EngineDVFileJsonPyTorch
+Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJson.OsType.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJson.OsType.html new file mode 100644 index 0000000..378834e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJson.OsType.html @@ -0,0 +1,181 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
protected EngineDVFileJson.OsType |
+EngineDVFileJson.getOsType()
+Return LINUXLIKE, WINDOWSLIKE, or throw an exception for anything else
+ |
+
static EngineDVFileJson.OsType |
+EngineDVFileJson.OsType.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static EngineDVFileJson.OsType[] |
+EngineDVFileJson.OsType.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJson.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJson.html new file mode 100644 index 0000000..17233a6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJson.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineDVFileJsonKeras
+Keras wrapper for dense vector representation
+ |
+
class |
+EngineDVFileJsonPyTorch
+Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJsonKeras.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJsonKeras.html new file mode 100644 index 0000000..01ec09b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJsonKeras.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJsonPyTorch.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJsonPyTorch.html new file mode 100644 index 0000000..94c869e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineDVFileJsonPyTorch.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineKerasWrapper.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineKerasWrapper.html new file mode 100644 index 0000000..8795014 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineKerasWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineLibSVM.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineLibSVM.html new file mode 100644 index 0000000..a2b3998 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineLibSVM.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMB.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMB.html new file mode 100644 index 0000000..6c4f30b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMB.html @@ -0,0 +1,230 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineKerasWrapper
+An engine that represents Python Keras through en external process.
+ |
+
class |
+EngineLibSVM |
+
class |
+EngineMBCostclaWrapper |
+
class |
+EngineMBMallet
+Base class for all engines which wrap a Mallet algorithm.
+ |
+
class |
+EngineMBMalletClass |
+
class |
+EngineMBMalletSeq |
+
class |
+EngineMBPythonNetworksBase
+Base class for engines that represent Python Neural Network learning algorithms.
+ |
+
class |
+EngineMBServer
+An engine that represents a server for ML application.
+ |
+
class |
+EngineMBSklearnBase
+An engine that represents Python Scikit Learn through en external process.
+ |
+
class |
+EngineMBSklearnWrapper
+An engine that represents Python Scikit Learn through en external process.
+ |
+
class |
+EngineMBTensorFlowWrapper
+An engine that represents Python TensorFlow through en external process.
+ |
+
class |
+EngineMBTopicsLDA |
+
class |
+EngineMBWekaWrapper
+An engine that represents Weka through en external process.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBCostclaWrapper.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBCostclaWrapper.html new file mode 100644 index 0000000..48bffa0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBCostclaWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMallet.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMallet.html new file mode 100644 index 0000000..6a9963e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMallet.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineMBMalletClass |
+
class |
+EngineMBMalletSeq |
+
class |
+EngineMBTopicsLDA |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMalletClass.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMalletClass.html new file mode 100644 index 0000000..a95f69c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMalletClass.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMalletSeq.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMalletSeq.html new file mode 100644 index 0000000..e72dafb --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBMalletSeq.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBPythonNetworksBase.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBPythonNetworksBase.html new file mode 100644 index 0000000..47dd4af --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBPythonNetworksBase.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineKerasWrapper
+An engine that represents Python Keras through en external process.
+ |
+
class |
+EngineMBTensorFlowWrapper
+An engine that represents Python TensorFlow through en external process.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBServer.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBServer.html new file mode 100644 index 0000000..063480f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBServer.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBSklearnBase.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBSklearnBase.html new file mode 100644 index 0000000..8a8531a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBSklearnBase.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EngineMBCostclaWrapper |
+
class |
+EngineMBSklearnWrapper
+An engine that represents Python Scikit Learn through en external process.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBSklearnWrapper.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBSklearnWrapper.html new file mode 100644 index 0000000..9f2ef61 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBSklearnWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBTensorFlowWrapper.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBTensorFlowWrapper.html new file mode 100644 index 0000000..3441901 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBTensorFlowWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBTopicsLDA.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBTopicsLDA.html new file mode 100644 index 0000000..5082eb3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBTopicsLDA.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBWekaWrapper.html b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBWekaWrapper.html new file mode 100644 index 0000000..7daba42 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EngineMBWekaWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResult.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResult.html new file mode 100644 index 0000000..0a8a67b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResult.html @@ -0,0 +1,289 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EvaluationResultClassification
+A class that represents the result of a classification evaluation.
+ |
+
class |
+EvaluationResultClHO
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
class |
+EvaluationResultClXval
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
class |
+EvaluationResultRegression
+A class that represents the result of a classification evaluation.
+ |
+
class |
+EvaluationResultRgHO
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
class |
+EvaluationResultRgXval
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
EvaluationResult |
+EngineMBSklearnBase.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineDVFileJson.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBPythonNetworksBase.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
abstract EvaluationResult |
+Engine.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBTopicsLDA.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBWekaWrapper.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBMalletClass.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineLibSVM.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats)
+Perform an evaluation.
+ |
+
EvaluationResult |
+EngineMBMalletSeq.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
EvaluationResult |
+EngineMBServer.evaluate(String algorithmParameters,
+ EvaluationMethod evaluationMethod,
+ int numberOfFolds,
+ double trainingFraction,
+ int numberOfRepeats) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClHO.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClHO.html new file mode 100644 index 0000000..1de2009 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClHO.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClXval.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClXval.html new file mode 100644 index 0000000..df37306 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClXval.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClassification.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClassification.html new file mode 100644 index 0000000..7c2910e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultClassification.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EvaluationResultClHO
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
class |
+EvaluationResultClXval
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRegression.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRegression.html new file mode 100644 index 0000000..e7e3e15 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRegression.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+EvaluationResultRgHO
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
class |
+EvaluationResultRgXval
+A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRgHO.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRgHO.html new file mode 100644 index 0000000..1c7feab --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRgHO.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRgXval.html b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRgXval.html new file mode 100644 index 0000000..facb058 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/EvaluationResultRgXval.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/Info.html b/apidocs/gate/plugin/learningframework/engines/class-use/Info.html new file mode 100644 index 0000000..a3b0dd7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/Info.html @@ -0,0 +1,249 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected Info |
+Engine.info
+The corpus representation to use with the concrete instance of the engine.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Info |
+Engine.getInfo()
+Return the info instance for this Engine.
+ |
+
static Info |
+Info.load(URL directory)
+Load from directory.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Info |
+CorpusExporterMRTarget.getInfo() |
+
Info |
+CorpusExporterMRCSV.getInfo() |
+
Info |
+CorpusExporterMRSeq.getInfo() |
+
Info |
+CorpusExporterMRLibSVM.getInfo() |
+
Info |
+CorpusExporterMRMatrixMarket2.getInfo() |
+
Info |
+CorpusExporterMRARFF.getInfo() |
+
Info |
+CorpusExporterMRJsonTarget.getInfo() |
+
Info |
+CorpusExporterDRJson.getInfo() |
+
Info |
+CorpusExporterMRJsonSeq.getInfo() |
+
abstract Info |
+CorpusExporter.getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/Parms.html b/apidocs/gate/plugin/learningframework/engines/class-use/Parms.html new file mode 100644 index 0000000..cf189db --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/Parms.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/class-use/Utils4Engines.html b/apidocs/gate/plugin/learningframework/engines/class-use/Utils4Engines.html new file mode 100644 index 0000000..2116dd2 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/class-use/Utils4Engines.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/package-frame.html b/apidocs/gate/plugin/learningframework/engines/package-frame.html new file mode 100644 index 0000000..3db6073 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/package-frame.html @@ -0,0 +1,61 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Algorithm | +
+ All algorithms implement this interface.
+ |
+
| Class | +Description | +
|---|---|
| Engine | +
+ Base class for all engines.
+ |
+
| EngineDV | +
+ Common base class for all Engines which use the Dense Volatile representation
+ |
+
| EngineDVFileJson | +
+ Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
| EngineDVFileJsonKeras | +
+ Keras wrapper for dense vector representation
+ |
+
| EngineDVFileJsonPyTorch | +
+ Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
| EngineKerasWrapper | +
+ An engine that represents Python Keras through en external process.
+ |
+
| EngineLibSVM | ++ |
| EngineMB | +
+ Common base class for all Engines which use the Mallet Corpus Representation.
+ |
+
| EngineMBCostclaWrapper | ++ |
| EngineMBMallet | +
+ Base class for all engines which wrap a Mallet algorithm.
+ |
+
| EngineMBMalletClass | ++ |
| EngineMBMalletSeq | ++ |
| EngineMBPythonNetworksBase | +
+ Base class for engines that represent Python Neural Network learning algorithms.
+ |
+
| EngineMBServer | +
+ An engine that represents a server for ML application.
+ |
+
| EngineMBSklearnBase | +
+ An engine that represents Python Scikit Learn through en external process.
+ |
+
| EngineMBSklearnWrapper | +
+ An engine that represents Python Scikit Learn through en external process.
+ |
+
| EngineMBTensorFlowWrapper | +
+ An engine that represents Python TensorFlow through en external process.
+ |
+
| EngineMBTopicsLDA | ++ |
| EngineMBWekaWrapper | +
+ An engine that represents Weka through en external process.
+ |
+
| EvaluationResult | +
+ Abstraction for the results we get from internal, library-specific evaluation strategies.
+ |
+
| EvaluationResultClassification | +
+ A class that represents the result of a classification evaluation.
+ |
+
| EvaluationResultClHO | +
+ A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
| EvaluationResultClXval | +
+ A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
| EvaluationResultRegression | +
+ A class that represents the result of a classification evaluation.
+ |
+
| EvaluationResultRgHO | +
+ A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
| EvaluationResultRgXval | +
+ A class that represents the result of a crossvalidation or hold-out evaluation.
+ |
+
| Info | +
+ A class that represents the information stored in the info file.
+ |
+
| Parms | +
+ Some utilities to make it easy to extract the values of parameters as needed.
+ |
+
| Utils4Engines | +
+ Class for factoring out static methods that do not fit into the Engine
+ hierarchy.
+ |
+
| Enum | +Description | +
|---|---|
| AlgorithmClassification | ++ |
| AlgorithmClustering | ++ |
| AlgorithmKind | +
+ Describe what task an algorithm is performing.
+ |
+
| AlgorithmRegression | ++ |
| EngineDVFileJson.OsType | +
+ Known OS types.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/package-tree.html b/apidocs/gate/plugin/learningframework/engines/package-tree.html new file mode 100644 index 0000000..6ffc99e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/package-tree.html @@ -0,0 +1,217 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/engines/package-use.html b/apidocs/gate/plugin/learningframework/engines/package-use.html new file mode 100644 index 0000000..25a0e42 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/engines/package-use.html @@ -0,0 +1,286 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| Class and Description | +
|---|
| AlgorithmClassification | +
| AlgorithmClustering | +
| AlgorithmRegression | +
| Class and Description | +
|---|
| Algorithm
+ All algorithms implement this interface.
+ |
+
| AlgorithmClassification | +
| AlgorithmClustering | +
| AlgorithmKind
+ Describe what task an algorithm is performing.
+ |
+
| AlgorithmRegression | +
| Engine
+ Base class for all engines.
+ |
+
| EngineDV
+ Common base class for all Engines which use the Dense Volatile representation
+ |
+
| EngineDVFileJson
+ Common base class for all Engines which are dense, volatile and write JSON to a file.
+ |
+
| EngineDVFileJson.OsType
+ Known OS types.
+ |
+
| EngineMB
+ Common base class for all Engines which use the Mallet Corpus Representation.
+ |
+
| EngineMBMallet
+ Base class for all engines which wrap a Mallet algorithm.
+ |
+
| EngineMBPythonNetworksBase
+ Base class for engines that represent Python Neural Network learning algorithms.
+ |
+
| EngineMBSklearnBase
+ An engine that represents Python Scikit Learn through en external process.
+ |
+
| EvaluationResult
+ Abstraction for the results we get from internal, library-specific evaluation strategies.
+ |
+
| EvaluationResultClassification
+ A class that represents the result of a classification evaluation.
+ |
+
| EvaluationResultRegression
+ A class that represents the result of a classification evaluation.
+ |
+
| Info
+ A class that represents the information stored in the info file.
+ |
+
| Class and Description | +
|---|
| AlgorithmKind
+ Describe what task an algorithm is performing.
+ |
+
| Info
+ A class that represents the information stored in the info file.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporter.html b/apidocs/gate/plugin/learningframework/export/CorpusExporter.html new file mode 100644 index 0000000..860d88f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporter.html @@ -0,0 +1,537 @@ + + + + + + +public abstract class CorpusExporter +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusRepresentation |
+corpusRepresentation |
+
protected URL |
+datadir |
+
protected File |
+dataDirFile |
+
protected Exporter |
+exporter |
+
protected FeatureInfo |
+featureInfo |
+
protected String |
+instanceType |
+
protected String |
+parms |
+
protected TargetType |
+targetType |
+
| Constructor and Description | +
|---|
CorpusExporter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusExporter |
+create(Exporter exporter,
+ String parms,
+ FeatureInfo featureInfo,
+ String instanceType,
+ URL datadir)
+Create a corpus exporter instance for the given Exporter.
+ |
+
abstract void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
CorpusRepresentation |
+getCorpusRepresentation()
+Return a corpus representation ce to use with this exporter.
+ |
+
abstract Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
abstract void |
+initWhenCreating()
+The specific things to do to properly initialize the CorpusExporter ce
+ that got created by the static create method.
+ |
+
void |
+setTargetType(TargetType tt)
+Set the target type to use with this exporter.
+ |
+
protected Exporter exporter+
protected String parms+
protected FeatureInfo featureInfo+
protected TargetType targetType+
protected URL datadir+
protected String instanceType+
protected File dataDirFile+
protected CorpusRepresentation corpusRepresentation+
public static CorpusExporter create(Exporter exporter, + String parms, + FeatureInfo featureInfo, + String instanceType, + URL datadir)+
exporter - exporterparms - parametersfeatureInfo - feature infoinstanceType - instance typedatadir - data directorypublic abstract void initWhenCreating()+
public abstract Info getInfo()+
public abstract void export()+
public void setTargetType(TargetType tt)+
tt - target typepublic CorpusRepresentation getCorpusRepresentation()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterDRJson.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterDRJson.html new file mode 100644 index 0000000..036ab66 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterDRJson.html @@ -0,0 +1,366 @@ + + + + + + +public class CorpusExporterDRJson +extends CorpusExporter+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterDRJson() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
void |
+initWhenCreating()
+The specific things to do to properly initialize the CorpusExporter ce
+ that got created by the static create method.
+ |
+
create, getCorpusRepresentation, setTargetTypepublic void initWhenCreating()+
CorpusExporterinitWhenCreating in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterpublic Info getInfo()+
CorpusExportergetInfo in class CorpusExporterCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMR.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMR.html new file mode 100644 index 0000000..771f441 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMR.html @@ -0,0 +1,332 @@ + + + + + + +public abstract class CorpusExporterMR +extends CorpusExporter+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMR() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+exportMeta() |
+
void |
+initWhenCreating()
+The specific things to do to properly initialize the CorpusExporter ce
+ that got created by the static create method.
+ |
+
create, export, getCorpusRepresentation, getInfo, setTargetTypepublic void initWhenCreating()+
CorpusExporterinitWhenCreating in class CorpusExporterpublic void exportMeta()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRARFF.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRARFF.html new file mode 100644 index 0000000..8dc1248 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRARFF.html @@ -0,0 +1,435 @@ + + + + + + +public class CorpusExporterMRARFF +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRARFF() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+alphabet2Arff(cc.mallet.types.Alphabet alph,
+ MissingValueTreatment mvt)
+Convert alphabet to ARFF declaration string.
+ |
+
static String |
+escape4Arff(String what)
+Escape characters as needed for the ARFF format.
+ |
+
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
String |
+instance2WekaArffLine(cc.mallet.types.Instance inst,
+ Attributes attrs)
+Convert an instance to the ARFF representation.
+ |
+
exportMeta, initWhenCreatingcreate, getCorpusRepresentation, setTargetTypepublic Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterpublic static String escape4Arff(String what)+
what - the string to escapepublic String alphabet2Arff(cc.mallet.types.Alphabet alph, + MissingValueTreatment mvt)+
alph - Mallet alphabetmvt - missing value treatment settingpublic String instance2WekaArffLine(cc.mallet.types.Instance inst, + Attributes attrs)+
inst - instanceattrs - attributesCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRCSV.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRCSV.html new file mode 100644 index 0000000..9085bf7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRCSV.html @@ -0,0 +1,406 @@ + + + + + + +public class CorpusExporterMRCSV +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRCSV() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+escape4CSV(String what)
+Escape routine for the CSV format.
+ |
+
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
String |
+prepare4TSV(String what)
+Change tabs and newline characters to spaces.
+ |
+
exportMeta, initWhenCreatingcreate, getCorpusRepresentation, setTargetTypepublic Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterpublic String escape4CSV(String what)+
what - TODOCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonBase.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonBase.html new file mode 100644 index 0000000..857cba5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonBase.html @@ -0,0 +1,383 @@ + + + + + + +public abstract class CorpusExporterMRJsonBase +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRJsonBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+escape4Json(String str) |
+
static String |
+featureVector2String(cc.mallet.types.FeatureVector fv,
+ int nrFeatures,
+ Attributes attrs,
+ boolean asString)
+Return String representation of the feature vector.
+ |
+
static String |
+target2String(Object target,
+ cc.mallet.types.LabelAlphabet targetAlphabet,
+ boolean asString)
+Convert a target to String representation.
+ |
+
exportMeta, initWhenCreatingcreate, export, getCorpusRepresentation, getInfo, setTargetTypepublic CorpusExporterMRJsonBase()+
public static String featureVector2String(cc.mallet.types.FeatureVector fv, + int nrFeatures, + Attributes attrs, + boolean asString)+
fv - feature vectornrFeatures - number of featuresattrs - attributesasString - value should be represented as a quoted stringpublic static String target2String(Object target, + cc.mallet.types.LabelAlphabet targetAlphabet, + boolean asString)+
target - the targettargetAlphabet - target alphabetasString - value should get represented as quoted stringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonSeq.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonSeq.html new file mode 100644 index 0000000..1dc08c7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonSeq.html @@ -0,0 +1,438 @@ + + + + + + +public class CorpusExporterMRJsonSeq +extends CorpusExporterMRJsonBase+
+ Example with targets: '[[[0.1, 2.3], [1.1, 1.2]], [1, 2]]'
+ Example without targets: '[[[0.1, 2.3], [1.1, 1.2]]]'
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRJsonSeq() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
void |
+initWhenCreating()
+The specific things to do to properly initialize the CorpusExporter ce
+ that got created by the static create method.
+ |
+
String |
+instance2String(cc.mallet.types.Instance inst,
+ cc.mallet.types.LabelAlphabet targetAlphabet,
+ Attributes attrs,
+ int nrFeatures,
+ boolean asString,
+ boolean filterMV)
+Convert instance to string representation.
+ |
+
escape4Json, featureVector2String, target2StringexportMetacreate, getCorpusRepresentation, setTargetTypepublic CorpusExporterMRJsonSeq()+
public Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterpublic String instance2String(cc.mallet.types.Instance inst, + cc.mallet.types.LabelAlphabet targetAlphabet, + Attributes attrs, + int nrFeatures, + boolean asString, + boolean filterMV)+
inst - instancetargetAlphabet - target alphabetattrs - attributesnrFeatures - number of featuresasString - represent as quoted stringfilterMV - filter missing valuespublic void initWhenCreating()+
CorpusExporterinitWhenCreating in class CorpusExporterMRCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonTarget.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonTarget.html new file mode 100644 index 0000000..f8ccef5 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRJsonTarget.html @@ -0,0 +1,415 @@ + + + + + + +public class CorpusExporterMRJsonTarget +extends CorpusExporterMRJsonBase+
+ Example with targets: '[[0.1, 2.3], 1]'
+ Example without targets: '[[0.1, 2.3]]'
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRJsonTarget() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
String |
+instance2String(cc.mallet.types.Instance inst,
+ cc.mallet.types.LabelAlphabet targetAlphabet,
+ Attributes attrs,
+ int nrFeatures,
+ boolean asString,
+ boolean filterMV)
+Convert instance to string.
+ |
+
escape4Json, featureVector2String, target2StringexportMeta, initWhenCreatingcreate, getCorpusRepresentation, setTargetTypepublic CorpusExporterMRJsonTarget()+
public Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterpublic String instance2String(cc.mallet.types.Instance inst, + cc.mallet.types.LabelAlphabet targetAlphabet, + Attributes attrs, + int nrFeatures, + boolean asString, + boolean filterMV)+
inst - instancetargetAlphabet - target alphabetattrs - attributesnrFeatures - number of featuresasString - represent as quoted stringfilterMV - filter missing valuesCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRLibSVM.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRLibSVM.html new file mode 100644 index 0000000..d98809a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRLibSVM.html @@ -0,0 +1,354 @@ + + + + + + +public class CorpusExporterMRLibSVM +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRLibSVM() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
exportMeta, initWhenCreatingcreate, getCorpusRepresentation, setTargetTypepublic CorpusExporterMRLibSVM()+
public Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRMatrixMarket2.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRMatrixMarket2.html new file mode 100644 index 0000000..bdb3dbf --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRMatrixMarket2.html @@ -0,0 +1,356 @@ + + + + + + +public class CorpusExporterMRMatrixMarket2 +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRMatrixMarket2() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
exportMeta, initWhenCreatingcreate, getCorpusRepresentation, setTargetTypepublic CorpusExporterMRMatrixMarket2()+
public Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRSeq.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRSeq.html new file mode 100644 index 0000000..b6b3508 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRSeq.html @@ -0,0 +1,377 @@ + + + + + + +public class CorpusExporterMRSeq +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRSeq() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
void |
+initWhenCreating()
+The specific things to do to properly initialize the CorpusExporter ce
+ that got created by the static create method.
+ |
+
exportMetacreate, getCorpusRepresentation, setTargetTypepublic Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterpublic void initWhenCreating()+
CorpusExporterinitWhenCreating in class CorpusExporterMRCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/CorpusExporterMRTarget.html b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRTarget.html new file mode 100644 index 0000000..172e118 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/CorpusExporterMRTarget.html @@ -0,0 +1,354 @@ + + + + + + +public class CorpusExporterMRTarget +extends CorpusExporterMR+
corpusRepresentation, datadir, dataDirFile, exporter, featureInfo, instanceType, parms, targetType| Constructor and Description | +
|---|
CorpusExporterMRTarget() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+export()
+Export the data to the given directory or finish writing the data
+ if the corpus representation used by this exporter does on-the-fly writing
+ to a file anyway.
+ |
+
Info |
+getInfo()
+Return a new Info object suitable for the data exported.
+ |
+
exportMeta, initWhenCreatingcreate, getCorpusRepresentation, setTargetTypepublic CorpusExporterMRTarget()+
public Info getInfo()+
CorpusExportergetInfo in class CorpusExporterpublic void export()+
CorpusExporterexport in class CorpusExporterCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/Exporter.html b/apidocs/gate/plugin/learningframework/export/Exporter.html new file mode 100644 index 0000000..18c35f0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/Exporter.html @@ -0,0 +1,538 @@ + + + + + + +public enum Exporter +extends Enum<Exporter>+
| Enum Constant and Description | +
|---|
ARFF_CL_MR |
+
ARFF_RG_MR |
+
CSV_CL_MR |
+
CSV_RG_MR |
+
JSON_CL_DR |
+
JSON_CL_MR |
+
JSON_RG_DR |
+
JSON_RG_MR |
+
JSON_SEQ_DR |
+
JSON_SEQ_MR |
+
LibSVM_CL_MR |
+
LibSVM_RG_MR |
+
MatrixMarket2_CL_MR |
+
MatrixMarket2_CLUS_MR |
+
MatrixMatket2_RG_MR |
+
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+getAlgorithmKind() |
+
Class<?> |
+getCorpusExporterClass() |
+
TargetType |
+getTargetType() |
+
static Exporter |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Exporter[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Exporter JSON_CL_DR+
public static final Exporter JSON_RG_DR+
public static final Exporter JSON_SEQ_DR+
public static final Exporter ARFF_CL_MR+
public static final Exporter ARFF_RG_MR+
public static final Exporter CSV_CL_MR+
public static final Exporter CSV_RG_MR+
public static final Exporter JSON_CL_MR+
public static final Exporter JSON_RG_MR+
public static final Exporter JSON_SEQ_MR+
public static final Exporter LibSVM_CL_MR+
public static final Exporter LibSVM_RG_MR+
public static final Exporter MatrixMarket2_CLUS_MR+
public static final Exporter MatrixMarket2_CL_MR+
public static final Exporter MatrixMatket2_RG_MR+
public static Exporter[] values()+
+for (Exporter c : Exporter.values()) + System.out.println(c); +
public static Exporter valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getCorpusExporterClass()+
public TargetType getTargetType()+
public AlgorithmKind getAlgorithmKind()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/ExporterText.html b/apidocs/gate/plugin/learningframework/export/ExporterText.html new file mode 100644 index 0000000..1fe955a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/ExporterText.html @@ -0,0 +1,370 @@ + + + + + + +public enum ExporterText +extends Enum<ExporterText>+
| Enum Constant and Description | +
|---|
TEXTLINE_TSV |
+
| Modifier and Type | +Method and Description | +
|---|---|
AlgorithmKind |
+getAlgorithmKind() |
+
Class<?> |
+getCorpusExporterClass() |
+
TargetType |
+getTargetType() |
+
static ExporterText |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ExporterText[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ExporterText TEXTLINE_TSV+
public static ExporterText[] values()+
+for (ExporterText c : ExporterText.values()) + System.out.println(c); +
public static ExporterText valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getCorpusExporterClass()+
public TargetType getTargetType()+
public AlgorithmKind getAlgorithmKind()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporter.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporter.html new file mode 100644 index 0000000..8ffb286 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporter.html @@ -0,0 +1,271 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected CorpusExporter |
+EngineMBSklearnBase.corpusExporter |
+
protected CorpusExporter |
+EngineMBPythonNetworksBase.corpusExporter |
+
protected CorpusExporter |
+EngineMBWekaWrapper.corpusExporter |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusExporterDRJson
+Common base class of all dense vector / json file representation based exporters
+ |
+
class |
+CorpusExporterMR
+Common base class of all mallet-related exporters.
+ |
+
class |
+CorpusExporterMRARFF |
+
class |
+CorpusExporterMRCSV
+Exporter for comma separated values and tab separated values formats.
+ |
+
class |
+CorpusExporterMRJsonBase
+Base class for the JSON exporter classes.
+ |
+
class |
+CorpusExporterMRJsonSeq
+Exporter (experimental so far!) for exporting sequences in python-readable
+ format.
+ |
+
class |
+CorpusExporterMRJsonTarget
+Exporter (experimental so far!) for exporting feature vectors in python-readable
+ format.
+ |
+
class |
+CorpusExporterMRLibSVM |
+
class |
+CorpusExporterMRMatrixMarket2
+Export data as two files in MatrixMarket format.
+ |
+
class |
+CorpusExporterMRSeq |
+
class |
+CorpusExporterMRTarget |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusExporter |
+CorpusExporter.create(Exporter exporter,
+ String parms,
+ FeatureInfo featureInfo,
+ String instanceType,
+ URL datadir)
+Create a corpus exporter instance for the given Exporter.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterDRJson.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterDRJson.html new file mode 100644 index 0000000..8faf417 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterDRJson.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMR.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMR.html new file mode 100644 index 0000000..83b9f40 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMR.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusExporterMRARFF |
+
class |
+CorpusExporterMRCSV
+Exporter for comma separated values and tab separated values formats.
+ |
+
class |
+CorpusExporterMRJsonBase
+Base class for the JSON exporter classes.
+ |
+
class |
+CorpusExporterMRJsonSeq
+Exporter (experimental so far!) for exporting sequences in python-readable
+ format.
+ |
+
class |
+CorpusExporterMRJsonTarget
+Exporter (experimental so far!) for exporting feature vectors in python-readable
+ format.
+ |
+
class |
+CorpusExporterMRLibSVM |
+
class |
+CorpusExporterMRMatrixMarket2
+Export data as two files in MatrixMarket format.
+ |
+
class |
+CorpusExporterMRSeq |
+
class |
+CorpusExporterMRTarget |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRARFF.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRARFF.html new file mode 100644 index 0000000..ea6bf58 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRARFF.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRCSV.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRCSV.html new file mode 100644 index 0000000..87657da --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRCSV.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonBase.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonBase.html new file mode 100644 index 0000000..e603c22 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonBase.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+CorpusExporterMRJsonSeq
+Exporter (experimental so far!) for exporting sequences in python-readable
+ format.
+ |
+
class |
+CorpusExporterMRJsonTarget
+Exporter (experimental so far!) for exporting feature vectors in python-readable
+ format.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonSeq.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonSeq.html new file mode 100644 index 0000000..0f1a4f7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonSeq.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonTarget.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonTarget.html new file mode 100644 index 0000000..04d20e8 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRJsonTarget.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRLibSVM.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRLibSVM.html new file mode 100644 index 0000000..edd7c24 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRLibSVM.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRMatrixMarket2.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRMatrixMarket2.html new file mode 100644 index 0000000..78eb893 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRMatrixMarket2.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRSeq.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRSeq.html new file mode 100644 index 0000000..9fd736c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRSeq.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRTarget.html b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRTarget.html new file mode 100644 index 0000000..6c864c1 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/CorpusExporterMRTarget.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/Exporter.html b/apidocs/gate/plugin/learningframework/export/class-use/Exporter.html new file mode 100644 index 0000000..dcff37f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/Exporter.html @@ -0,0 +1,242 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Exporter |
+LF_Export.getExporter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_Export.setExporter(Exporter value) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected Exporter |
+CorpusExporter.exporter |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Exporter |
+Exporter.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Exporter[] |
+Exporter.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusExporter |
+CorpusExporter.create(Exporter exporter,
+ String parms,
+ FeatureInfo featureInfo,
+ String instanceType,
+ URL datadir)
+Create a corpus exporter instance for the given Exporter.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/class-use/ExporterText.html b/apidocs/gate/plugin/learningframework/export/class-use/ExporterText.html new file mode 100644 index 0000000..67a1479 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/class-use/ExporterText.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.export | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ExporterText |
+LF_ExportText.getExporter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_ExportText.setExporter(ExporterText value) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static ExporterText |
+ExporterText.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ExporterText[] |
+ExporterText.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/package-frame.html b/apidocs/gate/plugin/learningframework/export/package-frame.html new file mode 100644 index 0000000..d9f1e20 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/package-frame.html @@ -0,0 +1,37 @@ + + + + + + +| Class | +Description | +
|---|---|
| CorpusExporter | ++ |
| CorpusExporterDRJson | +
+ Common base class of all dense vector / json file representation based exporters
+ |
+
| CorpusExporterMR | +
+ Common base class of all mallet-related exporters.
+ |
+
| CorpusExporterMRARFF | ++ |
| CorpusExporterMRCSV | +
+ Exporter for comma separated values and tab separated values formats.
+ |
+
| CorpusExporterMRJsonBase | +
+ Base class for the JSON exporter classes.
+ |
+
| CorpusExporterMRJsonSeq | +
+ Exporter (experimental so far!) for exporting sequences in python-readable
+ format.
+ |
+
| CorpusExporterMRJsonTarget | +
+ Exporter (experimental so far!) for exporting feature vectors in python-readable
+ format.
+ |
+
| CorpusExporterMRLibSVM | ++ |
| CorpusExporterMRMatrixMarket2 | +
+ Export data as two files in MatrixMarket format.
+ |
+
| CorpusExporterMRSeq | ++ |
| CorpusExporterMRTarget | ++ |
| Enum | +Description | +
|---|---|
| Exporter | ++ |
| ExporterText | ++ |
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/package-tree.html b/apidocs/gate/plugin/learningframework/export/package-tree.html new file mode 100644 index 0000000..ae19fba --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/package-tree.html @@ -0,0 +1,172 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/export/package-use.html b/apidocs/gate/plugin/learningframework/export/package-use.html new file mode 100644 index 0000000..55a91c6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/export/package-use.html @@ -0,0 +1,216 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| Class and Description | +
|---|
| Exporter | +
| ExporterText | +
| Class and Description | +
|---|
| CorpusExporter | +
| Class and Description | +
|---|
| CorpusExporter | +
| CorpusExporterMR
+ Common base class of all mallet-related exporters.
+ |
+
| CorpusExporterMRJsonBase
+ Base class for the JSON exporter classes.
+ |
+
| Exporter | +
| ExporterText | +
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/CodeAs.html b/apidocs/gate/plugin/learningframework/features/CodeAs.html new file mode 100644 index 0000000..d88a90e --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/CodeAs.html @@ -0,0 +1,347 @@ + + + + + + +public enum CodeAs +extends Enum<CodeAs>+
| Enum Constant and Description | +
|---|
number |
+
one_of_k |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CodeAs |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static CodeAs[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final CodeAs one_of_k+
public static final CodeAs number+
public static CodeAs[] values()+
+for (CodeAs c : CodeAs.values()) + System.out.println(c); +
public static CodeAs valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/Datatype.html b/apidocs/gate/plugin/learningframework/features/Datatype.html new file mode 100644 index 0000000..1746efe --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/Datatype.html @@ -0,0 +1,359 @@ + + + + + + +public enum Datatype +extends Enum<Datatype>+
| Enum Constant and Description | +
|---|
bool |
+
nominal |
+
numeric |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Datatype |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Datatype[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Datatype nominal+
public static final Datatype numeric+
public static final Datatype bool+
public static Datatype[] values()+
+for (Datatype c : Datatype.values()) + System.out.println(c); +
public static Datatype valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureExtractionBase.html b/apidocs/gate/plugin/learningframework/features/FeatureExtractionBase.html new file mode 100644 index 0000000..0c4e603 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureExtractionBase.html @@ -0,0 +1,662 @@ + + + + + + +public class FeatureExtractionBase +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected static boolean |
+DEBUG_SEQUENCE_CLASS |
+
static String |
+ELEMSEP
+Separates the name of the feature from the element number, if we get the value for a numeric
+ attribute which is a list or array of numeric values.
+ |
+
static String |
+MVVALUE |
+
static String |
+NAMESEP
+Separates the name from any additional information.
+ |
+
static String |
+NGRAMSEP
+Separates the grams in an n-gram with n < 1.
+ |
+
static String |
+PROP_HAVE_MV |
+
static String |
+PROP_IGNORE_HAS_MV |
+
static String |
+SEQ_BEGINNING |
+
static String |
+SEQ_INSIDE |
+
static String |
+SEQ_OUTSIDE |
+
static String |
+START_SYMBOL |
+
static String |
+STOP_SYMBOL |
+
static String |
+TYPESEP
+Separates the type name inside the name from the feature name.
+ |
+
static String |
+VALSEP
+Separates the remainder of the feature name from the part that indicates the value for nominal
+ one-of-k coded features.
+ |
+
| Constructor and Description | +
|---|
FeatureExtractionBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+featureName(FeatureSpecAttribute attr,
+ int listEl)
+Convert a FeatureSpecAttribute instance to its internal feature name.
+ |
+
static String |
+featureNamePrefix(FeatureSpecAttribute attr)
+Convert a FeatureSpecAttribute to the feature name prefix.
+ |
+
static List<Map<String,Object>> |
+featureSpecAttributes2FeatureInfos(List<FeatureSpecAttribute> attrs)
+Create an info map for all named features.
+ |
+
static List<String> |
+featureSpecAttributes2FeatureNames(List<FeatureSpecAttribute> attrs)
+Convert a list of feature specifications to a list of internal feature names.
+ |
+
public static final String TYPESEP+
public static final String NAMESEP+
public static final String VALSEP+
public static final String NGRAMSEP+
public static final String ELEMSEP+
public static final String MVVALUE+
public static final String SEQ_INSIDE+
public static final String SEQ_BEGINNING+
public static final String SEQ_OUTSIDE+
public static final String PROP_HAVE_MV+
public static final String PROP_IGNORE_HAS_MV+
public static final String START_SYMBOL+
public static final String STOP_SYMBOL+
protected static final boolean DEBUG_SEQUENCE_CLASS+
public static String featureName(FeatureSpecAttribute attr, + int listEl)+
attr - attributelistEl - for a list attribute, the element number, otherwise ignoredpublic static String featureNamePrefix(FeatureSpecAttribute attr)+
attr - the feature spec attribute instancepublic static List<String> featureSpecAttributes2FeatureNames(List<FeatureSpecAttribute> attrs)+
attrs - list of feature specification attributespublic static List<Map<String,Object>> featureSpecAttributes2FeatureInfos(List<FeatureSpecAttribute> attrs)+
attrs - list of feature spec attribute instanceCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureExtractionDense.html b/apidocs/gate/plugin/learningframework/features/FeatureExtractionDense.html new file mode 100644 index 0000000..c115b54 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureExtractionDense.html @@ -0,0 +1,478 @@ + + + + + + +public class FeatureExtractionDense +extends FeatureExtractionBase+
DEBUG_SEQUENCE_CLASS, ELEMSEP, MVVALUE, NAMESEP, NGRAMSEP, PROP_HAVE_MV, PROP_IGNORE_HAS_MV, SEQ_BEGINNING, SEQ_INSIDE, SEQ_OUTSIDE, START_SYMBOL, STOP_SYMBOL, TYPESEP, VALSEP| Constructor and Description | +
|---|
FeatureExtractionDense() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+attrName4MlFeature(String mlFeature)
+Return the attribute name part of a ML feature.
+ |
+
static InstanceRepresentation |
+extractClassForSeqTagging(InstanceRepresentation inst,
+ gate.AnnotationSet classAS,
+ gate.Annotation instanceAnnotation,
+ SeqEncoder seqEncoder)
+Extract the class for an instance for sequence tagging.
+ |
+
static InstanceRepresentation |
+extractClassTarget(InstanceRepresentation inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract the class label for the given instance annotation.
+ |
+
static InstanceRepresentation |
+extractFeature(InstanceRepresentation inst,
+ FeatureSpecAttribute att,
+ gate.AnnotationSet inputAS,
+ gate.Annotation instanceAnnotation)
+Dispatch to the proper helper method for extracting a feature of that type.
+ |
+
static InstanceRepresentation |
+extractNumericTarget(InstanceRepresentation inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract a numeric target and update instance representation.
+ |
+
static FeatureSpecAttribute |
+lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes,
+ String mlFeatureName,
+ String instanceType)
+Try and find the attribute that corresponds to the ML featureName.
+ |
+
featureName, featureNamePrefix, featureSpecAttributes2FeatureInfos, featureSpecAttributes2FeatureNamespublic FeatureExtractionDense()+
public static InstanceRepresentation extractFeature(InstanceRepresentation inst, + FeatureSpecAttribute att, + gate.AnnotationSet inputAS, + gate.Annotation instanceAnnotation)+
inst - instance representationatt - attributeinputAS - input annotation setinstanceAnnotation - instance annotationpublic static InstanceRepresentation extractNumericTarget(InstanceRepresentation inst, + String targetFeature, + gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS)+
inst - instance representationtargetFeature - target featureinstanceAnnotation - instance annotationinputAS - input annotation setpublic static InstanceRepresentation extractClassTarget(InstanceRepresentation inst, + String targetFeature, + gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS)+
inst - instance representationtargetFeature - target featureinstanceAnnotation - instance annotationinputAS - input annotation setpublic static InstanceRepresentation extractClassForSeqTagging(InstanceRepresentation inst, + gate.AnnotationSet classAS, + gate.Annotation instanceAnnotation, + SeqEncoder seqEncoder)+
inst - instance representationclassAS - class annotation setinstanceAnnotation - instance annotationseqEncoder - sequence encoderpublic static String attrName4MlFeature(String mlFeature)+
mlFeature - the feature namepublic static FeatureSpecAttribute lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes, + String mlFeatureName, + String instanceType)+
attributes - the attributesmlFeatureName - ML feature nameinstanceType - instance typeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureExtractionMalletSparse.html b/apidocs/gate/plugin/learningframework/features/FeatureExtractionMalletSparse.html new file mode 100644 index 0000000..582f769 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureExtractionMalletSparse.html @@ -0,0 +1,560 @@ + + + + + + +public class FeatureExtractionMalletSparse +extends FeatureExtractionBase+
DEBUG_SEQUENCE_CLASS, ELEMSEP, MVVALUE, NAMESEP, NGRAMSEP, PROP_HAVE_MV, PROP_IGNORE_HAS_MV, SEQ_BEGINNING, SEQ_INSIDE, SEQ_OUTSIDE, START_SYMBOL, STOP_SYMBOL, TYPESEP, VALSEP| Constructor and Description | +
|---|
FeatureExtractionMalletSparse() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+attrName4MlFeature(String mlFeature)
+Return the attribute name part of a ML feature.
+ |
+
static void |
+extractClassForSeqTagging(cc.mallet.types.Instance inst,
+ cc.mallet.types.Alphabet alph,
+ gate.AnnotationSet classAS,
+ gate.Annotation instanceAnnotation,
+ SeqEncoder seqEncoder)
+Extract the class for an instance for sequence tagging.
+ |
+
static void |
+extractClassTarget(cc.mallet.types.Instance inst,
+ cc.mallet.types.Alphabet alphabet,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract the class label for the given instance annotation.
+ |
+
static void |
+extractFeature(cc.mallet.types.Instance inst,
+ FeatureSpecAttribute att,
+ gate.AnnotationSet inputAS,
+ gate.Annotation instanceAnnotation)
+Extract featyre,
+ |
+
static void |
+extractName(cc.mallet.types.Instance inst,
+ gate.Annotation instanceAnnotation,
+ gate.Document doc)
+Extract the exact location of the instance for use as an instance name.
+ |
+
static void |
+extractNumericTarget(cc.mallet.types.Instance inst,
+ String targetFeature,
+ gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS)
+Extract numeric target value.
+ |
+
static boolean |
+ignoreInstanceWithMV(cc.mallet.types.Instance inst)
+Get flag indiciating if we ignore instances with a missing value.
+ |
+
static boolean |
+instanceHasMV(cc.mallet.types.Instance inst)
+Return flag that indicates if the instance does have a missing value.
+ |
+
static FeatureSpecAttribute |
+lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes,
+ String mlFeatureName,
+ String instanceType)
+Try and find the attribute that corresponds to the ML featureName.
+ |
+
featureName, featureNamePrefix, featureSpecAttributes2FeatureInfos, featureSpecAttributes2FeatureNamespublic FeatureExtractionMalletSparse()+
public static void extractFeature(cc.mallet.types.Instance inst, + FeatureSpecAttribute att, + gate.AnnotationSet inputAS, + gate.Annotation instanceAnnotation)+
inst - isntanceatt - attributeinputAS - input annotation setinstanceAnnotation - instance annotationpublic static void extractNumericTarget(cc.mallet.types.Instance inst, + String targetFeature, + gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS)+
inst - instancetargetFeature - target featureinstanceAnnotation - instance annotationinputAS - input annotation setpublic static void extractClassTarget(cc.mallet.types.Instance inst, + cc.mallet.types.Alphabet alphabet, + String targetFeature, + gate.Annotation instanceAnnotation, + gate.AnnotationSet inputAS)+
inst - the instancealphabet - the label alphabet, must be of type LabelAlphabettargetFeature - the target featureinstanceAnnotation - the instance annotationinputAS - input annotation setpublic static void extractClassForSeqTagging(cc.mallet.types.Instance inst, + cc.mallet.types.Alphabet alph, + gate.AnnotationSet classAS, + gate.Annotation instanceAnnotation, + SeqEncoder seqEncoder)+
inst - instancealph - the label alphabet to use, must be an instance of LabelAlphabetclassAS - class annotation setinstanceAnnotation - the instance annotation, e.g. "Token".seqEncoder - sequence encoder instancepublic static boolean ignoreInstanceWithMV(cc.mallet.types.Instance inst)+
inst - instancepublic static boolean instanceHasMV(cc.mallet.types.Instance inst)+
inst - instancepublic static void extractName(cc.mallet.types.Instance inst, + gate.Annotation instanceAnnotation, + gate.Document doc)+
inst - instanceinstanceAnnotation - isntance annotationdoc - documentpublic static String attrName4MlFeature(String mlFeature)+
mlFeature - the feature namepublic static FeatureSpecAttribute lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes, + String mlFeatureName, + String instanceType)+
attributes - the list of feature attributesmlFeatureName - ML feature nameinstanceType - instance typeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureInfo.html b/apidocs/gate/plugin/learningframework/features/FeatureInfo.html new file mode 100644 index 0000000..e0616f8 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureInfo.html @@ -0,0 +1,552 @@ + + + + + + +public class FeatureInfo +extends Object +implements Serializable+
| Modifier and Type | +Field and Description | +
|---|---|
protected List<FeatureSpecAttribute> |
+featureSpecs |
+
protected ScalingMethod |
+globalScalingMethod |
+
protected boolean |
+growthStopped |
+
| Constructor and Description | +
|---|
FeatureInfo()
+Create an instance with an empty list of featureSpecs.
+ |
+
FeatureInfo(FeatureInfo other)
+Create an FeatureInfo instance that is a deep copy of another one.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(FeatureSpecAttribute attr)
+Add a new FeatureSpecAttribut and assign its id.
+ |
+
List<FeatureSpecAttribute> |
+getAttributes()
+Get list of attributes/
+ |
+
ScalingMethod |
+getGlobalScalingMethod()
+Get the global scaling method.
+ |
+
boolean |
+growthStopped()
+Get flag if growth is currently stopped.
+ |
+
static FeatureInfo |
+load(URL dirURL)
+Load feature info from directory.
+ |
+
void |
+save(File dirFile)
+Save instance to the directory.
+ |
+
void |
+setGlobalScalingMethod(ScalingMethod sm)
+Set the global scaling method.
+ |
+
void |
+startGrowth()
+Start growth.
+ |
+
void |
+stopGrowth()
+Stop growth.
+ |
+
String |
+toString() |
+
protected boolean growthStopped+
protected List<FeatureSpecAttribute> featureSpecs+
protected ScalingMethod globalScalingMethod+
public FeatureInfo()+
public FeatureInfo(FeatureInfo other)+
other - instance to copy frompublic void add(FeatureSpecAttribute attr)+
attr - feature spec attributepublic void stopGrowth()+
public void startGrowth()+
public boolean growthStopped()+
public void setGlobalScalingMethod(ScalingMethod sm)+
sm - scaling methodpublic ScalingMethod getGlobalScalingMethod()+
public List<FeatureSpecAttribute> getAttributes()+
public void save(File dirFile)+
dirFile - directory to save topublic static FeatureInfo load(URL dirURL)+
dirURL - directory to load fromCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureSpecAttribute.html b/apidocs/gate/plugin/learningframework/features/FeatureSpecAttribute.html new file mode 100644 index 0000000..72d78ed --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureSpecAttribute.html @@ -0,0 +1,573 @@ + + + + + + +public abstract class FeatureSpecAttribute +extends Object +implements Serializable, Cloneable+
| Modifier and Type | +Field and Description | +
|---|---|
String |
+annType |
+
Datatype |
+datatype |
+
Integer |
+emb_dims |
+
String |
+emb_file |
+
String |
+emb_id |
+
Integer |
+emb_minfreq |
+
String |
+emb_train |
+
String |
+feature |
+
String |
+featureCode |
+
int |
+featureId |
+
String |
+listsep |
+
String |
+missingValueValue |
+
String |
+name |
+
| Constructor and Description | +
|---|
FeatureSpecAttribute() |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecAttribute |
+clone() |
+
String |
+getCode()
+Return the code used to identify the attribute type in a feature name.
+ |
+
Object |
+missingValue()
+Returns the missing value as the proper data type for this attribute.
+ |
+
abstract void |
+startGrowth() |
+
abstract void |
+stopGrowth() |
+
Object |
+toValue(Object val)
+Returns either a String, Double or Boolean for the given Object.
+ |
+
public String annType+
public String feature+
public String name+
public int featureId+
public String missingValueValue+
public Datatype datatype+
public String listsep+
public String featureCode+
public String emb_file+
public String emb_id+
public Integer emb_dims+
public String emb_train+
public Integer emb_minfreq+
public abstract void stopGrowth()+
public abstract void startGrowth()+
public FeatureSpecAttribute clone()+ +
public String getCode()+
public Object missingValue()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureSpecAttributeList.html b/apidocs/gate/plugin/learningframework/features/FeatureSpecAttributeList.html new file mode 100644 index 0000000..3defad4 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureSpecAttributeList.html @@ -0,0 +1,446 @@ + + + + + + +public class FeatureSpecAttributeList +extends FeatureSpecSimpleAttribute +implements Serializable, Cloneable+
| Modifier and Type | +Field and Description | +
|---|---|
int |
+from |
+
int |
+to |
+
alphabet, codeas, featureName4Value, missingValueTreatment, withinTypeannType, datatype, emb_dims, emb_file, emb_id, emb_minfreq, emb_train, feature, featureCode, featureId, listsep, missingValueValue, name| Constructor and Description | +
|---|
FeatureSpecAttributeList(FeatureSpecSimpleAttribute att,
+ String withinType,
+ int from,
+ int to)
+Create an AttributeList instance from a SimpleAttribute plus the from and to values
+ |
+
FeatureSpecAttributeList(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ int from,
+ int to,
+ String withinType,
+ String listsep,
+ String featureName4Value) |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecAttributeList |
+clone() |
+
String |
+toString() |
+
startGrowth, stopGrowthgetCode, missingValue, toValuepublic FeatureSpecAttributeList(String aname, + String type, + String feature, + Datatype datatype, + CodeAs codeas, + MissingValueTreatment missingValueTreatment, + String missingValueValue, + String scalingMethod, + String transformMethod, + int from, + int to, + String withinType, + String listsep, + String featureName4Value)+
public FeatureSpecAttributeList(FeatureSpecSimpleAttribute att, + String withinType, + int from, + int to)+
att - attributewithinType - within typefrom - from indexto - to indexpublic String toString()+
toString in class FeatureSpecSimpleAttributepublic FeatureSpecAttributeList clone()+
clone in class FeatureSpecSimpleAttributeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureSpecNgram.html b/apidocs/gate/plugin/learningframework/features/FeatureSpecNgram.html new file mode 100644 index 0000000..dd03cf6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureSpecNgram.html @@ -0,0 +1,415 @@ + + + + + + +public class FeatureSpecNgram +extends FeatureSpecAttribute +implements Serializable, Cloneable+
| Modifier and Type | +Field and Description | +
|---|---|
String |
+featureName4Value |
+
int |
+number |
+
annType, datatype, emb_dims, emb_file, emb_id, emb_minfreq, emb_train, feature, featureCode, featureId, listsep, missingValueValue, name| Constructor and Description | +
|---|
FeatureSpecNgram(String aname,
+ int number,
+ String type,
+ String feature,
+ String featureName4Value) |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecNgram |
+clone() |
+
void |
+startGrowth() |
+
void |
+stopGrowth() |
+
String |
+toString() |
+
getCode, missingValue, toValuepublic int number+
public String featureName4Value+
public void stopGrowth()+
stopGrowth in class FeatureSpecAttributepublic void startGrowth()+
startGrowth in class FeatureSpecAttributepublic FeatureSpecNgram clone()+
clone in class FeatureSpecAttributeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureSpecSimpleAttribute.html b/apidocs/gate/plugin/learningframework/features/FeatureSpecSimpleAttribute.html new file mode 100644 index 0000000..cc15193 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureSpecSimpleAttribute.html @@ -0,0 +1,490 @@ + + + + + + +public class FeatureSpecSimpleAttribute +extends FeatureSpecAttribute +implements Serializable, Cloneable+
| Modifier and Type | +Field and Description | +
|---|---|
LFAlphabet |
+alphabet |
+
CodeAs |
+codeas |
+
String |
+featureName4Value |
+
MissingValueTreatment |
+missingValueTreatment |
+
String |
+withinType |
+
annType, datatype, emb_dims, emb_file, emb_id, emb_minfreq, emb_train, feature, featureCode, featureId, listsep, missingValueValue, name| Constructor and Description | +
|---|
FeatureSpecSimpleAttribute(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ String withinType,
+ String listsep,
+ String featureName4Value)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecSimpleAttribute |
+clone() |
+
void |
+startGrowth() |
+
void |
+stopGrowth() |
+
String |
+toString() |
+
getCode, missingValue, toValuepublic CodeAs codeas+
public MissingValueTreatment missingValueTreatment+
public LFAlphabet alphabet+
public String withinType+
public String featureName4Value+
public FeatureSpecSimpleAttribute(String aname, + String type, + String feature, + Datatype datatype, + CodeAs codeas, + MissingValueTreatment missingValueTreatment, + String missingValueValue, + String scalingMethod, + String transformMethod, + String withinType, + String listsep, + String featureName4Value)+
aname - attribute nametype - attribute typefeature - feature namedatatype - datatypecodeas - code as settingmissingValueTreatment - missing value treatmentmissingValueValue - missing valuescalingMethod - scalign methodtransformMethod - transformation methodwithinType - withing which sequence typelistsep - list separator stringfeatureName4Value - which feature to get the value frompublic void stopGrowth()+
stopGrowth in class FeatureSpecAttributepublic void startGrowth()+
startGrowth in class FeatureSpecAttributepublic FeatureSpecSimpleAttribute clone()+
clone in class FeatureSpecAttributeCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/FeatureSpecification.html b/apidocs/gate/plugin/learningframework/features/FeatureSpecification.html new file mode 100644 index 0000000..35992a9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/FeatureSpecification.html @@ -0,0 +1,333 @@ + + + + + + +public class FeatureSpecification +extends Object+
| Constructor and Description | +
|---|
FeatureSpecification(File configFile)
+Constructor from File
+ |
+
FeatureSpecification(String configString)
+Constructor from String
+ |
+
FeatureSpecification(URL configFileURL)
+Constructor from URL
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureInfo |
+getFeatureInfo()
+Return the FeatureInfo object for this specification.
+ |
+
public FeatureSpecification(URL configFileURL)+
configFileURL - URL of feature config XML filepublic FeatureSpecification(String configString)+
configString - XML stringpublic FeatureSpecification(File configFile)+
configFile - File for feature config XML filepublic FeatureInfo getFeatureInfo()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/MissingValueTreatment.html b/apidocs/gate/plugin/learningframework/features/MissingValueTreatment.html new file mode 100644 index 0000000..c346ed7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/MissingValueTreatment.html @@ -0,0 +1,437 @@ + + + + + + +public enum MissingValueTreatment +extends Enum<MissingValueTreatment>+
| Enum Constant and Description | +
|---|
ignore_instance |
+
impute_median |
+
impute_mostfreq |
+
keep |
+
special_value |
+
use_value |
+
zero_value |
+
| Modifier and Type | +Method and Description | +
|---|---|
static MissingValueTreatment |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static MissingValueTreatment[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final MissingValueTreatment ignore_instance+
public static final MissingValueTreatment keep+
public static final MissingValueTreatment special_value+
public static final MissingValueTreatment zero_value+
public static final MissingValueTreatment impute_mostfreq+
public static final MissingValueTreatment impute_median+
public static final MissingValueTreatment use_value+
public static MissingValueTreatment[] values()+
+for (MissingValueTreatment c : MissingValueTreatment.values()) + System.out.println(c); +
public static MissingValueTreatment valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/SeqEncoder.html b/apidocs/gate/plugin/learningframework/features/SeqEncoder.html new file mode 100644 index 0000000..194457b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/SeqEncoder.html @@ -0,0 +1,489 @@ + + + + + + +public abstract class SeqEncoder +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+CODE_BEGIN |
+
static String |
+CODE_END |
+
static String |
+CODE_INSIDE |
+
static String |
+CODE_OUTSIDE |
+
static String |
+CODE_SINGLE |
+
static String |
+CODESEP |
+
static String |
+CODESEP_PATTERN |
+
static String |
+TYPESEP |
+
static String |
+TYPESEP_PATTERN |
+
| Constructor and Description | +
|---|
SeqEncoder() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Map<String,String> |
+getOptions()
+Return options.
+ |
+
abstract String |
+seqAnns2ClassLabel(Collection<gate.Annotation> seqAnns,
+ gate.Annotation instAnn,
+ gate.Document curDoc) |
+
void |
+setOptions(Map<String,String> options) |
+
public static final String CODESEP+
public static final String CODESEP_PATTERN+
public static final String TYPESEP+
public static final String TYPESEP_PATTERN+
public static final String CODE_OUTSIDE+
public static final String CODE_BEGIN+
public static final String CODE_INSIDE+
public static final String CODE_END+
public static final String CODE_SINGLE+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/SeqEncoderEnum.html b/apidocs/gate/plugin/learningframework/features/SeqEncoderEnum.html new file mode 100644 index 0000000..bdc46a9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/SeqEncoderEnum.html @@ -0,0 +1,361 @@ + + + + + + +public enum SeqEncoderEnum +extends Enum<SeqEncoderEnum>+
| Modifier and Type | +Method and Description | +
|---|---|
Class<?> |
+getEncoderClass() |
+
Map<String,String> |
+getOptions() |
+
static SeqEncoderEnum |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static SeqEncoderEnum[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final SeqEncoderEnum BIO+
public static SeqEncoderEnum[] values()+
+for (SeqEncoderEnum c : SeqEncoderEnum.values()) + System.out.println(c); +
public static SeqEncoderEnum valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic Class<?> getEncoderClass()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/SeqEncoder_SimpleBIO.html b/apidocs/gate/plugin/learningframework/features/SeqEncoder_SimpleBIO.html new file mode 100644 index 0000000..024573c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/SeqEncoder_SimpleBIO.html @@ -0,0 +1,313 @@ + + + + + + +public class SeqEncoder_SimpleBIO +extends SeqEncoder+
CODE_BEGIN, CODE_END, CODE_INSIDE, CODE_OUTSIDE, CODE_SINGLE, CODESEP, CODESEP_PATTERN, TYPESEP, TYPESEP_PATTERN| Constructor and Description | +
|---|
SeqEncoder_SimpleBIO() |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+seqAnns2ClassLabel(Collection<gate.Annotation> seqAnns,
+ gate.Annotation instAnn,
+ gate.Document curDoc) |
+
getOptions, setOptionspublic String seqAnns2ClassLabel(Collection<gate.Annotation> seqAnns, + gate.Annotation instAnn, + gate.Document curDoc)+
seqAnns2ClassLabel in class SeqEncoderCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/TargetType.html b/apidocs/gate/plugin/learningframework/features/TargetType.html new file mode 100644 index 0000000..dcabcea --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/TargetType.html @@ -0,0 +1,359 @@ + + + + + + +public enum TargetType +extends Enum<TargetType>+
| Enum Constant and Description | +
|---|
NOMINAL |
+
NONE |
+
NUMERIC |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TargetType |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static TargetType[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final TargetType NUMERIC+
public static final TargetType NOMINAL+
public static final TargetType NONE+
public static TargetType[] values()+
+for (TargetType c : TargetType.values()) + System.out.println(c); +
public static TargetType valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/CodeAs.html b/apidocs/gate/plugin/learningframework/features/class-use/CodeAs.html new file mode 100644 index 0000000..0517d52 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/CodeAs.html @@ -0,0 +1,268 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
CodeAs |
+Attribute.codeAs
+If the attribute/feature is nominal, how the value is coded
+ |
+
| Constructor and Description | +
|---|
Attribute(String name,
+ int index,
+ Datatype datatype,
+ CodeAs codeAs,
+ MissingValueTreatment mvt,
+ LFAlphabet alphabet) |
+
| Modifier and Type | +Field and Description | +
|---|---|
CodeAs |
+FeatureSpecSimpleAttribute.codeas |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CodeAs |
+CodeAs.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static CodeAs[] |
+CodeAs.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Constructor and Description | +
|---|
FeatureSpecAttributeList(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ int from,
+ int to,
+ String withinType,
+ String listsep,
+ String featureName4Value) |
+
FeatureSpecSimpleAttribute(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ String withinType,
+ String listsep,
+ String featureName4Value)
+Constructor
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/Datatype.html b/apidocs/gate/plugin/learningframework/features/class-use/Datatype.html new file mode 100644 index 0000000..36ed594 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/Datatype.html @@ -0,0 +1,268 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
Datatype |
+Attribute.datatype
+The type of the values of the attribute/feature
+ |
+
| Constructor and Description | +
|---|
Attribute(String name,
+ int index,
+ Datatype datatype,
+ CodeAs codeAs,
+ MissingValueTreatment mvt,
+ LFAlphabet alphabet) |
+
| Modifier and Type | +Field and Description | +
|---|---|
Datatype |
+FeatureSpecAttribute.datatype |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Datatype |
+Datatype.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Datatype[] |
+Datatype.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Constructor and Description | +
|---|
FeatureSpecAttributeList(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ int from,
+ int to,
+ String withinType,
+ String listsep,
+ String featureName4Value) |
+
FeatureSpecSimpleAttribute(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ String withinType,
+ String listsep,
+ String featureName4Value)
+Constructor
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionBase.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionBase.html new file mode 100644 index 0000000..20ed596 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionBase.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FeatureExtractionDense
+Code for extracting features from a document based on a FeatureInfo into a dense representation.
+ |
+
class |
+FeatureExtractionMalletSparse
+Code for extracting features from a document based on a FeatureInfo.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionDense.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionDense.html new file mode 100644 index 0000000..4683354 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionDense.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionMalletSparse.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionMalletSparse.html new file mode 100644 index 0000000..af002d0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureExtractionMalletSparse.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureInfo.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureInfo.html new file mode 100644 index 0000000..782f235 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureInfo.html @@ -0,0 +1,430 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| gate.plugin.learningframework.features | ++ |
| gate.plugin.learningframework.mallet | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected FeatureInfo |
+CorpusRepresentationMalletRelated.featureInfo |
+
| Constructor and Description | +
|---|
CorpusRepresentationMalletLDA(FeatureInfo fi) |
+
CorpusRepresentationMalletSeq(FeatureInfo fi) |
+
CorpusRepresentationMalletTarget(FeatureInfo fi,
+ TargetType targetType)
+Constructor for creating a new CorpusRepresentation from a FeatureInfo.
+ |
+
CorpusRepresentationVolatileDense2JsonStream(File outDir,
+ FeatureInfo featureInfo)
+The constructor needs to specify the file where to save the instances to.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected FeatureInfo |
+Engine.featureInfo |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureInfo |
+Engine.getFeatureInfo() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Engine |
+Engine.create(Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType,
+ URL directory)
+A factory method to create a new instance of an engine with the given backend algorithm.
+ |
+
protected void |
+EngineMBSklearnBase.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+EngineDVFileJson.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+EngineMBPythonNetworksBase.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected abstract void |
+Engine.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+EngineMBWekaWrapper.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+EngineMB.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected FeatureInfo |
+CorpusExporter.featureInfo |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CorpusExporter |
+CorpusExporter.create(Exporter exporter,
+ String parms,
+ FeatureInfo featureInfo,
+ String instanceType,
+ URL datadir)
+Create a corpus exporter instance for the given Exporter.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureInfo |
+FeatureSpecification.getFeatureInfo()
+Return the FeatureInfo object for this specification.
+ |
+
static FeatureInfo |
+FeatureInfo.load(URL dirURL)
+Load feature info from directory.
+ |
+
| Constructor and Description | +
|---|
FeatureInfo(FeatureInfo other)
+Create an FeatureInfo instance that is a deep copy of another one.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected FeatureInfo |
+LFPipe.featureInfo |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureInfo |
+LFPipe.getFeatureInfo()
+Get the feature info.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LFPipe.setFeatureInfo(FeatureInfo info)
+Set the feature info.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecAttribute.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecAttribute.html new file mode 100644 index 0000000..168a1bc --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecAttribute.html @@ -0,0 +1,314 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FeatureSpecAttributeList |
+
class |
+FeatureSpecNgram |
+
class |
+FeatureSpecSimpleAttribute |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected List<FeatureSpecAttribute> |
+FeatureInfo.featureSpecs |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecAttribute |
+FeatureSpecAttribute.clone() |
+
static FeatureSpecAttribute |
+FeatureExtractionDense.lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes,
+ String mlFeatureName,
+ String instanceType)
+Try and find the attribute that corresponds to the ML featureName.
+ |
+
static FeatureSpecAttribute |
+FeatureExtractionMalletSparse.lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes,
+ String mlFeatureName,
+ String instanceType)
+Try and find the attribute that corresponds to the ML featureName.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<FeatureSpecAttribute> |
+FeatureInfo.getAttributes()
+Get list of attributes/
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+FeatureInfo.add(FeatureSpecAttribute attr)
+Add a new FeatureSpecAttribut and assign its id.
+ |
+
static void |
+FeatureExtractionMalletSparse.extractFeature(cc.mallet.types.Instance inst,
+ FeatureSpecAttribute att,
+ gate.AnnotationSet inputAS,
+ gate.Annotation instanceAnnotation)
+Extract featyre,
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractFeature(InstanceRepresentation inst,
+ FeatureSpecAttribute att,
+ gate.AnnotationSet inputAS,
+ gate.Annotation instanceAnnotation)
+Dispatch to the proper helper method for extracting a feature of that type.
+ |
+
static String |
+FeatureExtractionBase.featureName(FeatureSpecAttribute attr,
+ int listEl)
+Convert a FeatureSpecAttribute instance to its internal feature name.
+ |
+
static String |
+FeatureExtractionBase.featureNamePrefix(FeatureSpecAttribute attr)
+Convert a FeatureSpecAttribute to the feature name prefix.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static List<Map<String,Object>> |
+FeatureExtractionBase.featureSpecAttributes2FeatureInfos(List<FeatureSpecAttribute> attrs)
+Create an info map for all named features.
+ |
+
static List<String> |
+FeatureExtractionBase.featureSpecAttributes2FeatureNames(List<FeatureSpecAttribute> attrs)
+Convert a list of feature specifications to a list of internal feature names.
+ |
+
static FeatureSpecAttribute |
+FeatureExtractionDense.lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes,
+ String mlFeatureName,
+ String instanceType)
+Try and find the attribute that corresponds to the ML featureName.
+ |
+
static FeatureSpecAttribute |
+FeatureExtractionMalletSparse.lookupAttributeForFeatureName(List<FeatureSpecAttribute> attributes,
+ String mlFeatureName,
+ String instanceType)
+Try and find the attribute that corresponds to the ML featureName.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecAttributeList.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecAttributeList.html new file mode 100644 index 0000000..cf16acb --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecAttributeList.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecAttributeList |
+FeatureSpecAttributeList.clone() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecNgram.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecNgram.html new file mode 100644 index 0000000..6836d56 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecNgram.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecNgram |
+FeatureSpecNgram.clone() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecSimpleAttribute.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecSimpleAttribute.html new file mode 100644 index 0000000..b11dd90 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecSimpleAttribute.html @@ -0,0 +1,195 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FeatureSpecAttributeList |
+
| Modifier and Type | +Method and Description | +
|---|---|
FeatureSpecSimpleAttribute |
+FeatureSpecSimpleAttribute.clone() |
+
| Constructor and Description | +
|---|
FeatureSpecAttributeList(FeatureSpecSimpleAttribute att,
+ String withinType,
+ int from,
+ int to)
+Create an AttributeList instance from a SimpleAttribute plus the from and to values
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecification.html b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecification.html new file mode 100644 index 0000000..d922b26 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/FeatureSpecification.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/MissingValueTreatment.html b/apidocs/gate/plugin/learningframework/features/class-use/MissingValueTreatment.html new file mode 100644 index 0000000..6e507cc --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/MissingValueTreatment.html @@ -0,0 +1,291 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.export | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
MissingValueTreatment |
+Attribute.mvTreatment |
+
| Constructor and Description | +
|---|
Attribute(String name,
+ int index,
+ Datatype datatype,
+ CodeAs codeAs,
+ MissingValueTreatment mvt,
+ LFAlphabet alphabet) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+CorpusExporterMRARFF.alphabet2Arff(cc.mallet.types.Alphabet alph,
+ MissingValueTreatment mvt)
+Convert alphabet to ARFF declaration string.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
MissingValueTreatment |
+FeatureSpecSimpleAttribute.missingValueTreatment |
+
| Modifier and Type | +Method and Description | +
|---|---|
static MissingValueTreatment |
+MissingValueTreatment.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static MissingValueTreatment[] |
+MissingValueTreatment.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Constructor and Description | +
|---|
FeatureSpecAttributeList(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ int from,
+ int to,
+ String withinType,
+ String listsep,
+ String featureName4Value) |
+
FeatureSpecSimpleAttribute(String aname,
+ String type,
+ String feature,
+ Datatype datatype,
+ CodeAs codeas,
+ MissingValueTreatment missingValueTreatment,
+ String missingValueValue,
+ String scalingMethod,
+ String transformMethod,
+ String withinType,
+ String listsep,
+ String featureName4Value)
+Constructor
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoder.html b/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoder.html new file mode 100644 index 0000000..6545e5a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoder.html @@ -0,0 +1,370 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+ModelApplication.addSurroundingAnnotations(gate.AnnotationSet unused,
+ gate.AnnotationSet instanceAS,
+ gate.AnnotationSet outputAS,
+ String outputAnnType,
+ Double minConfidence,
+ SeqEncoder seqEncoder)
+From an annotation set with e.g.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+CorpusRepresentationVolatileDense2JsonStream.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances from the document.
+ |
+
void |
+CorpusRepresentationLibSVM.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
void |
+CorpusRepresentationMalletLDA.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String tokenFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
void |
+CorpusRepresentationMalletTarget.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
void |
+CorpusRepresentationMalletSeq.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
abstract void |
+CorpusRepresentationVolatileBase.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
abstract void |
+CorpusRepresentation.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
cc.mallet.types.Instance |
+CorpusRepresentationMalletSeq.getInstanceForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Get a single Instance for a sequence annotation.
+ |
+
List<InstanceRepresentation> |
+CorpusRepresentationVolatileDense2JsonStream.instancesForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ SeqEncoder seqEncoder) |
+
InstanceRepresentation |
+CorpusRepresentationVolatileDense2JsonStream.labeledAnnotation2Instance(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ SeqEncoder seqEncoder)
+Convert a labeled instance annotation to an instance representation.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SeqEncoder_SimpleBIO
+Class for implementing methods to convert sequences to classes and back
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+FeatureExtractionMalletSparse.extractClassForSeqTagging(cc.mallet.types.Instance inst,
+ cc.mallet.types.Alphabet alph,
+ gate.AnnotationSet classAS,
+ gate.Annotation instanceAnnotation,
+ SeqEncoder seqEncoder)
+Extract the class for an instance for sequence tagging.
+ |
+
static InstanceRepresentation |
+FeatureExtractionDense.extractClassForSeqTagging(InstanceRepresentation inst,
+ gate.AnnotationSet classAS,
+ gate.Annotation instanceAnnotation,
+ SeqEncoder seqEncoder)
+Extract the class for an instance for sequence tagging.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoderEnum.html b/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoderEnum.html new file mode 100644 index 0000000..7b16ea3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoderEnum.html @@ -0,0 +1,222 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
SeqEncoderEnum |
+LF_Export.getSeqEncoder() |
+
SeqEncoderEnum |
+LF_TrainChunking.getSeqEncoder() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_Export.setSeqEncoder(SeqEncoderEnum val)
+The sequence to classification algorithm to use.
+ |
+
void |
+LF_TrainChunking.setSeqEncoder(SeqEncoderEnum val)
+The algorithm to create classification labels from chunks to use.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static SeqEncoderEnum |
+SeqEncoderEnum.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static SeqEncoderEnum[] |
+SeqEncoderEnum.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoder_SimpleBIO.html b/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoder_SimpleBIO.html new file mode 100644 index 0000000..2c57247 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/SeqEncoder_SimpleBIO.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/class-use/TargetType.html b/apidocs/gate/plugin/learningframework/features/class-use/TargetType.html new file mode 100644 index 0000000..ebdd94c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/class-use/TargetType.html @@ -0,0 +1,554 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| gate.plugin.learningframework.features | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected TargetType |
+LF_Export.targetType |
+
| Modifier and Type | +Method and Description | +
|---|---|
TargetType |
+LF_Export.getTargetType() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LF_Export.setTargetType(TargetType val) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected TargetType |
+CorpusRepresentation.targetType |
+
| Modifier and Type | +Method and Description | +
|---|---|
TargetType |
+CorpusRepresentationLibSVM.getTargetType() |
+
TargetType |
+CorpusRepresentation.getTargetType()
+Get the target type set for this corpus.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+CorpusRepresentationVolatileDense2JsonStream.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances from the document.
+ |
+
void |
+CorpusRepresentationLibSVM.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
void |
+CorpusRepresentationMalletLDA.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String tokenFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
void |
+CorpusRepresentationMalletTarget.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
void |
+CorpusRepresentationMalletSeq.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Add instances.
+ |
+
abstract void |
+CorpusRepresentationVolatileBase.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
abstract void |
+CorpusRepresentation.add(gate.AnnotationSet instancesAS,
+ gate.AnnotationSet sequenceAS,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ String nameFeatureName,
+ SeqEncoder seqEncoder) |
+
cc.mallet.types.Instance |
+CorpusRepresentationMalletSeq.getInstanceForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String nameFeatureName,
+ SeqEncoder seqEncoder)
+Get a single Instance for a sequence annotation.
+ |
+
List<InstanceRepresentation> |
+CorpusRepresentationVolatileDense2JsonStream.instancesForSequence(gate.AnnotationSet instancesAS,
+ gate.Annotation sequenceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ SeqEncoder seqEncoder) |
+
InstanceRepresentation |
+CorpusRepresentationVolatileDense2JsonStream.labeledAnnotation2Instance(gate.Annotation instanceAnnotation,
+ gate.AnnotationSet inputAS,
+ gate.AnnotationSet classAS,
+ String targetFeatureName,
+ TargetType targetType,
+ String instanceWeightFeature,
+ SeqEncoder seqEncoder)
+Convert a labeled instance annotation to an instance representation.
+ |
+
void |
+CorpusRepresentationLibSVM.setTargetType(TargetType val) |
+
void |
+CorpusRepresentation.setTargetType(TargetType val)
+Set the target type for the corpus representation.
+ |
+
| Constructor and Description | +
|---|
CorpusRepresentationMalletTarget(FeatureInfo fi,
+ TargetType targetType)
+Constructor for creating a new CorpusRepresentation from a FeatureInfo.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Engine |
+Engine.create(Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType,
+ URL directory)
+A factory method to create a new instance of an engine with the given backend algorithm.
+ |
+
protected void |
+EngineMBSklearnBase.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+EngineDVFileJson.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+EngineMBPythonNetworksBase.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected abstract void |
+Engine.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parms,
+ FeatureInfo featureInfo,
+ TargetType targetType) |
+
protected void |
+EngineMBWekaWrapper.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
protected void |
+EngineMB.initWhenCreating(URL directory,
+ Algorithm algorithm,
+ String parameters,
+ FeatureInfo fi,
+ TargetType tt) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected TargetType |
+CorpusExporter.targetType |
+
| Modifier and Type | +Method and Description | +
|---|---|
TargetType |
+Exporter.getTargetType() |
+
TargetType |
+ExporterText.getTargetType() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+CorpusExporter.setTargetType(TargetType tt)
+Set the target type to use with this exporter.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TargetType |
+TargetType.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static TargetType[] |
+TargetType.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/package-frame.html b/apidocs/gate/plugin/learningframework/features/package-frame.html new file mode 100644 index 0000000..4a780cd --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/package-frame.html @@ -0,0 +1,39 @@ + + + + + + +| Class | +Description | +
|---|---|
| FeatureExtractionBase | +
+ Base class for the FeatureExtraction classes.
+ |
+
| FeatureExtractionDense | +
+ Code for extracting features from a document based on a FeatureInfo into a dense representation.
+ |
+
| FeatureExtractionMalletSparse | +
+ Code for extracting features from a document based on a FeatureInfo.
+ |
+
| FeatureInfo | +
+ This contains the information from the parsed FeatureSpecification plus additional information
+ accumulated during the extraction of a corpus.
+ |
+
| FeatureSpecAttribute | ++ |
| FeatureSpecAttributeList | ++ |
| FeatureSpecification | +
+ Parse a feature specification and create an initial FeatureInfo object.
+ |
+
| FeatureSpecNgram | ++ |
| FeatureSpecSimpleAttribute | ++ |
| SeqEncoder | +
+ Class for implementing methods to convert sequences to classes and back
+ |
+
| SeqEncoder_SimpleBIO | +
+ Class for implementing methods to convert sequences to classes and back
+ |
+
| Enum | +Description | +
|---|---|
| CodeAs | ++ |
| Datatype | ++ |
| MissingValueTreatment | +
+ How to treat/represent missing values when creating the instances.
+ |
+
| SeqEncoderEnum | ++ |
| TargetType | ++ |
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/package-tree.html b/apidocs/gate/plugin/learningframework/features/package-tree.html new file mode 100644 index 0000000..e17adb9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/package-tree.html @@ -0,0 +1,177 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/features/package-use.html b/apidocs/gate/plugin/learningframework/features/package-use.html new file mode 100644 index 0000000..17a9b06 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/features/package-use.html @@ -0,0 +1,346 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| gate.plugin.learningframework.features | ++ |
| gate.plugin.learningframework.mallet | ++ |
| Class and Description | +
|---|
| SeqEncoder
+ Class for implementing methods to convert sequences to classes and back
+ |
+
| SeqEncoderEnum | +
| TargetType | +
| Class and Description | +
|---|
| CodeAs | +
| Datatype | +
| FeatureInfo
+ This contains the information from the parsed FeatureSpecification plus additional information
+ accumulated during the extraction of a corpus.
+ |
+
| MissingValueTreatment
+ How to treat/represent missing values when creating the instances.
+ |
+
| SeqEncoder
+ Class for implementing methods to convert sequences to classes and back
+ |
+
| TargetType | +
| Class and Description | +
|---|
| FeatureInfo
+ This contains the information from the parsed FeatureSpecification plus additional information
+ accumulated during the extraction of a corpus.
+ |
+
| TargetType | +
| Class and Description | +
|---|
| FeatureInfo
+ This contains the information from the parsed FeatureSpecification plus additional information
+ accumulated during the extraction of a corpus.
+ |
+
| MissingValueTreatment
+ How to treat/represent missing values when creating the instances.
+ |
+
| TargetType | +
| Class and Description | +
|---|
| CodeAs | +
| Datatype | +
| FeatureExtractionBase
+ Base class for the FeatureExtraction classes.
+ |
+
| FeatureInfo
+ This contains the information from the parsed FeatureSpecification plus additional information
+ accumulated during the extraction of a corpus.
+ |
+
| FeatureSpecAttribute | +
| FeatureSpecAttributeList | +
| FeatureSpecNgram | +
| FeatureSpecSimpleAttribute | +
| MissingValueTreatment
+ How to treat/represent missing values when creating the instances.
+ |
+
| SeqEncoder
+ Class for implementing methods to convert sequences to classes and back
+ |
+
| SeqEncoderEnum | +
| TargetType | +
| Class and Description | +
|---|
| FeatureInfo
+ This contains the information from the parsed FeatureSpecification plus additional information
+ accumulated during the extraction of a corpus.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/LFAlphabet.html b/apidocs/gate/plugin/learningframework/mallet/LFAlphabet.html new file mode 100644 index 0000000..d9240fb --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/LFAlphabet.html @@ -0,0 +1,384 @@ + + + + + + +public class LFAlphabet
+extends cc.mallet.types.Alphabet
+| Constructor and Description | +
|---|
LFAlphabet() |
+
LFAlphabet(int capacity) |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+lookupIndex(Object entry) |
+
int |
+lookupIndex(Object entry,
+ boolean addifmissing) |
+
Object |
+lookupObject(int index) |
+
int |
+size() |
+
Object[] |
+toArray() |
+
alphabetsMatch, clone, contains, dump, dump, dump, entryClass, getInstanceId, growthStopped, iterator, lookupIndices, lookupObjects, lookupObjects, readResolve, setInstanceId, startGrowth, stopGrowth, toArray, toStringpublic LFAlphabet()+
public LFAlphabet(int capacity)+
public int lookupIndex(Object entry)+
lookupIndex in class cc.mallet.types.Alphabetpublic int lookupIndex(Object entry, + boolean addifmissing)+
lookupIndex in class cc.mallet.types.Alphabetpublic Object lookupObject(int index)+
lookupObject in class cc.mallet.types.Alphabetpublic int size()+
size in class cc.mallet.types.Alphabetpublic Object[] toArray()+
toArray in class cc.mallet.types.AlphabetCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/LFInstanceList.html b/apidocs/gate/plugin/learningframework/mallet/LFInstanceList.html new file mode 100644 index 0000000..30f1da9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/LFInstanceList.html @@ -0,0 +1,400 @@ + + + + + + +public class LFInstanceList
+extends cc.mallet.types.InstanceList
+cc.mallet.types.InstanceList.CrossValidationIteratorTARGET_PROPERTYmodCount| Constructor and Description | +
|---|
LFInstanceList(LFPipe pipe) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+add(cc.mallet.types.Instance instance) |
+
add, add, add, add, addAll, addAll, addThruPipe, addThruPipe, clear, clone, cloneEmpty, cloneEmptyInto, crossValidationIterator, crossValidationIterator, getAlphabet, getAlphabets, getDataAlphabet, getDataClass, getFeatureSelection, getInstanceWeight, getInstanceWeight, getPerLabelFeatureSelection, getPipe, getTargetAlphabet, getTargetClass, hideSomeLabels, hideSomeLabels, load, noisify, remove, remove, removeSources, removeTargets, sampleWithInstanceWeights, sampleWithReplacement, sampleWithWeights, save, set, setFeatureSelection, setInstance, setInstanceWeight, setInstanceWeight, setPerLabelFeatureSelection, setPipe, shallowClone, shuffle, split, split, splitInOrder, splitInOrder, splitInTwoByModulo, subList, subList, targetLabelDistribution, unhideAllLabelscontains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, size, sort, spliterator, toArray, toArray, trimToSizeequals, hashCodecontainsAll, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitforEach, iterator, spliteratorcontainsAll, equals, hashCodeparallelStream, streamCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/LFLabelAlphabet.html b/apidocs/gate/plugin/learningframework/mallet/LFLabelAlphabet.html new file mode 100644 index 0000000..0c7b22d --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/LFLabelAlphabet.html @@ -0,0 +1,433 @@ + + + + + + +public class LFLabelAlphabet
+extends cc.mallet.types.LabelAlphabet
+| Constructor and Description | +
|---|
LFLabelAlphabet() |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+lookupIndex(Object entry) |
+
int |
+lookupIndex(Object entry,
+ boolean addifmissing) |
+
cc.mallet.types.Label |
+lookupLabel(int idx) |
+
cc.mallet.types.Label |
+lookupLabel(Object entry) |
+
cc.mallet.types.Label |
+lookupLabel(Object entry,
+ boolean addifmissing) |
+
Object |
+lookupObject(int index) |
+
int |
+size() |
+
Object[] |
+toArray() |
+
alphabetsMatch, clone, contains, dump, dump, dump, entryClass, getInstanceId, growthStopped, iterator, lookupIndices, lookupObjects, lookupObjects, readResolve, setInstanceId, startGrowth, stopGrowth, toArray, toStringpublic int lookupIndex(Object entry)+
lookupIndex in class cc.mallet.types.Alphabetpublic int lookupIndex(Object entry, + boolean addifmissing)+
lookupIndex in class cc.mallet.types.LabelAlphabetpublic Object lookupObject(int index)+
lookupObject in class cc.mallet.types.Alphabetpublic int size()+
size in class cc.mallet.types.Alphabetpublic Object[] toArray()+
toArray in class cc.mallet.types.Alphabetpublic cc.mallet.types.Label lookupLabel(Object entry, + boolean addifmissing)+
lookupLabel in class cc.mallet.types.LabelAlphabetpublic cc.mallet.types.Label lookupLabel(Object entry)+
lookupLabel in class cc.mallet.types.LabelAlphabetpublic cc.mallet.types.Label lookupLabel(int idx)+
lookupLabel in class cc.mallet.types.LabelAlphabetCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/LFPipe.html b/apidocs/gate/plugin/learningframework/mallet/LFPipe.html new file mode 100644 index 0000000..ceb922d --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/LFPipe.html @@ -0,0 +1,416 @@ + + + + + + +public class LFPipe +extends cc.mallet.pipe.SerialPipes +implements Serializable+
cc.mallet.pipe.SerialPipes.Predicate| Modifier and Type | +Field and Description | +
|---|---|
protected FeatureInfo |
+featureInfo |
+
| Constructor and Description | +
|---|
LFPipe(Collection<cc.mallet.pipe.Pipe> pipes) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addPipe(cc.mallet.pipe.Pipe pipe)
+Add another pipe at the end of this SerialPipes.
+ |
+
FeatureInfo |
+getFeatureInfo()
+Get the feature info.
+ |
+
void |
+setFeatureInfo(FeatureInfo info)
+Set the feature info.
+ |
+
getPipe, newIteratorFrom, newSerialPipesFromRange, newSerialPipesFromSuffix, pipes, setTargetProcessing, size, toStringalphabetsMatch, getAlphabet, getAlphabets, getDataAlphabet, getInstanceId, getTargetAlphabet, instanceFrom, instancesFrom, instancesFrom, isDataAlphabetSet, isTargetProcessing, pipe, preceedingPipeDataAlphabetNotification, preceedingPipeTargetAlphabetNotification, precondition, readResolve, setDataAlphabet, setOrCheckDataAlphabet, setOrCheckTargetAlphabet, setTargetAlphabetprotected FeatureInfo featureInfo+
public LFPipe(Collection<cc.mallet.pipe.Pipe> pipes)+
public void setFeatureInfo(FeatureInfo info)+
info - feature infopublic FeatureInfo getFeatureInfo()+
public void addPipe(cc.mallet.pipe.Pipe pipe)+
pipe - pipe to addCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/NominalTargetWithCosts.html b/apidocs/gate/plugin/learningframework/mallet/NominalTargetWithCosts.html new file mode 100644 index 0000000..01bcce6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/NominalTargetWithCosts.html @@ -0,0 +1,416 @@ + + + + + + +public class NominalTargetWithCosts +extends Object +implements Serializable+
| Constructor and Description | +
|---|
NominalTargetWithCosts(double[] costs) |
+
NominalTargetWithCosts(List<Double> costs) |
+
NominalTargetWithCosts(String l,
+ double[] costs) |
+
NominalTargetWithCosts(String l,
+ List<Double> costs) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
Integer |
+getClassIndex() |
+
String |
+getClassLabel() |
+
double[] |
+getCosts() |
+
int |
+hashCode() |
+
String |
+toString() |
+
public NominalTargetWithCosts(double[] costs)+
public NominalTargetWithCosts(String l, + double[] costs)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/PipeScaleMeanVarAll.html b/apidocs/gate/plugin/learningframework/mallet/PipeScaleMeanVarAll.html new file mode 100644 index 0000000..d18283a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/PipeScaleMeanVarAll.html @@ -0,0 +1,374 @@ + + + + + + +public class PipeScaleMeanVarAll +extends cc.mallet.pipe.Pipe +implements Serializable+
| Modifier and Type | +Field and Description | +
|---|---|
protected double[] |
+means |
+
protected boolean[] |
+normalize |
+
protected double[] |
+variances |
+
| Constructor and Description | +
|---|
PipeScaleMeanVarAll(cc.mallet.types.Alphabet alphabet,
+ FVStatsMeanVarAll stats)
+Constructor from alphabet and stats.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
cc.mallet.types.Instance |
+pipe(cc.mallet.types.Instance carrier) |
+
alphabetsMatch, getAlphabet, getAlphabets, getDataAlphabet, getInstanceId, getTargetAlphabet, instanceFrom, instancesFrom, instancesFrom, isDataAlphabetSet, isTargetProcessing, newIteratorFrom, preceedingPipeDataAlphabetNotification, preceedingPipeTargetAlphabetNotification, precondition, readResolve, setDataAlphabet, setOrCheckDataAlphabet, setOrCheckTargetAlphabet, setTargetAlphabet, setTargetProcessingprotected double[] means+
protected double[] variances+
protected boolean[] normalize+
public PipeScaleMeanVarAll(cc.mallet.types.Alphabet alphabet, + FVStatsMeanVarAll stats)+
alphabet - alphabetstats - feature statsCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/PipeScaleMinMaxAll.html b/apidocs/gate/plugin/learningframework/mallet/PipeScaleMinMaxAll.html new file mode 100644 index 0000000..780adba --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/PipeScaleMinMaxAll.html @@ -0,0 +1,370 @@ + + + + + + +public class PipeScaleMinMaxAll +extends cc.mallet.pipe.Pipe +implements Serializable+
| Modifier and Type | +Field and Description | +
|---|---|
protected double[] |
+max |
+
protected double[] |
+min |
+
protected boolean[] |
+normalize |
+
| Constructor and Description | +
|---|
PipeScaleMinMaxAll(cc.mallet.types.Alphabet alphabet,
+ FVStatsMeanVarAll stats)
+Constructor from alphabet and feature stats.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
cc.mallet.types.Instance |
+pipe(cc.mallet.types.Instance carrier) |
+
alphabetsMatch, getAlphabet, getAlphabets, getDataAlphabet, getInstanceId, getTargetAlphabet, instanceFrom, instancesFrom, instancesFrom, isDataAlphabetSet, isTargetProcessing, newIteratorFrom, preceedingPipeDataAlphabetNotification, preceedingPipeTargetAlphabetNotification, precondition, readResolve, setDataAlphabet, setOrCheckDataAlphabet, setOrCheckTargetAlphabet, setTargetAlphabet, setTargetProcessingprotected double[] min+
protected double[] max+
protected boolean[] normalize+
public PipeScaleMinMaxAll(cc.mallet.types.Alphabet alphabet, + FVStatsMeanVarAll stats)+
alphabet - alphabetstats - feature statsCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/LFAlphabet.html b/apidocs/gate/plugin/learningframework/mallet/class-use/LFAlphabet.html new file mode 100644 index 0000000..1cb8439 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/LFAlphabet.html @@ -0,0 +1,191 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| Constructor and Description | +
|---|
Attribute(String name,
+ int index,
+ Datatype datatype,
+ CodeAs codeAs,
+ MissingValueTreatment mvt,
+ LFAlphabet alphabet) |
+
| Modifier and Type | +Field and Description | +
|---|---|
LFAlphabet |
+FeatureSpecSimpleAttribute.alphabet |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/LFInstanceList.html b/apidocs/gate/plugin/learningframework/mallet/class-use/LFInstanceList.html new file mode 100644 index 0000000..815e6c6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/LFInstanceList.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/LFLabelAlphabet.html b/apidocs/gate/plugin/learningframework/mallet/class-use/LFLabelAlphabet.html new file mode 100644 index 0000000..abc134a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/LFLabelAlphabet.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/LFPipe.html b/apidocs/gate/plugin/learningframework/mallet/class-use/LFPipe.html new file mode 100644 index 0000000..69aadb6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/LFPipe.html @@ -0,0 +1,199 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.mallet | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected LFPipe |
+CorpusRepresentationMalletRelated.pipe |
+
| Modifier and Type | +Method and Description | +
|---|---|
LFPipe |
+CorpusRepresentationMallet.getPipe() |
+
| Constructor and Description | +
|---|
LFInstanceList(LFPipe pipe) |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/NominalTargetWithCosts.html b/apidocs/gate/plugin/learningframework/mallet/class-use/NominalTargetWithCosts.html new file mode 100644 index 0000000..617f0c6 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/NominalTargetWithCosts.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/PipeScaleMeanVarAll.html b/apidocs/gate/plugin/learningframework/mallet/class-use/PipeScaleMeanVarAll.html new file mode 100644 index 0000000..9f7222b --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/PipeScaleMeanVarAll.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/class-use/PipeScaleMinMaxAll.html b/apidocs/gate/plugin/learningframework/mallet/class-use/PipeScaleMinMaxAll.html new file mode 100644 index 0000000..9f392cf --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/class-use/PipeScaleMinMaxAll.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/package-frame.html b/apidocs/gate/plugin/learningframework/mallet/package-frame.html new file mode 100644 index 0000000..cf57882 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/package-frame.html @@ -0,0 +1,27 @@ + + + + + + +| Class | +Description | +
|---|---|
| LFAlphabet | +
+ Attempt to make the Mallet Alphabet class somewhat synchronized.
+ |
+
| LFInstanceList | +
+ A concurrent replacement for Mallet InstanceList.
+ |
+
| LFLabelAlphabet | +
+ Attempt to make LabelAlphabet more synchronized.
+ |
+
| LFPipe | +
+ An extended version of the Mallet SerialPipes class which allows us to store
+ some additional important information.
+ |
+
| NominalTargetWithCosts | +
+ Represent a cost vector in a way that Mallet can use as a classification label.
+ |
+
| PipeScaleMeanVarAll | +
+ Pipe for normalizing features so they have mean 1 and standard deviation 1.
+ |
+
| PipeScaleMinMaxAll | ++ |
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/package-tree.html b/apidocs/gate/plugin/learningframework/mallet/package-tree.html new file mode 100644 index 0000000..9e6e1d3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/package-tree.html @@ -0,0 +1,177 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mallet/package-use.html b/apidocs/gate/plugin/learningframework/mallet/package-use.html new file mode 100644 index 0000000..be5249a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mallet/package-use.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.features | ++ |
| gate.plugin.learningframework.mallet | ++ |
| Class and Description | +
|---|
| LFAlphabet
+ Attempt to make the Mallet Alphabet class somewhat synchronized.
+ |
+
| LFPipe
+ An extended version of the Mallet SerialPipes class which allows us to store
+ some additional important information.
+ |
+
| Class and Description | +
|---|
| LFAlphabet
+ Attempt to make the Mallet Alphabet class somewhat synchronized.
+ |
+
| Class and Description | +
|---|
| LFPipe
+ An extended version of the Mallet SerialPipes class which allows us to store
+ some additional important information.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/FVStatsMeanVarAll.html b/apidocs/gate/plugin/learningframework/mbstats/FVStatsMeanVarAll.html new file mode 100644 index 0000000..9d78477 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/FVStatsMeanVarAll.html @@ -0,0 +1,404 @@ + + + + + + +public class FVStatsMeanVarAll +extends Object +implements FeatureVectorStats+
| Modifier and Type | +Field and Description | +
|---|---|
protected boolean |
+immutable |
+
protected int |
+nrInstances |
+
protected List<PerFeatureStats> |
+pfs |
+
| Constructor and Description | +
|---|
FVStatsMeanVarAll(cc.mallet.types.InstanceList instances)
+Constructor from instance list.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addFeatureVector(cc.mallet.types.FeatureVector fv) |
+
void |
+finish() |
+
List<PerFeatureStats> |
+getStats() |
+
String |
+toString() |
+
protected List<PerFeatureStats> pfs+
protected int nrInstances+
protected boolean immutable+
public FVStatsMeanVarAll(cc.mallet.types.InstanceList instances)+
instances - instancespublic void addFeatureVector(cc.mallet.types.FeatureVector fv)+
addFeatureVector in interface FeatureVectorStatspublic void finish()+
finish in interface FeatureVectorStatspublic List<PerFeatureStats> getStats()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/FeatureVectorStats.html b/apidocs/gate/plugin/learningframework/mbstats/FeatureVectorStats.html new file mode 100644 index 0000000..5b477b2 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/FeatureVectorStats.html @@ -0,0 +1,252 @@ + + + + + + +public interface FeatureVectorStats
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+addFeatureVector(cc.mallet.types.FeatureVector fv) |
+
void |
+finish() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/PerFeatureStats.html b/apidocs/gate/plugin/learningframework/mbstats/PerFeatureStats.html new file mode 100644 index 0000000..0947a70 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/PerFeatureStats.html @@ -0,0 +1,395 @@ + + + + + + +public class PerFeatureStats +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
Boolean |
+binary |
+
double |
+max |
+
double |
+mean |
+
double |
+min |
+
double |
+sum |
+
double |
+sumOfSquares |
+
double |
+var |
+
| Constructor and Description | +
|---|
PerFeatureStats() |
+
public double sum+
public double sumOfSquares+
public double mean+
public double var+
public double min+
public double max+
public Boolean binary+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/class-use/FVStatsMeanVarAll.html b/apidocs/gate/plugin/learningframework/mbstats/class-use/FVStatsMeanVarAll.html new file mode 100644 index 0000000..22edabb --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/class-use/FVStatsMeanVarAll.html @@ -0,0 +1,173 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.mallet | ++ |
| Constructor and Description | +
|---|
PipeScaleMeanVarAll(cc.mallet.types.Alphabet alphabet,
+ FVStatsMeanVarAll stats)
+Constructor from alphabet and stats.
+ |
+
PipeScaleMinMaxAll(cc.mallet.types.Alphabet alphabet,
+ FVStatsMeanVarAll stats)
+Constructor from alphabet and feature stats.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/class-use/FeatureVectorStats.html b/apidocs/gate/plugin/learningframework/mbstats/class-use/FeatureVectorStats.html new file mode 100644 index 0000000..8e9f031 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/class-use/FeatureVectorStats.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.mbstats | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FVStatsMeanVarAll
+Stats object that calculates the means and variances of all features in the
+ vectors.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/class-use/PerFeatureStats.html b/apidocs/gate/plugin/learningframework/mbstats/class-use/PerFeatureStats.html new file mode 100644 index 0000000..90c347c --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/class-use/PerFeatureStats.html @@ -0,0 +1,179 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.mbstats | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
protected List<PerFeatureStats> |
+FVStatsMeanVarAll.pfs |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<PerFeatureStats> |
+FVStatsMeanVarAll.getStats() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/package-frame.html b/apidocs/gate/plugin/learningframework/mbstats/package-frame.html new file mode 100644 index 0000000..304cf79 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Interface | +Description | +
|---|---|
| FeatureVectorStats | +
+ A base class for calculating statistics for features in a feature vector.
+ |
+
| Class | +Description | +
|---|---|
| FVStatsMeanVarAll | +
+ Stats object that calculates the means and variances of all features in the
+ vectors.
+ |
+
| PerFeatureStats | ++ |
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/package-tree.html b/apidocs/gate/plugin/learningframework/mbstats/package-tree.html new file mode 100644 index 0000000..85b623f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/mbstats/package-use.html b/apidocs/gate/plugin/learningframework/mbstats/package-use.html new file mode 100644 index 0000000..1c91825 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/mbstats/package-use.html @@ -0,0 +1,186 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.mallet | ++ |
| gate.plugin.learningframework.mbstats | ++ |
| Class and Description | +
|---|
| FVStatsMeanVarAll
+ Stats object that calculates the means and variances of all features in the
+ vectors.
+ |
+
| Class and Description | +
|---|
| FeatureVectorStats
+ A base class for calculating statistics for features in a feature vector.
+ |
+
| PerFeatureStats | +
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/package-frame.html b/apidocs/gate/plugin/learningframework/package-frame.html new file mode 100644 index 0000000..52c41e4 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +| Class | +Description | +
|---|---|
| AbstractDocumentProcessor | +
+ Abstract base class for all the PRs in this plugin.
+ |
+
| Globals | ++ |
| LearningFrameworkPRBase | +
+ Base class for all LearningFramework PRs providing the shared parameters.
+ |
+
| LF_ApplyChunking | +
+
+ Training, evaluation and application of ML in GATE.
+ |
+
| LF_ApplyClassification | +
+
+ Training, evaluation and application of ML in GATE.
+ |
+
| LF_ApplyRegression | +
+
+ Training, evaluation and application of ML in GATE.
+ |
+
| LF_ApplyTopicModel | +
+
+ Training, evaluation and application of ML in GATE.
+ |
+
| LF_EvaluateClassification | ++ |
| LF_EvaluateRegression | ++ |
| LF_Export | ++ |
| LF_ExportBase | +
+ Base class for all Training classes, inherits from LF_Base.
+ |
+
| LF_ExportText | +
+ Very simple PR to export text only in ad-hoc formats.
+ |
+
| LF_GenFeatures_Affixes | ++ |
| LF_GenFeatures_Misc | ++ |
| LF_TrainChunking | ++ |
| LF_TrainClassification | ++ |
| LF_TrainRegression | ++ |
| LF_TrainTopicModel | ++ |
| LFUtils | +
+ Various utility functions.
+ |
+
| ModelApplication | ++ |
| Enum | +Description | +
|---|---|
| EvaluationMethod | ++ |
| ScalingMethod | ++ |
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/package-tree.html b/apidocs/gate/plugin/learningframework/package-tree.html new file mode 100644 index 0000000..4f1ddd7 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/package-tree.html @@ -0,0 +1,196 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/package-use.html b/apidocs/gate/plugin/learningframework/package-use.html new file mode 100644 index 0000000..98ff035 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/package-use.html @@ -0,0 +1,240 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.features | ++ |
| Class and Description | +
|---|
| AbstractDocumentProcessor
+ Abstract base class for all the PRs in this plugin.
+ |
+
| EvaluationMethod | +
| LearningFrameworkPRBase
+ Base class for all LearningFramework PRs providing the shared parameters.
+ |
+
| LF_ExportBase
+ Base class for all Training classes, inherits from LF_Base.
+ |
+
| ModelApplication | +
| ScalingMethod | +
| Class and Description | +
|---|
| ScalingMethod | +
| Class and Description | +
|---|
| EvaluationMethod | +
| ModelApplication | +
| Class and Description | +
|---|
| ScalingMethod | +
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/pipelines/LF_TrainTopicModel_Mallet_EN.html b/apidocs/gate/plugin/learningframework/pipelines/LF_TrainTopicModel_Mallet_EN.html new file mode 100644 index 0000000..adb1fe3 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/pipelines/LF_TrainTopicModel_Mallet_EN.html @@ -0,0 +1,326 @@ + + + + + + +@CreoleResource(name="LF_TrainTopicModel_Mallet_EN",
+ comment="Example steps to prepare and train a topic model using Mallet LDA",
+ icon="LF_TrainTopicModel_Mallet_EN",
+ autoinstances=)
+public class LF_TrainTopicModel_Mallet_EN
+extends gate.creole.PackagedController
+urlnamefeatures| Constructor and Description | +
|---|
LF_TrainTopicModel_Mallet_EN() |
+
getMenu, getPipelineURL, setMenu, setPipelineURLcheckParameterValues, cleanup, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, init, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toStringgetFeatures, setFeaturesclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetFeatures, setFeaturesCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/pipelines/class-use/LF_TrainTopicModel_Mallet_EN.html b/apidocs/gate/plugin/learningframework/pipelines/class-use/LF_TrainTopicModel_Mallet_EN.html new file mode 100644 index 0000000..70bfabc --- /dev/null +++ b/apidocs/gate/plugin/learningframework/pipelines/class-use/LF_TrainTopicModel_Mallet_EN.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/pipelines/package-frame.html b/apidocs/gate/plugin/learningframework/pipelines/package-frame.html new file mode 100644 index 0000000..a2b9cd9 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/pipelines/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| LF_TrainTopicModel_Mallet_EN | +
+ Class for providing the ready made application.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/pipelines/package-tree.html b/apidocs/gate/plugin/learningframework/pipelines/package-tree.html new file mode 100644 index 0000000..d5d6154 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/pipelines/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/pipelines/package-use.html b/apidocs/gate/plugin/learningframework/pipelines/package-use.html new file mode 100644 index 0000000..6259e1f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/pipelines/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/Stats.StatsObject.html b/apidocs/gate/plugin/learningframework/stats/Stats.StatsObject.html new file mode 100644 index 0000000..1d2cd43 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/Stats.StatsObject.html @@ -0,0 +1,366 @@ + + + + + + +public static class Stats.StatsObject +extends Object +implements Serializable+
| Modifier and Type | +Field and Description | +
|---|---|
boolean |
+isString |
+
double |
+max |
+
double |
+mean |
+
double |
+min |
+
long |
+n |
+
Map<String,Long> |
+stringCounts |
+
double |
+variance |
+
| Constructor and Description | +
|---|
StatsObject() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/Stats.html b/apidocs/gate/plugin/learningframework/stats/Stats.html new file mode 100644 index 0000000..b64712a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/Stats.html @@ -0,0 +1,554 @@ + + + + + + +public class Stats +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Stats.StatsObject |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected long |
+n |
+
protected org.apache.commons.math3.stat.descriptive.SummaryStatistics |
+numStats |
+
protected Map<String,Long> |
+stringStats |
+
| Constructor and Description | +
|---|
Stats(Object firstValue) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addValue(Object value)
+Add a value to the stats object.
+ |
+
double |
+getMax() |
+
double |
+getMean() |
+
double |
+getMin() |
+
long |
+getN()
+Get number of values added to the stats object.
+ |
+
Stats.StatsObject |
+getStatsObject() |
+
double |
+getVariance() |
+
boolean |
+isNum()
+Get indicator if we have a stats object over numeric values
+ |
+
boolean |
+isString()
+Get indicator if we have a string stats object.
+ |
+
int |
+nrValues()
+Number of different values, only if isString() is true, exception otherwise.
+ |
+
Map<String,Long> |
+stringCounts()
+Map of string counts.
+ |
+
List<String> |
+stringValues()
+List of possible string values.
+ |
+
protected org.apache.commons.math3.stat.descriptive.SummaryStatistics numStats+
protected long n+
public void addValue(Object value)+
value - value to addpublic long getN()+
public boolean isString()+
public boolean isNum()+
public int nrValues()+
public List<String> stringValues()+
public Map<String,Long> stringCounts()+
public double getMin()+
public double getMax()+
public double getMean()+
public double getVariance()+
public Stats.StatsObject getStatsObject()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/StatsForFeatures.html b/apidocs/gate/plugin/learningframework/stats/StatsForFeatures.html new file mode 100644 index 0000000..892e5f0 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/StatsForFeatures.html @@ -0,0 +1,363 @@ + + + + + + +public class StatsForFeatures +extends Object+
+ Currently statistics are calculated like this, depending on the type + of value passed in: +
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+KEY_FOR_TARGET |
+
| Constructor and Description | +
|---|
StatsForFeatures() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addValue(String featureName,
+ Object value)
+Add a value to the stats object
+ |
+
Stats |
+getStatistics(String featureName)
+Get the statistics object for the feature.
+ |
+
public static final String KEY_FOR_TARGET+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/class-use/Stats.StatsObject.html b/apidocs/gate/plugin/learningframework/stats/class-use/Stats.StatsObject.html new file mode 100644 index 0000000..f4d3c0f --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/class-use/Stats.StatsObject.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.stats | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Stats.StatsObject |
+Stats.getStatsObject() |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/class-use/Stats.html b/apidocs/gate/plugin/learningframework/stats/class-use/Stats.html new file mode 100644 index 0000000..0e3de20 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/class-use/Stats.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.stats | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Stats |
+StatsForFeatures.getStatistics(String featureName)
+Get the statistics object for the feature.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/class-use/StatsForFeatures.html b/apidocs/gate/plugin/learningframework/stats/class-use/StatsForFeatures.html new file mode 100644 index 0000000..5a84965 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/class-use/StatsForFeatures.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/package-frame.html b/apidocs/gate/plugin/learningframework/stats/package-frame.html new file mode 100644 index 0000000..ad2174a --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +| Class | +Description | +
|---|---|
| Stats | +
+ Simple wrapper around either SummaryStatistics or our own thing for strings.
+ |
+
| Stats.StatsObject | ++ |
| StatsForFeatures | +
+ A simple lightweight wrapper class for maintaining stats about many features.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/package-tree.html b/apidocs/gate/plugin/learningframework/stats/package-tree.html new file mode 100644 index 0000000..54649a8 --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/package-tree.html @@ -0,0 +1,141 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/plugin/learningframework/stats/package-use.html b/apidocs/gate/plugin/learningframework/stats/package-use.html new file mode 100644 index 0000000..b3d50dd --- /dev/null +++ b/apidocs/gate/plugin/learningframework/stats/package-use.html @@ -0,0 +1,164 @@ + + + + + + +| Package | +Description | +
|---|---|
| gate.plugin.learningframework.stats | ++ |
| Class and Description | +
|---|
| Stats
+ Simple wrapper around either SummaryStatistics or our own thing for strings.
+ |
+
| Stats.StatsObject | +
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/resources/img/svg/LF_TrainTopicModel_Mallet_ENIcon.html b/apidocs/gate/resources/img/svg/LF_TrainTopicModel_Mallet_ENIcon.html new file mode 100644 index 0000000..fa5424d --- /dev/null +++ b/apidocs/gate/resources/img/svg/LF_TrainTopicModel_Mallet_ENIcon.html @@ -0,0 +1,532 @@ + + + + + + +public class LF_TrainTopicModel_Mallet_ENIcon +extends Object +implements Icon+
| Constructor and Description | +
|---|
LF_TrainTopicModel_Mallet_ENIcon()
+Creates a new transcoded SVG image.
+ |
+
LF_TrainTopicModel_Mallet_ENIcon(boolean disabled) |
+
LF_TrainTopicModel_Mallet_ENIcon(Dimension size)
+Creates a new transcoded SVG image with the given dimensions.
+ |
+
LF_TrainTopicModel_Mallet_ENIcon(Dimension size,
+ boolean disabled) |
+
LF_TrainTopicModel_Mallet_ENIcon(int width,
+ int height) |
+
LF_TrainTopicModel_Mallet_ENIcon(int width,
+ int height,
+ boolean disabled) |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getIconHeight() |
+
int |
+getIconWidth() |
+
Image |
+getImage() |
+
static int |
+getOrigHeight()
+Returns the height of the bounding box of the original SVG image.
+ |
+
static int |
+getOrigWidth()
+Returns the width of the bounding box of the original SVG image.
+ |
+
static int |
+getOrigX()
+Returns the X of the bounding box of the original SVG image.
+ |
+
static int |
+getOrigY()
+Returns the Y of the bounding box of the original SVG image.
+ |
+
static void |
+paint(Graphics2D g,
+ boolean disabled)
+Paints the transcoded SVG image on the specified graphics context.
+ |
+
void |
+paintIcon(Component c,
+ Graphics g,
+ int x,
+ int y) |
+
void |
+setDimension(Dimension newDimension) |
+
public LF_TrainTopicModel_Mallet_ENIcon()+
public LF_TrainTopicModel_Mallet_ENIcon(boolean disabled)+
public LF_TrainTopicModel_Mallet_ENIcon(Dimension size)+
size - the dimensions of the iconpublic LF_TrainTopicModel_Mallet_ENIcon(Dimension size, + boolean disabled)+
public LF_TrainTopicModel_Mallet_ENIcon(int width, + int height)+
public LF_TrainTopicModel_Mallet_ENIcon(int width, + int height, + boolean disabled)+
public static void paint(Graphics2D g, + boolean disabled)+
g - Graphics context.public Image getImage()+
public static int getOrigX()+
public static int getOrigY()+
public static int getOrigWidth()+
public static int getOrigHeight()+
public int getIconHeight()+
getIconHeight in interface Iconpublic int getIconWidth()+
getIconWidth in interface Iconpublic void setDimension(Dimension newDimension)+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/resources/img/svg/class-use/LF_TrainTopicModel_Mallet_ENIcon.html b/apidocs/gate/resources/img/svg/class-use/LF_TrainTopicModel_Mallet_ENIcon.html new file mode 100644 index 0000000..6ba1fd5 --- /dev/null +++ b/apidocs/gate/resources/img/svg/class-use/LF_TrainTopicModel_Mallet_ENIcon.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/resources/img/svg/package-frame.html b/apidocs/gate/resources/img/svg/package-frame.html new file mode 100644 index 0000000..a198acb --- /dev/null +++ b/apidocs/gate/resources/img/svg/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| LF_TrainTopicModel_Mallet_ENIcon | +
+ This class has been automatically generated using SVGRoundTrip.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/resources/img/svg/package-tree.html b/apidocs/gate/resources/img/svg/package-tree.html new file mode 100644 index 0000000..fd85987 --- /dev/null +++ b/apidocs/gate/resources/img/svg/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/gate/resources/img/svg/package-use.html b/apidocs/gate/resources/img/svg/package-use.html new file mode 100644 index 0000000..3ffdc35 --- /dev/null +++ b/apidocs/gate/resources/img/svg/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/help-doc.html b/apidocs/help-doc.html new file mode 100644 index 0000000..86887a7 --- /dev/null +++ b/apidocs/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/index-all.html b/apidocs/index-all.html new file mode 100644 index 0000000..bd90ed1 --- /dev/null +++ b/apidocs/index-all.html @@ -0,0 +1,4776 @@ + + + + + + +Option to this group.AlreadySelectedException
+ with the specified detail message.AlreadySelectedException
+ for the specified option group.DefaultParser insteadOption.Builder.Option.Builder to create an Option using descriptive
+ methods.Option.Builder to create an Option using descriptive
+ methods.token into its constituent parts
+ using the following algorithm.MissingOptionException if all of the required options
+ are not present.Options descriptor.CommandLineParser interface
+ can parse a String array according to the Options specified
+ and return a CommandLine.char.char.classname.str.str.str.len.str.Object of type obj
+ with the value of str.Object of type clazz
+ with the value of str.startPos for the
+ text in text with the column width width.arguments that have been passed to the parse method.Option matching the long or short name specified.opt belongs to.Object type of this Option.Options.Option converted to a particular type.null if there is no value.null if there is no value.defaultValue if there is no value.ch represents.DefaultParser insteadtoken into its constituent parts
+ using the following algorithm.hasArg is true.num argument values.required
+ is true.ch is a value code, i.e.MissingArgumentException
+ with the specified detail message.MissingArgumentException
+ with the specified detail message.MissingSelectedException
+ with the specified detail message.MissingSelectedException with the
+ specified list of missing options.Option instances
+ using descriptive methods.Option.builder(String) insteadarguments based
+ on the specified Options.arguments
+ based on the specified Options.ParseException
+ with the specified detail message.Options instance represented by pattern.DefaultParser insteadoptions with the specified
+ command line syntax.options with the specified
+ command line syntax.options with the specified
+ command line syntax.options with the specified
+ command line syntax.options with the specified
+ command line syntax.options with the specified
+ command line syntax.options with the specified
+ command line syntax.options with the specified
+ command line syntax.opt using the values retrieved from the
+ specified iterator iter.arg using the values
+ retrieved from the specified iterator iter.properties.name.Option.setType(Class) insteadUnrecognizedArgumentException
+ with the specified detail message.UnrecognizedArgumentException
+ with the specified option and detail message.sep as a means to
+ separate argument values.OptionBuilder.withType(Class) insteadtype.sep as a means to
+ separate argument values.=' as a means to
+ separate argument values.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/index.html b/apidocs/index.html new file mode 100644 index 0000000..ceec355 --- /dev/null +++ b/apidocs/index.html @@ -0,0 +1,76 @@ + + + + + + +public class AlreadySelectedException +extends ParseException+
| Constructor and Description | +
|---|
AlreadySelectedException(OptionGroup group,
+ Option option)
+Construct a new
+AlreadySelectedException
+ for the specified option group. |
+
AlreadySelectedException(String message)
+Construct a new
+AlreadySelectedException
+ with the specified detail message. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Option |
+getOption()
+Returns the option that was added to the group and triggered the exception.
+ |
+
OptionGroup |
+getOptionGroup()
+Returns the option group where another option has been selected.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic AlreadySelectedException(String message)+
AlreadySelectedException
+ with the specified detail message.message - the detail messagepublic AlreadySelectedException(OptionGroup group, + Option option)+
AlreadySelectedException
+ for the specified option group.group - the option group already selectedoption - the option that triggered the exceptionpublic OptionGroup getOptionGroup()+
public Option getOption()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/AmbiguousOptionException.html b/apidocs/org/apache/commons/clipatched/AmbiguousOptionException.html new file mode 100644 index 0000000..88327f7 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/AmbiguousOptionException.html @@ -0,0 +1,337 @@ + + + + + + +public class AmbiguousOptionException +extends UnrecognizedOptionException+
| Constructor and Description | +
|---|
AmbiguousOptionException(String option,
+ Collection<String> matchingOptions)
+Constructs a new AmbiguousOptionException.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Collection<String> |
+getMatchingOptions()
+Returns the options matching the partial name.
+ |
+
getOptionaddSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic AmbiguousOptionException(String option, + Collection<String> matchingOptions)+
option - the partial option namematchingOptions - the options matching the namepublic Collection<String> getMatchingOptions()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/BasicParser.html b/apidocs/org/apache/commons/clipatched/BasicParser.html new file mode 100644 index 0000000..735721f --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/BasicParser.html @@ -0,0 +1,342 @@ + + + + + + +DefaultParser instead@Deprecated +public class BasicParser +extends Parser+
flatten method.| Constructor and Description | +
|---|
BasicParser()
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected String[] |
+flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
checkRequiredOptions, getOptions, getRequiredOptions, parse, parse, parse, parse, processArgs, processOption, processProperties, setOptionsCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/CommandLine.html b/apidocs/org/apache/commons/clipatched/CommandLine.html new file mode 100644 index 0000000..3ee19ef --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/CommandLine.html @@ -0,0 +1,702 @@ + + + + + + +public class CommandLine +extends Object +implements Serializable+
Options descriptor.
+
+ It allows querying of a boolean hasOption(String opt),
+ in addition to retrieving the getOptionValue(String opt)
+ for options requiring arguments.
+
+ Additionally, any left-over or unrecognized arguments, + are available for further processing.
| Modifier | +Constructor and Description | +
|---|---|
protected |
+CommandLine()
+Creates a command line.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+addArg(String arg)
+Add left-over unrecognized option/argument.
+ |
+
protected void |
+addOption(Option opt)
+Add an option to the command line.
+ |
+
List<String> |
+getArgList()
+Retrieve any left-over non-recognized options and arguments
+ |
+
String[] |
+getArgs()
+Retrieve any left-over non-recognized options and arguments
+ |
+
Object |
+getOptionObject(char opt)
+Return the
+Object type of this Option. |
+
Object |
+getOptionObject(String opt)
+Deprecated.
+
+due to System.err message. Instead use getParsedOptionValue(String)
+ |
+
Properties |
+getOptionProperties(String opt)
+Retrieve the map of values associated to the option.
+ |
+
Option[] |
+getOptions()
+Returns an array of the processed
+Options. |
+
String |
+getOptionValue(char opt)
+Retrieve the first argument, if any, of this option.
+ |
+
String |
+getOptionValue(char opt,
+ String defaultValue)
+Retrieve the argument, if any, of an option.
+ |
+
String |
+getOptionValue(String opt)
+Retrieve the first argument, if any, of this option.
+ |
+
String |
+getOptionValue(String opt,
+ String defaultValue)
+Retrieve the first argument, if any, of an option.
+ |
+
String[] |
+getOptionValues(char opt)
+Retrieves the array of values, if any, of an option.
+ |
+
String[] |
+getOptionValues(String opt)
+Retrieves the array of values, if any, of an option.
+ |
+
Object |
+getParsedOptionValue(String opt)
+Return a version of this
+Option converted to a particular type. |
+
boolean |
+hasOption(char opt)
+Query to see if an option has been set.
+ |
+
boolean |
+hasOption(String opt)
+Query to see if an option has been set.
+ |
+
Iterator<Option> |
+iterator()
+Returns an iterator over the Option members of CommandLine.
+ |
+
protected CommandLine()+
public boolean hasOption(String opt)+
opt - Short name of the optionpublic boolean hasOption(char opt)+
opt - character name of the option@Deprecated +public Object getOptionObject(String opt)+
Object type of this Option.opt - the name of the optionOptionpublic Object getParsedOptionValue(String opt) + throws ParseException+
Option converted to a particular type.opt - the name of the optionParseException - if there are problems turning the option value into the desired typePatternOptionBuilderpublic Object getOptionObject(char opt)+
Object type of this Option.opt - the name of the optionpublic String getOptionValue(String opt)+
opt - the name of the optionpublic String getOptionValue(char opt)+
opt - the character name of the optionpublic String[] getOptionValues(String opt)+
opt - string name of the optionpublic String[] getOptionValues(char opt)+
opt - character name of the optionpublic String getOptionValue(String opt, + String defaultValue)+
opt - name of the optiondefaultValue - is the default value to be returned if the option
+ is not specifieddefaultValue.public String getOptionValue(char opt, + String defaultValue)+
opt - character name of the optiondefaultValue - is the default value to be returned if the option
+ is not specifieddefaultValue.public Properties getOptionProperties(String opt)+
opt - name of the optionpublic String[] getArgs()+
public List<String> getArgList()+
List.protected void addArg(String arg)+
arg - the unrecognized option/argument.protected void addOption(Option opt)+
opt - the processed optionpublic Iterator<Option> iterator()+
Iterator over the processed Option
+ members of this CommandLineCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/CommandLineParser.html b/apidocs/org/apache/commons/clipatched/CommandLineParser.html new file mode 100644 index 0000000..883fa3b --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/CommandLineParser.html @@ -0,0 +1,285 @@ + + + + + + +public interface CommandLineParser
+CommandLineParser interface
+ can parse a String array according to the Options specified
+ and return a CommandLine.| Modifier and Type | +Method and Description | +
|---|---|
CommandLine |
+parse(Options options,
+ String[] arguments)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options.
+ |
+
CommandLine parse(Options options, + String[] arguments) + throws ParseException+
options - the specified Optionsarguments - the command line argumentsParseException - if there are any problems encountered
+ while parsing the command line tokens.CommandLine parse(Options options, + String[] arguments, + boolean stopAtNonOption) + throws ParseException+
options - the specified Optionsarguments - the command line argumentsstopAtNonOption - if true an unrecognized argument stops
+ the parsing and the remaining arguments are added to the
+ CommandLines args list. If false an unrecognized
+ argument triggers a ParseException.ParseException - if there are any problems encountered
+ while parsing the command line tokens.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/DefaultParser.html b/apidocs/org/apache/commons/clipatched/DefaultParser.html new file mode 100644 index 0000000..66b44f1 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/DefaultParser.html @@ -0,0 +1,620 @@ + + + + + + +public class DefaultParser +extends Object +implements CommandLineParser+
| Modifier and Type | +Field and Description | +
|---|---|
protected CommandLine |
+cmd
+The command-line instance.
+ |
+
protected Option |
+currentOption
+The last option parsed.
+ |
+
protected String |
+currentToken
+The token currently processed.
+ |
+
protected List<Object> |
+expectedOpts
+The required options and groups expected to be found when parsing the command line.
+ |
+
protected boolean |
+ignoreUnknownOptions |
+
protected Options |
+options
+The current options.
+ |
+
protected boolean |
+skipParsing
+Flag indicating if tokens should no longer be analyzed and simply added as arguments of the command line.
+ |
+
protected boolean |
+stopAtNonOption
+Flag indicating how unrecognized tokens are handled.
+ |
+
| Constructor and Description | +
|---|
DefaultParser() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+handleConcatenatedOptions(String token)
+Breaks
+token into its constituent parts
+ using the following algorithm. |
+
CommandLine |
+parse(Options options,
+ String[] arguments)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ Properties properties)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options and properties.
+ |
+
void |
+setIgnoreUnknownOptions(boolean flag) |
+
protected CommandLine cmd+
protected Options options+
protected boolean stopAtNonOption+
protected boolean ignoreUnknownOptions+
protected String currentToken+
protected Option currentOption+
protected boolean skipParsing+
public void setIgnoreUnknownOptions(boolean flag)+
public CommandLine parse(Options options, + String[] arguments) + throws ParseException+
CommandLineParserparse in interface CommandLineParseroptions - the specified Optionsarguments - the command line argumentsParseException - if there are any problems encountered
+ while parsing the command line tokens.public CommandLine parse(Options options, + String[] arguments, + Properties properties) + throws ParseException+
options - the specified Optionsarguments - the command line argumentsproperties - command line option name-value pairsParseException - if there are any problems encountered
+ while parsing the command line tokens.public CommandLine parse(Options options, + String[] arguments, + boolean stopAtNonOption) + throws ParseException+
CommandLineParserparse in interface CommandLineParseroptions - the specified Optionsarguments - the command line argumentsstopAtNonOption - if true an unrecognized argument stops
+ the parsing and the remaining arguments are added to the
+ CommandLines args list. If false an unrecognized
+ argument triggers a ParseException.ParseException - if there are any problems encountered
+ while parsing the command line tokens.public CommandLine parse(Options options, + String[] arguments, + Properties properties, + boolean stopAtNonOption) + throws ParseException+
options - the specified Optionsarguments - the command line argumentsproperties - command line option name-value pairsstopAtNonOption - if true an unrecognized argument stops
+ the parsing and the remaining arguments are added to the
+ CommandLines args list. If false an unrecognized
+ argument triggers a ParseException.ParseException - if there are any problems encountered
+ while parsing the command line tokens.protected void handleConcatenatedOptions(String token) + throws ParseException+
token into its constituent parts
+ using the following algorithm.
+
+ Option
+ exists with that id.Option does exist then add that character
+ prepended with "-" to the list of processed tokens.Option can have an argument value and there
+ are remaining characters in the token then add the remaining
+ characters as a token to the list of processed tokens.Option does NOT exist AND
+ stopAtNonOption IS set then add the special token
+ "--" followed by the remaining characters and also
+ the remaining tokens directly to the processed tokens list.Option does NOT exist AND
+ stopAtNonOption IS NOT set then add that
+ character prepended with "-".token - The current token to be burst
+ at the first non-Option encountered.ParseException - if there are any problems encountered
+ while parsing the command line token.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/GnuParser.html b/apidocs/org/apache/commons/clipatched/GnuParser.html new file mode 100644 index 0000000..baf5369 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/GnuParser.html @@ -0,0 +1,351 @@ + + + + + + +DefaultParser instead@Deprecated +public class GnuParser +extends Parser+
flatten method.| Constructor and Description | +
|---|
GnuParser()
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected String[] |
+flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
checkRequiredOptions, getOptions, getRequiredOptions, parse, parse, parse, parse, processArgs, processOption, processProperties, setOptionsprotected String[] flatten(Options options, + String[] arguments, + boolean stopAtNonOption)+
Option exists for the first character of
+ the arguments entry AND an Option
+ does not exist for the whole argument then
+ add the first character as an option to the processed tokens
+ list e.g. "-D" and add the rest of the entry to the also.flatten in class Parseroptions - The Options to parse the arguments by.arguments - The arguments that have to be flattened.stopAtNonOption - specifies whether to stop flattening when
+ a non option has been encounteredCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/HelpFormatter.html b/apidocs/org/apache/commons/clipatched/HelpFormatter.html new file mode 100644 index 0000000..0b6cf3f --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/HelpFormatter.html @@ -0,0 +1,1688 @@ + + + + + + +public class HelpFormatter +extends Object+
Example:
+ +
+ Options options = new Options();
+ options.addOption(OptionBuilder.withLongOpt("file")
+ .withDescription("The file to be processed")
+ .hasArg()
+ .withArgName("FILE")
+ .isRequired()
+ .create('f'));
+ options.addOption(OptionBuilder.withLongOpt("version")
+ .withDescription("Print the version of the application")
+ .create('v'));
+ options.addOption(OptionBuilder.withLongOpt("help").create('h'));
+
+ String header = "Do something useful with an input file\n\n";
+ String footer = "\nPlease report issues at http://example.com/issues";
+
+ HelpFormatter formatter = new HelpFormatter();
+ formatter.printHelp("myapp", header, options, footer, true);
+
+
+ This produces the following output:
+
+ + usage: myapp -f <FILE> [-h] [-v] + Do something useful with an input file + + -f,--file <FILE> The file to be processed + -h,--help + -v,--version Print the version of the application + + Please report issues at http://example.com/issues +
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+DEFAULT_ARG_NAME
+default name for an argument
+ |
+
static int |
+DEFAULT_DESC_PAD
+number of space characters to be prefixed to each description line
+ |
+
static int |
+DEFAULT_LEFT_PAD
+default padding to the left of each line
+ |
+
static String |
+DEFAULT_LONG_OPT_PREFIX
+default prefix for long Option
+ |
+
static String |
+DEFAULT_LONG_OPT_SEPARATOR
+default separator displayed between a long Option and its value
+ |
+
static String |
+DEFAULT_OPT_PREFIX
+default prefix for shortOpts
+ |
+
static String |
+DEFAULT_SYNTAX_PREFIX
+the string to display at the beginning of the usage statement
+ |
+
static int |
+DEFAULT_WIDTH
+default number of characters per line
+ |
+
String |
+defaultArgName
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setArgName methods instead.
+ |
+
int |
+defaultDescPad
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setDescPadding methods instead.
+ |
+
int |
+defaultLeftPad
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setLeftPadding methods instead.
+ |
+
String |
+defaultLongOptPrefix
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setLongOptPrefix methods instead.
+ |
+
String |
+defaultNewLine
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setNewLine methods instead.
+ |
+
String |
+defaultOptPrefix
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setOptPrefix methods instead.
+ |
+
String |
+defaultSyntaxPrefix
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setSyntaxPrefix methods instead.
+ |
+
int |
+defaultWidth
+Deprecated.
+
+Scope will be made private for next major version
+ - use get/setWidth methods instead.
+ |
+
protected Comparator<Option> |
+optionComparator
+Comparator used to sort the options when they output in help text
+
+ Defaults to case-insensitive alphabetical sorting by option key
+ |
+
| Constructor and Description | +
|---|
HelpFormatter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected String |
+createPadding(int len)
+Return a String of padding of length
+len. |
+
protected int |
+findWrapPos(String text,
+ int width,
+ int startPos)
+Finds the next text wrap position after
+startPos for the
+ text in text with the column width width. |
+
String |
+getArgName()
+Returns the 'argName'.
+ |
+
int |
+getDescPadding()
+Returns the 'descPadding'.
+ |
+
int |
+getLeftPadding()
+Returns the 'leftPadding'.
+ |
+
String |
+getLongOptPrefix()
+Returns the 'longOptPrefix'.
+ |
+
String |
+getLongOptSeparator()
+Returns the separator displayed between a long option and its value.
+ |
+
String |
+getNewLine()
+Returns the 'newLine'.
+ |
+
Comparator<Option> |
+getOptionComparator()
+Comparator used to sort the options when they output in help text.
+ |
+
String |
+getOptPrefix()
+Returns the 'optPrefix'.
+ |
+
String |
+getSyntaxPrefix()
+Returns the 'syntaxPrefix'.
+ |
+
int |
+getWidth()
+Returns the 'width'.
+ |
+
void |
+printHelp(int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(PrintWriter pw,
+ int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ int leftPad,
+ int descPad,
+ String footer)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(PrintWriter pw,
+ int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ int leftPad,
+ int descPad,
+ String footer,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(String cmdLineSyntax,
+ Options options)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(String cmdLineSyntax,
+ Options options,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printHelp(String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+printOptions(PrintWriter pw,
+ int width,
+ Options options,
+ int leftPad,
+ int descPad)
+Print the help for the specified Options to the specified writer,
+ using the specified width, left padding and description padding.
+ |
+
void |
+printUsage(PrintWriter pw,
+ int width,
+ String cmdLineSyntax)
+Print the cmdLineSyntax to the specified writer, using the
+ specified width.
+ |
+
void |
+printUsage(PrintWriter pw,
+ int width,
+ String app,
+ Options options)
+Prints the usage statement for the specified application.
+ |
+
void |
+printWrapped(PrintWriter pw,
+ int width,
+ int nextLineTabStop,
+ String text)
+Print the specified text to the specified PrintWriter.
+ |
+
void |
+printWrapped(PrintWriter pw,
+ int width,
+ String text)
+Print the specified text to the specified PrintWriter.
+ |
+
protected StringBuffer |
+renderOptions(StringBuffer sb,
+ int width,
+ Options options,
+ int leftPad,
+ int descPad)
+Render the specified Options and return the rendered Options
+ in a StringBuffer.
+ |
+
protected StringBuffer |
+renderWrappedText(StringBuffer sb,
+ int width,
+ int nextLineTabStop,
+ String text)
+Render the specified text and return the rendered Options
+ in a StringBuffer.
+ |
+
protected String |
+rtrim(String s)
+Remove the trailing whitespace from the specified String.
+ |
+
void |
+setArgName(String name)
+Sets the 'argName'.
+ |
+
void |
+setDescPadding(int padding)
+Sets the 'descPadding'.
+ |
+
void |
+setLeftPadding(int padding)
+Sets the 'leftPadding'.
+ |
+
void |
+setLongOptPrefix(String prefix)
+Sets the 'longOptPrefix'.
+ |
+
void |
+setLongOptSeparator(String longOptSeparator)
+Set the separator displayed between a long option and its value.
+ |
+
void |
+setNewLine(String newline)
+Sets the 'newLine'.
+ |
+
void |
+setOptionComparator(Comparator<Option> comparator)
+Set the comparator used to sort the options when they output in help text.
+ |
+
void |
+setOptPrefix(String prefix)
+Sets the 'optPrefix'.
+ |
+
void |
+setSyntaxPrefix(String prefix)
+Sets the 'syntaxPrefix'.
+ |
+
void |
+setWidth(int width)
+Sets the 'width'.
+ |
+
public static final int DEFAULT_WIDTH+
public static final int DEFAULT_LEFT_PAD+
public static final int DEFAULT_DESC_PAD+
public static final String DEFAULT_SYNTAX_PREFIX+
public static final String DEFAULT_OPT_PREFIX+
public static final String DEFAULT_LONG_OPT_PREFIX+
public static final String DEFAULT_LONG_OPT_SEPARATOR+
public static final String DEFAULT_ARG_NAME+
@Deprecated +public int defaultWidth+
@Deprecated +public int defaultLeftPad+
@Deprecated +public int defaultDescPad+
@Deprecated +public String defaultSyntaxPrefix+
@Deprecated +public String defaultNewLine+
@Deprecated +public String defaultOptPrefix+
@Deprecated +public String defaultLongOptPrefix+
@Deprecated +public String defaultArgName+
protected Comparator<Option> optionComparator+
public void setWidth(int width)+
width - the new value of 'width'public int getWidth()+
public void setLeftPadding(int padding)+
padding - the new value of 'leftPadding'public int getLeftPadding()+
public void setDescPadding(int padding)+
padding - the new value of 'descPadding'public int getDescPadding()+
public void setSyntaxPrefix(String prefix)+
prefix - the new value of 'syntaxPrefix'public String getSyntaxPrefix()+
public void setNewLine(String newline)+
newline - the new value of 'newLine'public String getNewLine()+
public void setOptPrefix(String prefix)+
prefix - the new value of 'optPrefix'public String getOptPrefix()+
public void setLongOptPrefix(String prefix)+
prefix - the new value of 'longOptPrefix'public String getLongOptPrefix()+
public void setLongOptSeparator(String longOptSeparator)+
longOptSeparator - the separator, typically ' ' or '='.public String getLongOptSeparator()+
public void setArgName(String name)+
name - the new value of 'argName'public String getArgName()+
public Comparator<Option> getOptionComparator()+
Comparator currently in use to sort the optionspublic void setOptionComparator(Comparator<Option> comparator)+
comparator - the Comparator to use for sorting the optionspublic void printHelp(String cmdLineSyntax, + Options options)+
options with the specified
+ command line syntax. This method prints help information to
+ System.out.cmdLineSyntax - the syntax for this applicationoptions - the Options instancepublic void printHelp(String cmdLineSyntax, + Options options, + boolean autoUsage)+
options with the specified
+ command line syntax. This method prints help information to
+ System.out.cmdLineSyntax - the syntax for this applicationoptions - the Options instanceautoUsage - whether to print an automatically generated
+ usage statementpublic void printHelp(String cmdLineSyntax, + String header, + Options options, + String footer)+
options with the specified
+ command line syntax. This method prints help information to
+ System.out.cmdLineSyntax - the syntax for this applicationheader - the banner to display at the beginning of the helpoptions - the Options instancefooter - the banner to display at the end of the helppublic void printHelp(String cmdLineSyntax, + String header, + Options options, + String footer, + boolean autoUsage)+
options with the specified
+ command line syntax. This method prints help information to
+ System.out.cmdLineSyntax - the syntax for this applicationheader - the banner to display at the beginning of the helpoptions - the Options instancefooter - the banner to display at the end of the helpautoUsage - whether to print an automatically generated
+ usage statementpublic void printHelp(int width, + String cmdLineSyntax, + String header, + Options options, + String footer)+
options with the specified
+ command line syntax. This method prints help information to
+ System.out.width - the number of characters to be displayed on each linecmdLineSyntax - the syntax for this applicationheader - the banner to display at the beginning of the helpoptions - the Options instancefooter - the banner to display at the end of the helppublic void printHelp(int width, + String cmdLineSyntax, + String header, + Options options, + String footer, + boolean autoUsage)+
options with the specified
+ command line syntax. This method prints help information to
+ System.out.width - the number of characters to be displayed on each linecmdLineSyntax - the syntax for this applicationheader - the banner to display at the beginning of the helpoptions - the Options instancefooter - the banner to display at the end of the helpautoUsage - whether to print an automatically generated
+ usage statementpublic void printHelp(PrintWriter pw, + int width, + String cmdLineSyntax, + String header, + Options options, + int leftPad, + int descPad, + String footer)+
options with the specified
+ command line syntax.pw - the writer to which the help will be writtenwidth - the number of characters to be displayed on each linecmdLineSyntax - the syntax for this applicationheader - the banner to display at the beginning of the helpoptions - the Options instanceleftPad - the number of characters of padding to be prefixed
+ to each linedescPad - the number of characters of padding to be prefixed
+ to each description linefooter - the banner to display at the end of the helpIllegalStateException - if there is no room to print a linepublic void printHelp(PrintWriter pw, + int width, + String cmdLineSyntax, + String header, + Options options, + int leftPad, + int descPad, + String footer, + boolean autoUsage)+
options with the specified
+ command line syntax.pw - the writer to which the help will be writtenwidth - the number of characters to be displayed on each linecmdLineSyntax - the syntax for this applicationheader - the banner to display at the beginning of the helpoptions - the Options instanceleftPad - the number of characters of padding to be prefixed
+ to each linedescPad - the number of characters of padding to be prefixed
+ to each description linefooter - the banner to display at the end of the helpautoUsage - whether to print an automatically generated
+ usage statementIllegalStateException - if there is no room to print a linepublic void printUsage(PrintWriter pw, + int width, + String app, + Options options)+
pw - The PrintWriter to print the usage statementwidth - The number of characters to display per lineapp - The application nameoptions - The command line Optionspublic void printUsage(PrintWriter pw, + int width, + String cmdLineSyntax)+
pw - The printWriter to write the help towidth - The number of characters per line for the usage statement.cmdLineSyntax - The usage statement.public void printOptions(PrintWriter pw, + int width, + Options options, + int leftPad, + int descPad)+
pw - The printWriter to write the help towidth - The number of characters to display per lineoptions - The command line OptionsleftPad - the number of characters of padding to be prefixed
+ to each linedescPad - the number of characters of padding to be prefixed
+ to each description linepublic void printWrapped(PrintWriter pw, + int width, + String text)+
pw - The printWriter to write the help towidth - The number of characters to display per linetext - The text to be written to the PrintWriterpublic void printWrapped(PrintWriter pw, + int width, + int nextLineTabStop, + String text)+
pw - The printWriter to write the help towidth - The number of characters to display per linenextLineTabStop - The position on the next line for the first tab.text - The text to be written to the PrintWriterprotected StringBuffer renderOptions(StringBuffer sb, + int width, + Options options, + int leftPad, + int descPad)+
sb - The StringBuffer to place the rendered Options into.width - The number of characters to display per lineoptions - The command line OptionsleftPad - the number of characters of padding to be prefixed
+ to each linedescPad - the number of characters of padding to be prefixed
+ to each description lineprotected StringBuffer renderWrappedText(StringBuffer sb, + int width, + int nextLineTabStop, + String text)+
sb - The StringBuffer to place the rendered text into.width - The number of characters to display per linenextLineTabStop - The position on the next line for the first tab.text - The text to be rendered.protected int findWrapPos(String text, + int width, + int startPos)+
startPos for the
+ text in text with the column width width.
+ The wrap point is the last position before startPos+width having a
+ whitespace character (space, \n, \r). If there is no whitespace character
+ before startPos+width, it will return startPos+width.text - The text being searched for the wrap positionwidth - width of the wrapped textstartPos - position from which to start the lookup whitespace
+ characterprotected String createPadding(int len)+
len.len - The length of the String of padding to create.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/MissingArgumentException.html b/apidocs/org/apache/commons/clipatched/MissingArgumentException.html new file mode 100644 index 0000000..fee91cd --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/MissingArgumentException.html @@ -0,0 +1,350 @@ + + + + + + +public class MissingArgumentException +extends ParseException+
| Constructor and Description | +
|---|
MissingArgumentException(Option option)
+Construct a new
+MissingArgumentException
+ with the specified detail message. |
+
MissingArgumentException(String message)
+Construct a new
+MissingArgumentException
+ with the specified detail message. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Option |
+getOption()
+Return the option requiring an argument that wasn't provided
+ on the command line.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic MissingArgumentException(String message)+
MissingArgumentException
+ with the specified detail message.message - the detail messagepublic MissingArgumentException(Option option)+
MissingArgumentException
+ with the specified detail message.option - the option requiring an argumentCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/MissingOptionException.html b/apidocs/org/apache/commons/clipatched/MissingOptionException.html new file mode 100644 index 0000000..5641a47 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/MissingOptionException.html @@ -0,0 +1,348 @@ + + + + + + +public class MissingOptionException +extends ParseException+
| Constructor and Description | +
|---|
MissingOptionException(List<Object> missingOptions)
+Constructs a new
+MissingSelectedException with the
+ specified list of missing options. |
+
MissingOptionException(String message)
+Construct a new
+MissingSelectedException
+ with the specified detail message. |
+
| Modifier and Type | +Method and Description | +
|---|---|
List<Object> |
+getMissingOptions()
+Returns the list of options or option groups missing in the command line parsed.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic MissingOptionException(String message)+
MissingSelectedException
+ with the specified detail message.message - the detail messagepublic List<Object> getMissingOptions()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/Option.Builder.html b/apidocs/org/apache/commons/clipatched/Option.Builder.html new file mode 100644 index 0000000..6f55dea --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/Option.Builder.html @@ -0,0 +1,561 @@ + + + + + + +public static final class Option.Builder +extends Object+
Option instances
+ using descriptive methods.
+ + Example usage: +
+ Option option = Option.builder("a")
+ .required(true)
+ .longOpt("arg-name")
+ .build();
+ | Modifier and Type | +Method and Description | +
|---|---|
Option.Builder |
+argName(String argName)
+Sets the display name for the argument value.
+ |
+
Option |
+build()
+Constructs an Option with the values declared by this
+Option.Builder. |
+
Option.Builder |
+desc(String description)
+Sets the description for this option.
+ |
+
Option.Builder |
+hasArg()
+Indicates that the Option will require an argument.
+ |
+
Option.Builder |
+hasArg(boolean hasArg)
+Indicates if the Option has an argument or not.
+ |
+
Option.Builder |
+hasArgs()
+Indicates that the Option can have unlimited argument values.
+ |
+
Option.Builder |
+longOpt(String longOpt)
+Sets the long name of the Option.
+ |
+
Option.Builder |
+numberOfArgs(int numberOfArgs)
+Sets the number of argument values the Option can take.
+ |
+
Option.Builder |
+optionalArg(boolean isOptional)
+Sets whether the Option can have an optional argument.
+ |
+
Option.Builder |
+required()
+Marks this Option as required.
+ |
+
Option.Builder |
+required(boolean required)
+Sets whether the Option is mandatory.
+ |
+
Option.Builder |
+type(Class<?> type)
+Sets the type of the Option.
+ |
+
Option.Builder |
+valueSeparator()
+The Option will use '=' as a means to separate argument value.
+ |
+
Option.Builder |
+valueSeparator(char sep)
+The Option will use
+sep as a means to
+ separate argument values. |
+
public Option.Builder argName(String argName)+
argName - the display name for the argument value.public Option.Builder desc(String description)+
description - the description of the option.public Option.Builder longOpt(String longOpt)+
longOpt - the long name of the Optionpublic Option.Builder numberOfArgs(int numberOfArgs)+
numberOfArgs - the number of argument valuespublic Option.Builder optionalArg(boolean isOptional)+
isOptional - specifies whether the Option can have
+ an optional argument.public Option.Builder required()+
public Option.Builder required(boolean required)+
required - specifies whether the Option is mandatorypublic Option.Builder type(Class<?> type)+
type - the type of the Optionpublic Option.Builder valueSeparator()+
public Option.Builder valueSeparator(char sep)+
sep as a means to
+ separate argument values.
+ + Example: +
+ Option opt = Option.builder("D").hasArgs()
+ .valueSeparator('=')
+ .build();
+ Options options = new Options();
+ options.addOption(opt);
+ String[] args = {"-Dkey=value"};
+ CommandLineParser parser = new DefaultParser();
+ CommandLine line = parser.parse(options, args);
+ String propertyName = line.getOptionValues("D")[0]; // will be "key"
+ String propertyValue = line.getOptionValues("D")[1]; // will be "value"
+ sep - The value separator.public Option.Builder hasArg()+
public Option.Builder hasArg(boolean hasArg)+
hasArg - specifies whether the Option takes an argument or notpublic Option.Builder hasArgs()+
public Option build()+
Option.Builder.OptionIllegalArgumentException - if neither opt or longOpt has been setCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/Option.html b/apidocs/org/apache/commons/clipatched/Option.html new file mode 100644 index 0000000..900295c --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/Option.html @@ -0,0 +1,1240 @@ + + + + + + +public class Option +extends Object +implements Cloneable, Serializable+
+ An Option is not created independently, but is created through
+ an instance of Options. An Option is required to have
+ at least a short or a long-name.
+
+ Note: once an Option has been added to an instance
+ of Options, it's required flag may not be changed anymore.
Options,
+CommandLine,
+Serialized Form| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Option.Builder
+A nested builder class to create
+Option instances
+ using descriptive methods. |
+
| Modifier and Type | +Field and Description | +
|---|---|
static int |
+UNINITIALIZED
+constant that specifies the number of argument values has not been specified
+ |
+
static int |
+UNLIMITED_VALUES
+constant that specifies the number of argument values is infinite
+ |
+
| Constructor and Description | +
|---|
Option(String opt,
+ boolean hasArg,
+ String description)
+Creates an Option using the specified parameters.
+ |
+
Option(String opt,
+ String description)
+Creates an Option using the specified parameters.
+ |
+
Option(String opt,
+ String longOpt,
+ boolean hasArg,
+ String description)
+Creates an Option using the specified parameters.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+addValue(String value)
+Deprecated.
+ |
+
static Option.Builder |
+builder()
+Returns a
+Option.Builder to create an Option using descriptive
+ methods. |
+
static Option.Builder |
+builder(String opt)
+Returns a
+Option.Builder to create an Option using descriptive
+ methods. |
+
Object |
+clone()
+A rather odd clone method - due to incorrect code in 1.0 it is public
+ and in 1.1 rather than throwing a CloneNotSupportedException it throws
+ a RuntimeException so as to maintain backwards compat at the API level.
+ |
+
boolean |
+equals(Object o) |
+
String |
+getArgName()
+Gets the display name for the argument value.
+ |
+
int |
+getArgs()
+Returns the number of argument values this Option can take.
+ |
+
String |
+getDescription()
+Retrieve the self-documenting description of this Option
+ |
+
int |
+getId()
+Returns the id of this Option.
+ |
+
String |
+getLongOpt()
+Retrieve the long name of this Option.
+ |
+
String |
+getOpt()
+Retrieve the name of this Option.
+ |
+
Object |
+getType()
+Retrieve the type of this Option.
+ |
+
String |
+getValue()
+Returns the specified value of this Option or
+
+null if there is no value. |
+
String |
+getValue(int index)
+Returns the specified value of this Option or
+
+null if there is no value. |
+
String |
+getValue(String defaultValue)
+Returns the value/first value of this Option or the
+
+defaultValue if there is no value. |
+
String[] |
+getValues()
+Return the values of this Option as a String array
+ or null if there are no values
+ |
+
char |
+getValueSeparator()
+Returns the value separator character.
+ |
+
List<String> |
+getValuesList() |
+
boolean |
+hasArg()
+Query to see if this Option requires an argument
+ |
+
boolean |
+hasArgName()
+Returns whether the display name for the argument value has been set.
+ |
+
boolean |
+hasArgs()
+Query to see if this Option can take many values.
+ |
+
int |
+hashCode() |
+
boolean |
+hasLongOpt()
+Query to see if this Option has a long name
+ |
+
boolean |
+hasOptionalArg() |
+
boolean |
+hasValueSeparator()
+Return whether this Option has specified a value separator.
+ |
+
boolean |
+isRequired()
+Query to see if this Option is mandatory
+ |
+
void |
+setArgName(String argName)
+Sets the display name for the argument value.
+ |
+
void |
+setArgs(int num)
+Sets the number of argument values this Option can take.
+ |
+
void |
+setDescription(String description)
+Sets the self-documenting description of this Option
+ |
+
void |
+setLongOpt(String longOpt)
+Sets the long name of this Option.
+ |
+
void |
+setOptionalArg(boolean optionalArg)
+Sets whether this Option can have an optional argument.
+ |
+
void |
+setRequired(boolean required)
+Sets whether this Option is mandatory.
+ |
+
void |
+setType(Class<?> type)
+Sets the type of this Option.
+ |
+
void |
+setType(Object type)
+Deprecated.
+
+since 1.3, use
+setType(Class) instead |
+
void |
+setValueSeparator(char sep)
+Sets the value separator.
+ |
+
String |
+toString()
+Dump state, suitable for debugging.
+ |
+
public static final int UNINITIALIZED+
public static final int UNLIMITED_VALUES+
public Option(String opt, + String description) + throws IllegalArgumentException+
opt - short representation of the optiondescription - describes the function of the optionIllegalArgumentException - if there are any non valid
+ Option characters in opt.public Option(String opt, + boolean hasArg, + String description) + throws IllegalArgumentException+
opt - short representation of the optionhasArg - specifies whether the Option takes an argument or notdescription - describes the function of the optionIllegalArgumentException - if there are any non valid
+ Option characters in opt.public Option(String opt, + String longOpt, + boolean hasArg, + String description) + throws IllegalArgumentException+
opt - short representation of the optionlongOpt - the long representation of the optionhasArg - specifies whether the Option takes an argument or notdescription - describes the function of the optionIllegalArgumentException - if there are any non valid
+ Option characters in opt.public int getId()+
public String getOpt()+
CommandLine.hasOption(String opt) and
+ CommandLine.getOptionValue(String opt) to check
+ for existence and argument.public Object getType()+
@Deprecated +public void setType(Object type)+
setType(Class) instead
+ Note: this method is kept for binary compatibility and the
+ input type is supposed to be a Class object.
type - the type of this Optionpublic void setType(Class<?> type)+
type - the type of this Optionpublic String getLongOpt()+
public void setLongOpt(String longOpt)+
longOpt - the long name of this Optionpublic void setOptionalArg(boolean optionalArg)+
optionalArg - specifies whether the Option can have
+ an optional argument.public boolean hasOptionalArg()+
public boolean hasLongOpt()+
public boolean hasArg()+
public String getDescription()+
public void setDescription(String description)+
description - The description of this optionpublic boolean isRequired()+
public void setRequired(boolean required)+
required - specifies whether this Option is mandatorypublic void setArgName(String argName)+
argName - the display name for the argument value.public String getArgName()+
public boolean hasArgName()+
public boolean hasArgs()+
public void setArgs(int num)+
num - the number of argument valuespublic void setValueSeparator(char sep)+
sep - The value separator.public char getValueSeparator()+
public boolean hasValueSeparator()+
public int getArgs()+
+ A value equal to the constant UNINITIALIZED (= -1) indicates
+ the number of arguments has not been specified.
+ A value equal to the constant UNLIMITED_VALUES (= -2) indicates
+ that this options takes an unlimited amount of values.
+
UNINITIALIZED,
+UNLIMITED_VALUESpublic String getValue()+
null if there is no value.null if there is no value.public String getValue(int index) + throws IndexOutOfBoundsException+
null if there is no value.index - The index of the value to be returned.null if there is no value.IndexOutOfBoundsException - if index is less than 1
+ or greater than the number of the values for this Option.public String getValue(String defaultValue)+
defaultValue if there is no value.defaultValue - The value to be returned if there
+ is no value.defaultValue if there are no values.public String[] getValues()+
public List<String> getValuesList()+
public String toString()+
public Object clone()+
clone in class ObjectRuntimeException - if a CloneNotSupportedException has been thrown
+ by super.clone()@Deprecated +public boolean addValue(String value)+
value - the value to addUnsupportedOperationExceptionUnsupportedOperationException - alwayspublic static Option.Builder builder()+
Option.Builder to create an Option using descriptive
+ methods.Option.Builder instancepublic static Option.Builder builder(String opt)+
Option.Builder to create an Option using descriptive
+ methods.opt - short representation of the optionOption.Builder instanceIllegalArgumentException - if there are any non valid Option characters in optCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/OptionBuilder.html b/apidocs/org/apache/commons/clipatched/OptionBuilder.html new file mode 100644 index 0000000..8c2ab7f --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/OptionBuilder.html @@ -0,0 +1,740 @@ + + + + + + +Option.builder(String) instead@Deprecated +public final class OptionBuilder +extends Object+
+ Details on the Builder pattern can be found at + http://c2.com/cgi-bin/wiki?BuilderPattern. +
+ This class is NOT thread safe. See CLI-209
| Modifier and Type | +Method and Description | +
|---|---|
static Option |
+create()
+Deprecated.
+Create an Option using the current settings
+ |
+
static Option |
+create(char opt)
+Deprecated.
+Create an Option using the current settings and with
+ the specified Option
+char. |
+
static Option |
+create(String opt)
+Deprecated.
+Create an Option using the current settings and with
+ the specified Option
+char. |
+
static OptionBuilder |
+hasArg()
+Deprecated.
+The next Option created will require an argument value.
+ |
+
static OptionBuilder |
+hasArg(boolean hasArg)
+Deprecated.
+The next Option created will require an argument value if
+
+hasArg is true. |
+
static OptionBuilder |
+hasArgs()
+Deprecated.
+The next Option created can have unlimited argument values.
+ |
+
static OptionBuilder |
+hasArgs(int num)
+Deprecated.
+The next Option created can have
+num argument values. |
+
static OptionBuilder |
+hasOptionalArg()
+Deprecated.
+The next Option can have an optional argument.
+ |
+
static OptionBuilder |
+hasOptionalArgs()
+Deprecated.
+The next Option can have an unlimited number of optional arguments.
+ |
+
static OptionBuilder |
+hasOptionalArgs(int numArgs)
+Deprecated.
+The next Option can have the specified number of optional arguments.
+ |
+
static OptionBuilder |
+isRequired()
+Deprecated.
+The next Option created will be required.
+ |
+
static OptionBuilder |
+isRequired(boolean newRequired)
+Deprecated.
+The next Option created will be required if
+required
+ is true. |
+
static OptionBuilder |
+withArgName(String name)
+Deprecated.
+The next Option created will have the specified argument value name.
+ |
+
static OptionBuilder |
+withDescription(String newDescription)
+Deprecated.
+The next Option created will have the specified description
+ |
+
static OptionBuilder |
+withLongOpt(String newLongopt)
+Deprecated.
+The next Option created will have the following long option value.
+ |
+
static OptionBuilder |
+withType(Class<?> newType)
+Deprecated.
+The next Option created will have a value that will be an instance
+ of
+type. |
+
static OptionBuilder |
+withType(Object newType)
+Deprecated.
+
+since 1.3, use
+withType(Class) instead |
+
static OptionBuilder |
+withValueSeparator()
+Deprecated.
+The next Option created uses '
+=' as a means to
+ separate argument values. |
+
static OptionBuilder |
+withValueSeparator(char sep)
+Deprecated.
+The next Option created uses
+sep as a means to
+ separate argument values. |
+
public static OptionBuilder withLongOpt(String newLongopt)+
newLongopt - the long option valuepublic static OptionBuilder hasArg()+
public static OptionBuilder hasArg(boolean hasArg)+
hasArg is true.hasArg - if true then the Option has an argument valuepublic static OptionBuilder withArgName(String name)+
name - the name for the argument valuepublic static OptionBuilder isRequired()+
public static OptionBuilder withValueSeparator(char sep)+
sep as a means to
+ separate argument values.
+ + Example: +
+ Option opt = OptionBuilder.withValueSeparator('=')
+ .create('D');
+
+ String args = "-Dkey=value";
+ CommandLine line = parser.parse(args);
+ String propertyName = opt.getValue(0); // will be "key"
+ String propertyValue = opt.getValue(1); // will be "value"
+ sep - The value separator to be used for the argument values.public static OptionBuilder withValueSeparator()+
=' as a means to
+ separate argument values.
+
+ Example:
+
+ Option opt = OptionBuilder.withValueSeparator()
+ .create('D');
+
+ CommandLine line = parser.parse(args);
+ String propertyName = opt.getValue(0);
+ String propertyValue = opt.getValue(1);
+ public static OptionBuilder isRequired(boolean newRequired)+
required
+ is true.newRequired - if true then the Option is requiredpublic static OptionBuilder hasArgs()+
public static OptionBuilder hasArgs(int num)+
num argument values.num - the number of args that the option can havepublic static OptionBuilder hasOptionalArg()+
public static OptionBuilder hasOptionalArgs()+
public static OptionBuilder hasOptionalArgs(int numArgs)+
numArgs - - the maximum number of optional arguments
+ the next Option created can have.@Deprecated +public static OptionBuilder withType(Object newType)+
withType(Class) insteadtype.
+
+ Note: this method is kept for binary compatibility and the
+ input type is supposed to be a Class object.
newType - the type of the Options argument valuepublic static OptionBuilder withType(Class<?> newType)+
type.newType - the type of the Options argument valuepublic static OptionBuilder withDescription(String newDescription)+
newDescription - a description of the Option's purposepublic static Option create(char opt) + throws IllegalArgumentException+
char.opt - the character representation of the OptionIllegalArgumentException - if opt is not
+ a valid character. See Option.public static Option create() + throws IllegalArgumentException+
IllegalArgumentException - if longOpt has not been set.public static Option create(String opt) + throws IllegalArgumentException+
char.opt - the java.lang.String representation
+ of the OptionIllegalArgumentException - if opt is not
+ a valid character. See Option.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/OptionGroup.html b/apidocs/org/apache/commons/clipatched/OptionGroup.html new file mode 100644 index 0000000..f92d534 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/OptionGroup.html @@ -0,0 +1,429 @@ + + + + + + +public class OptionGroup +extends Object +implements Serializable+
| Constructor and Description | +
|---|
OptionGroup() |
+
| Modifier and Type | +Method and Description | +
|---|---|
OptionGroup |
+addOption(Option option)
+Add the specified
+Option to this group. |
+
Collection<String> |
+getNames() |
+
Collection<Option> |
+getOptions() |
+
String |
+getSelected() |
+
boolean |
+isRequired()
+Returns whether this option group is required.
+ |
+
void |
+setRequired(boolean required) |
+
void |
+setSelected(Option option)
+Set the selected option of this group to
+name. |
+
String |
+toString()
+Returns the stringified version of this OptionGroup.
+ |
+
public OptionGroup addOption(Option option)+
Option to this group.option - the option to add to this grouppublic Collection<String> getNames()+
Collectionpublic Collection<Option> getOptions()+
Collectionpublic void setSelected(Option option) + throws AlreadySelectedException+
name.option - the option that is selectedAlreadySelectedException - if an option from this group has
+ already been selected.public String getSelected()+
public void setRequired(boolean required)+
required - specifies if this group is requiredpublic boolean isRequired()+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/Options.html b/apidocs/org/apache/commons/clipatched/Options.html new file mode 100644 index 0000000..0f6cbe3 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/Options.html @@ -0,0 +1,671 @@ + + + + + + +public class Options +extends Object +implements Serializable+
+ Options represents a collection of Option objects, which
+ describe the possible options for a command-line.
+
+ It may flexibly parse long and short options, with or without + values. Additionally, it may parse only a portion of a commandline, + allowing for flexible multi-stage parsing.
CommandLine,
+Serialized Form| Modifier and Type | +Method and Description | +
|---|---|
Options |
+addOption(Option opt)
+Adds an option instance
+ |
+
Options |
+addOption(String opt,
+ boolean hasArg,
+ String description)
+Add an option that only contains a short-name.
+ |
+
Options |
+addOption(String opt,
+ String description)
+Add an option that only contains a short name.
+ |
+
Options |
+addOption(String opt,
+ String longOpt,
+ boolean hasArg,
+ String description)
+Add an option that contains a short-name and a long-name.
+ |
+
Options |
+addOptionGroup(OptionGroup group)
+Add the specified option group.
+ |
+
Options |
+addRequiredOption(String opt,
+ String longOpt,
+ boolean hasArg,
+ String description)
+Add an option that contains a short-name and a long-name.
+ |
+
List<String> |
+getMatchingOptions(String opt)
+Returns the options with a long name starting with the name specified.
+ |
+
Option |
+getOption(String opt)
+Retrieve the
+Option matching the long or short name specified. |
+
OptionGroup |
+getOptionGroup(Option opt)
+Returns the OptionGroup the
+opt belongs to. |
+
Collection<Option> |
+getOptions()
+Retrieve a read-only list of options in this set
+ |
+
List<Object> |
+getRequiredOptions()
+Returns the required options.
+ |
+
boolean |
+hasLongOption(String opt)
+
+ |
+
boolean |
+hasOption(String opt)
+
+ |
+
boolean |
+hasShortOption(String opt)
+
+ |
+
String |
+toString()
+Dump state, suitable for debugging.
+ |
+
public Options addOptionGroup(OptionGroup group)+
group - the OptionGroup that is to be addedpublic Options addOption(String opt, + String description)+
+ The option does not take an argument. +
opt - Short single-character name of the option.description - Self-documenting descriptionpublic Options addOption(String opt, + boolean hasArg, + String description)+
+ It may be specified as requiring an argument. +
opt - Short single-character name of the option.hasArg - flag signally if an argument is required after this optiondescription - Self-documenting descriptionpublic Options addOption(String opt, + String longOpt, + boolean hasArg, + String description)+
+ It may be specified as requiring an argument. +
opt - Short single-character name of the option.longOpt - Long multi-character name of the option.hasArg - flag signally if an argument is required after this optiondescription - Self-documenting descriptionpublic Options addRequiredOption(String opt, + String longOpt, + boolean hasArg, + String description)+
+ The added option is set as required. It may be specified as requiring an argument. This method is a shortcut for: +
+ +
+
+ Options option = new Option(opt, longOpt, hasArg, description);
+ option.setRequired(true);
+ options.add(option);
+
+ opt - Short single-character name of the option.longOpt - Long multi-character name of the option.hasArg - flag signally if an argument is required after this optiondescription - Self-documenting descriptionpublic Options addOption(Option opt)+
opt - the option that is to be addedpublic Collection<Option> getOptions()+
Option objects in this descriptorpublic List<Object> getRequiredOptions()+
public Option getOption(String opt)+
Option matching the long or short name specified.
+
+ + The leading hyphens in the name are ignored (up to 2). +
opt - short or long name of the Optionpublic List<String> getMatchingOptions(String opt)+
opt - the partial name of the optionpublic boolean hasOption(String opt)+ + +
public boolean hasLongOption(String opt)+ + +
public boolean hasShortOption(String opt)+ + +
public OptionGroup getOptionGroup(Option opt)+
opt belongs to.opt - the option whose OptionGroup is being queried.opt is part of an OptionGroup, otherwise return nullCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/ParseException.html b/apidocs/org/apache/commons/clipatched/ParseException.html new file mode 100644 index 0000000..179c2c0 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/ParseException.html @@ -0,0 +1,280 @@ + + + + + + +public class ParseException +extends Exception+
| Constructor and Description | +
|---|
ParseException(String message)
+Construct a new
+ParseException
+ with the specified detail message. |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/Parser.html b/apidocs/org/apache/commons/clipatched/Parser.html new file mode 100644 index 0000000..c6e21d9 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/Parser.html @@ -0,0 +1,676 @@ + + + + + + +@Deprecated +public abstract class Parser +extends Object +implements CommandLineParser+
Parser creates CommandLines.| Modifier and Type | +Field and Description | +
|---|---|
protected CommandLine |
+cmd
+Deprecated.
+commandline instance
+ |
+
| Constructor and Description | +
|---|
Parser()
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+checkRequiredOptions()
+Deprecated.
+Throws a
+MissingOptionException if all of the required options
+ are not present. |
+
protected abstract String[] |
+flatten(Options opts,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Subclasses must implement this method to reduce
+ the
+arguments that have been passed to the parse method. |
+
protected Options |
+getOptions()
+Deprecated.
+ |
+
protected List<Object> |
+getRequiredOptions()
+Deprecated.
+ |
+
CommandLine |
+parse(Options options,
+ String[] arguments)
+Deprecated.
+Parses the specified
+arguments based
+ on the specified Options. |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Parses the specified
+arguments
+ based on the specified Options. |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ Properties properties)
+Deprecated.
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Deprecated.
+Parse the arguments according to the specified options and
+ properties.
+ |
+
void |
+processArgs(Option opt,
+ ListIterator<String> iter)
+Deprecated.
+Process the argument values for the specified Option
+
+opt using the values retrieved from the
+ specified iterator iter. |
+
protected void |
+processOption(String arg,
+ ListIterator<String> iter)
+Deprecated.
+Process the Option specified by
+arg using the values
+ retrieved from the specified iterator iter. |
+
protected void |
+processProperties(Properties properties)
+Deprecated.
+Sets the values of Options using the values in
+properties. |
+
protected void |
+setOptions(Options options)
+Deprecated.
+ |
+
protected CommandLine cmd+
protected void setOptions(Options options)+
protected Options getOptions()+
protected abstract String[] flatten(Options opts, + String[] arguments, + boolean stopAtNonOption) + throws ParseException+
arguments that have been passed to the parse method.opts - The Options to parse the arguments by.arguments - The arguments that have to be flattened.stopAtNonOption - specifies whether to stop
+ flattening when a non option has been encounteredParseException - if there are any problems encountered
+ while parsing the command line tokens.public CommandLine parse(Options options, + String[] arguments) + throws ParseException+
arguments based
+ on the specified Options.parse in interface CommandLineParseroptions - the Optionsarguments - the argumentsCommandLineParseException - if there are any problems encountered
+ while parsing the command line tokens.public CommandLine parse(Options options, + String[] arguments, + Properties properties) + throws ParseException+
options - the specified Optionsarguments - the command line argumentsproperties - command line option name-value pairsParseException - if there are any problems encountered
+ while parsing the command line tokens.public CommandLine parse(Options options, + String[] arguments, + boolean stopAtNonOption) + throws ParseException+
arguments
+ based on the specified Options.parse in interface CommandLineParseroptions - the Optionsarguments - the argumentsstopAtNonOption - if true an unrecognized argument stops
+ the parsing and the remaining arguments are added to the
+ CommandLines args list. If false an unrecognized
+ argument triggers a ParseException.CommandLineParseException - if an error occurs when parsing the arguments.public CommandLine parse(Options options, + String[] arguments, + Properties properties, + boolean stopAtNonOption) + throws ParseException+
options - the specified Optionsarguments - the command line argumentsproperties - command line option name-value pairsstopAtNonOption - if true an unrecognized argument stops
+ the parsing and the remaining arguments are added to the
+ CommandLines args list. If false an unrecognized
+ argument triggers a ParseException.ParseException - if there are any problems encountered
+ while parsing the command line tokens.protected void processProperties(Properties properties) + throws ParseException+
properties.properties - The value properties to be processed.ParseException - if there are any problems encountered
+ while processing the properties.protected void checkRequiredOptions() + throws MissingOptionException+
MissingOptionException if all of the required options
+ are not present.MissingOptionException - if any of the required Options are not present.public void processArgs(Option opt, + ListIterator<String> iter) + throws ParseException+
opt using the values retrieved from the
+ specified iterator iter.opt - The current Optioniter - The iterator over the flattened command line Options.ParseException - if an argument value is required
+ and it is has not been found.protected void processOption(String arg, + ListIterator<String> iter) + throws ParseException+
arg using the values
+ retrieved from the specified iterator iter.arg - The String value representing an Optioniter - The iterator over the flattened command line arguments.ParseException - if arg does not represent an OptionCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/PatternOptionBuilder.html b/apidocs/org/apache/commons/clipatched/PatternOptionBuilder.html new file mode 100644 index 0000000..835cc52 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/PatternOptionBuilder.html @@ -0,0 +1,526 @@ + + + + + + +public class PatternOptionBuilder +extends Object+
Allows Options to be created from a single String. + The pattern contains various single character flags and via + an optional punctuation character, their expected type. +
+ +| a | -a flag |
| b@ | -b [classname] |
| c> | -c [filename] |
| d+ | -d [classname] (creates object via empty constructor) |
| e% | -e [number] (creates Double/Long instance depending on existing of a '.') |
| f/ | -f [url] |
| g: | -g [string] |
+ For example, the following allows command line flags of '-v -p string-value -f /dir/file'. + The exclamation mark precede a mandatory option. +
+ +
+ Options options = PatternOptionBuilder.parsePattern("vp:!f/");
+
+
+ + TODO: These need to break out to OptionType and also to be pluggable. +
| Modifier and Type | +Field and Description | +
|---|---|
static Class<?> |
+CLASS_VALUE
+Class class
+ |
+
static Class<Date> |
+DATE_VALUE
+Date class
+ |
+
static Class<FileInputStream> |
+EXISTING_FILE_VALUE
+FileInputStream class
+ |
+
static Class<File> |
+FILE_VALUE
+File class
+ |
+
static Class<File[]> |
+FILES_VALUE
+File array class
+ |
+
static Class<Number> |
+NUMBER_VALUE
+Number class
+ |
+
static Class<Object> |
+OBJECT_VALUE
+Object class
+ |
+
static Class<String> |
+STRING_VALUE
+String class
+ |
+
static Class<URL> |
+URL_VALUE
+URL class
+ |
+
| Constructor and Description | +
|---|
PatternOptionBuilder() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Object |
+getValueClass(char ch)
+Retrieve the class that
+ch represents. |
+
static boolean |
+isValueCode(char ch)
+Returns whether
+ch is a value code, i.e. |
+
static Options |
+parsePattern(String pattern)
+Returns the
+Options instance represented by pattern. |
+
public static final Class<?> CLASS_VALUE+
public static final Class<FileInputStream> EXISTING_FILE_VALUE+
public static Object getValueClass(char ch)+
ch represents.ch - the specified characterch representspublic static boolean isValueCode(char ch)+
ch is a value code, i.e.
+ whether it represents a class in a pattern.ch - the specified characterch is a value code, otherwise false.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/PosixParser.html b/apidocs/org/apache/commons/clipatched/PosixParser.html new file mode 100644 index 0000000..3d3fa75 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/PosixParser.html @@ -0,0 +1,416 @@ + + + + + + +DefaultParser instead@Deprecated +public class PosixParser +extends Parser+
flatten method.| Constructor and Description | +
|---|
PosixParser()
+Deprecated.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+burstToken(String token,
+ boolean stopAtNonOption)
+Deprecated.
+Breaks
+token into its constituent parts
+ using the following algorithm. |
+
protected String[] |
+flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
checkRequiredOptions, getOptions, getRequiredOptions, parse, parse, parse, parse, processArgs, processOption, processProperties, setOptionsprotected String[] flatten(Options options, + String[] arguments, + boolean stopAtNonOption) + throws ParseException+
An implementation of Parser's abstract
+ flatten method.
The following are the rules used by this flatten method.
+stopAtNonOption is true then do not
+ burst anymore of arguments entries, just add each
+ successive entry without further processing. Otherwise, ignore
+ stopAtNonOption.arguments entry is "--"
+ just add the entry to the list of processed tokensarguments entry is "-"
+ just add the entry to the list of processed tokensarguments entry is two characters
+ in length and the first character is "-" then check if this
+ is a valid Option id. If it is a valid id, then add the
+ entry to the list of processed tokens and set the current Option
+ member. If it is not a valid id and stopAtNonOption
+ is true, then the remaining entries are copied to the list of
+ processed tokens. Otherwise, the current entry is ignored.arguments entry is more than two
+ characters in length and the first character is "-" then
+ we need to burst the entry to determine its constituents. For more
+ information on the bursting algorithm see
+ burstToken.arguments entry is not handled
+ by any of the previous rules, then the entry is added to the list
+ of processed tokens.flatten in class Parseroptions - The command line Optionsarguments - The command line arguments to be parsedstopAtNonOption - Specifies whether to stop flattening
+ when an non option is found.arguments String array.ParseException - if there are any problems encountered
+ while parsing the command line tokens.protected void burstToken(String token, + boolean stopAtNonOption)+
token into its constituent parts
+ using the following algorithm.
+
+ Option
+ exists with that id.Option does exist then add that character
+ prepended with "-" to the list of processed tokens.Option can have an argument value and there
+ are remaining characters in the token then add the remaining
+ characters as a token to the list of processed tokens.Option does NOT exist AND
+ stopAtNonOption IS set then add the special token
+ "--" followed by the remaining characters and also
+ the remaining tokens directly to the processed tokens list.Option does NOT exist AND
+ stopAtNonOption IS NOT set then add that
+ character prepended with "-".token - The current token to be burststopAtNonOption - Specifies whether to stop processing
+ at the first non-Option encountered.Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/TypeHandler.html b/apidocs/org/apache/commons/clipatched/TypeHandler.html new file mode 100644 index 0000000..eddf456 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/TypeHandler.html @@ -0,0 +1,508 @@ + + + + + + +public class TypeHandler +extends Object+
| Constructor and Description | +
|---|
TypeHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Class<?> |
+createClass(String classname)
+Returns the class whose name is
+classname. |
+
static Date |
+createDate(String str)
+Returns the date represented by
+str. |
+
static File |
+createFile(String str)
+Returns the File represented by
+str. |
+
static File[] |
+createFiles(String str)
+Returns the File[] represented by
+str. |
+
static Number |
+createNumber(String str)
+Create a number from a String.
+ |
+
static Object |
+createObject(String classname)
+Create an Object from the classname and empty constructor.
+ |
+
static URL |
+createURL(String str)
+Returns the URL represented by
+str. |
+
static Object |
+createValue(String str,
+ Class<?> clazz)
+Returns the
+Object of type clazz
+ with the value of str. |
+
static Object |
+createValue(String str,
+ Object obj)
+Returns the
+Object of type obj
+ with the value of str. |
+
public static Object createValue(String str, + Object obj) + throws ParseException+
Object of type obj
+ with the value of str.str - the command line valueobj - the type of argumentobj initialised with
+ the value of str.ParseException - if the value creation for the given object type failedpublic static Object createValue(String str, + Class<?> clazz) + throws ParseException+
Object of type clazz
+ with the value of str.str - the command line valueclazz - the type of argumentclazz initialised with
+ the value of str.ParseException - if the value creation for the given class failedpublic static Object createObject(String classname) + throws ParseException+
classname - the argument valueParseException - if the class could not be found or the object could not be createdpublic static Number createNumber(String str) + throws ParseException+
str - the valuestrParseException - if str is not a numberpublic static Class<?> createClass(String classname) + throws ParseException+
classname.classname - the class nameParseException - if the class could not be foundpublic static Date createDate(String str)+
str.
+
+ This method is not yet implemented and always throws an
+ UnsupportedOperationException.
str - the date stringstr is a valid date string,
+ otherwise return null.UnsupportedOperationException - alwayspublic static URL createURL(String str) + throws ParseException+
str.str - the URL stringstr is well-formedParseException - if the URL in str is not well-formedpublic static File createFile(String str)+
str.str - the File locationstr.public static File[] createFiles(String str)+
str.
+
+ This method is not yet implemented and always throws an
+ UnsupportedOperationException.
str - the paths to the filesstr.UnsupportedOperationException - alwaysCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/UnrecognizedOptionException.html b/apidocs/org/apache/commons/clipatched/UnrecognizedOptionException.html new file mode 100644 index 0000000..c9d517c --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/UnrecognizedOptionException.html @@ -0,0 +1,355 @@ + + + + + + +public class UnrecognizedOptionException +extends ParseException+
| Constructor and Description | +
|---|
UnrecognizedOptionException(String message)
+Construct a new
+UnrecognizedArgumentException
+ with the specified detail message. |
+
UnrecognizedOptionException(String message,
+ String option)
+Construct a new
+UnrecognizedArgumentException
+ with the specified option and detail message. |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getOption()
+Returns the unrecognized option.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/AlreadySelectedException.html b/apidocs/org/apache/commons/clipatched/class-use/AlreadySelectedException.html new file mode 100644 index 0000000..0607a57 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/AlreadySelectedException.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+OptionGroup.setSelected(Option option)
+Set the selected option of this group to
+name. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/AmbiguousOptionException.html b/apidocs/org/apache/commons/clipatched/class-use/AmbiguousOptionException.html new file mode 100644 index 0000000..0537899 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/AmbiguousOptionException.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/BasicParser.html b/apidocs/org/apache/commons/clipatched/class-use/BasicParser.html new file mode 100644 index 0000000..6ead1d1 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/BasicParser.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/CommandLine.html b/apidocs/org/apache/commons/clipatched/class-use/CommandLine.html new file mode 100644 index 0000000..173b648 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/CommandLine.html @@ -0,0 +1,268 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected CommandLine |
+DefaultParser.cmd
+The command-line instance.
+ |
+
protected CommandLine |
+Parser.cmd
+Deprecated.
+commandline instance
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CommandLine |
+CommandLineParser.parse(Options options,
+ String[] arguments)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments) |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments)
+Deprecated.
+Parses the specified
+arguments based
+ on the specified Options. |
+
CommandLine |
+CommandLineParser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption) |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Parses the specified
+arguments
+ based on the specified Options. |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ Properties properties)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ Properties properties)
+Deprecated.
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Deprecated.
+Parse the arguments according to the specified options and
+ properties.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/CommandLineParser.html b/apidocs/org/apache/commons/clipatched/class-use/CommandLineParser.html new file mode 100644 index 0000000..d16d73f --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/CommandLineParser.html @@ -0,0 +1,202 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BasicParser
+Deprecated.
+
+since 1.3, use the
+DefaultParser instead |
+
class |
+DefaultParser
+Default parser.
+ |
+
class |
+GnuParser
+Deprecated.
+
+since 1.3, use the
+DefaultParser instead |
+
class |
+Parser
+Deprecated.
+
+since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases
+ |
+
class |
+PosixParser
+Deprecated.
+
+since 1.3, use the
+DefaultParser instead |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/DefaultParser.html b/apidocs/org/apache/commons/clipatched/class-use/DefaultParser.html new file mode 100644 index 0000000..1208291 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/DefaultParser.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/GnuParser.html b/apidocs/org/apache/commons/clipatched/class-use/GnuParser.html new file mode 100644 index 0000000..61273b2 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/GnuParser.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/HelpFormatter.html b/apidocs/org/apache/commons/clipatched/class-use/HelpFormatter.html new file mode 100644 index 0000000..f2c343e --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/HelpFormatter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/MissingArgumentException.html b/apidocs/org/apache/commons/clipatched/class-use/MissingArgumentException.html new file mode 100644 index 0000000..6fa515b --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/MissingArgumentException.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/MissingOptionException.html b/apidocs/org/apache/commons/clipatched/class-use/MissingOptionException.html new file mode 100644 index 0000000..36e5fb1 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/MissingOptionException.html @@ -0,0 +1,172 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+Parser.checkRequiredOptions()
+Deprecated.
+Throws a
+MissingOptionException if all of the required options
+ are not present. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/Option.Builder.html b/apidocs/org/apache/commons/clipatched/class-use/Option.Builder.html new file mode 100644 index 0000000..fc98ac1 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/Option.Builder.html @@ -0,0 +1,257 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Option.Builder |
+Option.Builder.argName(String argName)
+Sets the display name for the argument value.
+ |
+
static Option.Builder |
+Option.builder()
+Returns a
+Option.Builder to create an Option using descriptive
+ methods. |
+
static Option.Builder |
+Option.builder(String opt)
+Returns a
+Option.Builder to create an Option using descriptive
+ methods. |
+
Option.Builder |
+Option.Builder.desc(String description)
+Sets the description for this option.
+ |
+
Option.Builder |
+Option.Builder.hasArg()
+Indicates that the Option will require an argument.
+ |
+
Option.Builder |
+Option.Builder.hasArg(boolean hasArg)
+Indicates if the Option has an argument or not.
+ |
+
Option.Builder |
+Option.Builder.hasArgs()
+Indicates that the Option can have unlimited argument values.
+ |
+
Option.Builder |
+Option.Builder.longOpt(String longOpt)
+Sets the long name of the Option.
+ |
+
Option.Builder |
+Option.Builder.numberOfArgs(int numberOfArgs)
+Sets the number of argument values the Option can take.
+ |
+
Option.Builder |
+Option.Builder.optionalArg(boolean isOptional)
+Sets whether the Option can have an optional argument.
+ |
+
Option.Builder |
+Option.Builder.required()
+Marks this Option as required.
+ |
+
Option.Builder |
+Option.Builder.required(boolean required)
+Sets whether the Option is mandatory.
+ |
+
Option.Builder |
+Option.Builder.type(Class<?> type)
+Sets the type of the Option.
+ |
+
Option.Builder |
+Option.Builder.valueSeparator()
+The Option will use '=' as a means to separate argument value.
+ |
+
Option.Builder |
+Option.Builder.valueSeparator(char sep)
+The Option will use
+sep as a means to
+ separate argument values. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/Option.html b/apidocs/org/apache/commons/clipatched/class-use/Option.html new file mode 100644 index 0000000..4089e6a --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/Option.html @@ -0,0 +1,366 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected Option |
+DefaultParser.currentOption
+The last option parsed.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected Comparator<Option> |
+HelpFormatter.optionComparator
+Comparator used to sort the options when they output in help text
+
+ Defaults to case-insensitive alphabetical sorting by option key
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Option |
+Option.Builder.build()
+Constructs an Option with the values declared by this
+Option.Builder. |
+
static Option |
+OptionBuilder.create()
+Deprecated.
+Create an Option using the current settings
+ |
+
static Option |
+OptionBuilder.create(char opt)
+Deprecated.
+Create an Option using the current settings and with
+ the specified Option
+char. |
+
static Option |
+OptionBuilder.create(String opt)
+Deprecated.
+Create an Option using the current settings and with
+ the specified Option
+char. |
+
Option |
+MissingArgumentException.getOption()
+Return the option requiring an argument that wasn't provided
+ on the command line.
+ |
+
Option |
+AlreadySelectedException.getOption()
+Returns the option that was added to the group and triggered the exception.
+ |
+
Option |
+Options.getOption(String opt)
+Retrieve the
+Option matching the long or short name specified. |
+
Option[] |
+CommandLine.getOptions()
+Returns an array of the processed
+Options. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Comparator<Option> |
+HelpFormatter.getOptionComparator()
+Comparator used to sort the options when they output in help text.
+ |
+
Collection<Option> |
+Options.getOptions()
+Retrieve a read-only list of options in this set
+ |
+
Collection<Option> |
+OptionGroup.getOptions() |
+
Iterator<Option> |
+CommandLine.iterator()
+Returns an iterator over the Option members of CommandLine.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+CommandLine.addOption(Option opt)
+Add an option to the command line.
+ |
+
Options |
+Options.addOption(Option opt)
+Adds an option instance
+ |
+
OptionGroup |
+OptionGroup.addOption(Option option)
+Add the specified
+Option to this group. |
+
OptionGroup |
+Options.getOptionGroup(Option opt)
+Returns the OptionGroup the
+opt belongs to. |
+
void |
+Parser.processArgs(Option opt,
+ ListIterator<String> iter)
+Deprecated.
+Process the argument values for the specified Option
+
+opt using the values retrieved from the
+ specified iterator iter. |
+
void |
+OptionGroup.setSelected(Option option)
+Set the selected option of this group to
+name. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+HelpFormatter.setOptionComparator(Comparator<Option> comparator)
+Set the comparator used to sort the options when they output in help text.
+ |
+
| Constructor and Description | +
|---|
AlreadySelectedException(OptionGroup group,
+ Option option)
+Construct a new
+AlreadySelectedException
+ for the specified option group. |
+
MissingArgumentException(Option option)
+Construct a new
+MissingArgumentException
+ with the specified detail message. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/OptionBuilder.html b/apidocs/org/apache/commons/clipatched/class-use/OptionBuilder.html new file mode 100644 index 0000000..2139b9e --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/OptionBuilder.html @@ -0,0 +1,282 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static OptionBuilder |
+OptionBuilder.hasArg()
+Deprecated.
+The next Option created will require an argument value.
+ |
+
static OptionBuilder |
+OptionBuilder.hasArg(boolean hasArg)
+Deprecated.
+The next Option created will require an argument value if
+
+hasArg is true. |
+
static OptionBuilder |
+OptionBuilder.hasArgs()
+Deprecated.
+The next Option created can have unlimited argument values.
+ |
+
static OptionBuilder |
+OptionBuilder.hasArgs(int num)
+Deprecated.
+The next Option created can have
+num argument values. |
+
static OptionBuilder |
+OptionBuilder.hasOptionalArg()
+Deprecated.
+The next Option can have an optional argument.
+ |
+
static OptionBuilder |
+OptionBuilder.hasOptionalArgs()
+Deprecated.
+The next Option can have an unlimited number of optional arguments.
+ |
+
static OptionBuilder |
+OptionBuilder.hasOptionalArgs(int numArgs)
+Deprecated.
+The next Option can have the specified number of optional arguments.
+ |
+
static OptionBuilder |
+OptionBuilder.isRequired()
+Deprecated.
+The next Option created will be required.
+ |
+
static OptionBuilder |
+OptionBuilder.isRequired(boolean newRequired)
+Deprecated.
+The next Option created will be required if
+required
+ is true. |
+
static OptionBuilder |
+OptionBuilder.withArgName(String name)
+Deprecated.
+The next Option created will have the specified argument value name.
+ |
+
static OptionBuilder |
+OptionBuilder.withDescription(String newDescription)
+Deprecated.
+The next Option created will have the specified description
+ |
+
static OptionBuilder |
+OptionBuilder.withLongOpt(String newLongopt)
+Deprecated.
+The next Option created will have the following long option value.
+ |
+
static OptionBuilder |
+OptionBuilder.withType(Class<?> newType)
+Deprecated.
+The next Option created will have a value that will be an instance
+ of
+type. |
+
static OptionBuilder |
+OptionBuilder.withType(Object newType)
+Deprecated.
+
+since 1.3, use
+withType(Class) instead |
+
static OptionBuilder |
+OptionBuilder.withValueSeparator()
+Deprecated.
+The next Option created uses '
+=' as a means to
+ separate argument values. |
+
static OptionBuilder |
+OptionBuilder.withValueSeparator(char sep)
+Deprecated.
+The next Option created uses
+sep as a means to
+ separate argument values. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/OptionGroup.html b/apidocs/org/apache/commons/clipatched/class-use/OptionGroup.html new file mode 100644 index 0000000..06d6d25 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/OptionGroup.html @@ -0,0 +1,212 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
OptionGroup |
+OptionGroup.addOption(Option option)
+Add the specified
+Option to this group. |
+
OptionGroup |
+AlreadySelectedException.getOptionGroup()
+Returns the option group where another option has been selected.
+ |
+
OptionGroup |
+Options.getOptionGroup(Option opt)
+Returns the OptionGroup the
+opt belongs to. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Options |
+Options.addOptionGroup(OptionGroup group)
+Add the specified option group.
+ |
+
| Constructor and Description | +
|---|
AlreadySelectedException(OptionGroup group,
+ Option option)
+Construct a new
+AlreadySelectedException
+ for the specified option group. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/Options.html b/apidocs/org/apache/commons/clipatched/class-use/Options.html new file mode 100644 index 0000000..3da969b --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/Options.html @@ -0,0 +1,499 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected Options |
+DefaultParser.options
+The current options.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Options |
+Options.addOption(Option opt)
+Adds an option instance
+ |
+
Options |
+Options.addOption(String opt,
+ boolean hasArg,
+ String description)
+Add an option that only contains a short-name.
+ |
+
Options |
+Options.addOption(String opt,
+ String description)
+Add an option that only contains a short name.
+ |
+
Options |
+Options.addOption(String opt,
+ String longOpt,
+ boolean hasArg,
+ String description)
+Add an option that contains a short-name and a long-name.
+ |
+
Options |
+Options.addOptionGroup(OptionGroup group)
+Add the specified option group.
+ |
+
Options |
+Options.addRequiredOption(String opt,
+ String longOpt,
+ boolean hasArg,
+ String description)
+Add an option that contains a short-name and a long-name.
+ |
+
protected Options |
+Parser.getOptions()
+Deprecated.
+ |
+
static Options |
+PatternOptionBuilder.parsePattern(String pattern)
+Returns the
+Options instance represented by pattern. |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected String[] |
+BasicParser.flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
protected String[] |
+PosixParser.flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
protected String[] |
+GnuParser.flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
protected abstract String[] |
+Parser.flatten(Options opts,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Subclasses must implement this method to reduce
+ the
+arguments that have been passed to the parse method. |
+
CommandLine |
+CommandLineParser.parse(Options options,
+ String[] arguments)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments) |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments)
+Deprecated.
+Parses the specified
+arguments based
+ on the specified Options. |
+
CommandLine |
+CommandLineParser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption) |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Parses the specified
+arguments
+ based on the specified Options. |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ Properties properties)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ Properties properties)
+Deprecated.
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Deprecated.
+Parse the arguments according to the specified options and
+ properties.
+ |
+
void |
+HelpFormatter.printHelp(int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(PrintWriter pw,
+ int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ int leftPad,
+ int descPad,
+ String footer)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(PrintWriter pw,
+ int width,
+ String cmdLineSyntax,
+ String header,
+ Options options,
+ int leftPad,
+ int descPad,
+ String footer,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(String cmdLineSyntax,
+ Options options)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(String cmdLineSyntax,
+ Options options,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printHelp(String cmdLineSyntax,
+ String header,
+ Options options,
+ String footer,
+ boolean autoUsage)
+Print the help for
+options with the specified
+ command line syntax. |
+
void |
+HelpFormatter.printOptions(PrintWriter pw,
+ int width,
+ Options options,
+ int leftPad,
+ int descPad)
+Print the help for the specified Options to the specified writer,
+ using the specified width, left padding and description padding.
+ |
+
void |
+HelpFormatter.printUsage(PrintWriter pw,
+ int width,
+ String app,
+ Options options)
+Prints the usage statement for the specified application.
+ |
+
protected StringBuffer |
+HelpFormatter.renderOptions(StringBuffer sb,
+ int width,
+ Options options,
+ int leftPad,
+ int descPad)
+Render the specified Options and return the rendered Options
+ in a StringBuffer.
+ |
+
protected void |
+Parser.setOptions(Options options)
+Deprecated.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/ParseException.html b/apidocs/org/apache/commons/clipatched/class-use/ParseException.html new file mode 100644 index 0000000..add8e17 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/ParseException.html @@ -0,0 +1,387 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AlreadySelectedException
+Thrown when more than one option in an option group
+ has been provided.
+ |
+
class |
+AmbiguousOptionException
+Exception thrown when an option can't be identified from a partial name.
+ |
+
class |
+MissingArgumentException
+Thrown when an option requiring an argument
+ is not provided with an argument.
+ |
+
class |
+MissingOptionException
+Thrown when a required option has not been provided.
+ |
+
class |
+UnrecognizedOptionException
+Exception thrown during parsing signalling an unrecognized
+ option was seen.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Class<?> |
+TypeHandler.createClass(String classname)
+Returns the class whose name is
+classname. |
+
static Number |
+TypeHandler.createNumber(String str)
+Create a number from a String.
+ |
+
static Object |
+TypeHandler.createObject(String classname)
+Create an Object from the classname and empty constructor.
+ |
+
static URL |
+TypeHandler.createURL(String str)
+Returns the URL represented by
+str. |
+
static Object |
+TypeHandler.createValue(String str,
+ Class<?> clazz)
+Returns the
+Object of type clazz
+ with the value of str. |
+
static Object |
+TypeHandler.createValue(String str,
+ Object obj)
+Returns the
+Object of type obj
+ with the value of str. |
+
protected String[] |
+PosixParser.flatten(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+
+ |
+
protected abstract String[] |
+Parser.flatten(Options opts,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Subclasses must implement this method to reduce
+ the
+arguments that have been passed to the parse method. |
+
Object |
+CommandLine.getParsedOptionValue(String opt)
+Return a version of this
+Option converted to a particular type. |
+
protected void |
+DefaultParser.handleConcatenatedOptions(String token)
+Breaks
+token into its constituent parts
+ using the following algorithm. |
+
CommandLine |
+CommandLineParser.parse(Options options,
+ String[] arguments)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments) |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments)
+Deprecated.
+Parses the specified
+arguments based
+ on the specified Options. |
+
CommandLine |
+CommandLineParser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption) |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ boolean stopAtNonOption)
+Deprecated.
+Parses the specified
+arguments
+ based on the specified Options. |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ Properties properties)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ Properties properties)
+Deprecated.
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+DefaultParser.parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Parse the arguments according to the specified options and properties.
+ |
+
CommandLine |
+Parser.parse(Options options,
+ String[] arguments,
+ Properties properties,
+ boolean stopAtNonOption)
+Deprecated.
+Parse the arguments according to the specified options and
+ properties.
+ |
+
void |
+Parser.processArgs(Option opt,
+ ListIterator<String> iter)
+Deprecated.
+Process the argument values for the specified Option
+
+opt using the values retrieved from the
+ specified iterator iter. |
+
protected void |
+Parser.processOption(String arg,
+ ListIterator<String> iter)
+Deprecated.
+Process the Option specified by
+arg using the values
+ retrieved from the specified iterator iter. |
+
protected void |
+Parser.processProperties(Properties properties)
+Deprecated.
+Sets the values of Options using the values in
+properties. |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/Parser.html b/apidocs/org/apache/commons/clipatched/class-use/Parser.html new file mode 100644 index 0000000..6d13016 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/Parser.html @@ -0,0 +1,188 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BasicParser
+Deprecated.
+
+since 1.3, use the
+DefaultParser instead |
+
class |
+GnuParser
+Deprecated.
+
+since 1.3, use the
+DefaultParser instead |
+
class |
+PosixParser
+Deprecated.
+
+since 1.3, use the
+DefaultParser instead |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/PatternOptionBuilder.html b/apidocs/org/apache/commons/clipatched/class-use/PatternOptionBuilder.html new file mode 100644 index 0000000..3aa3945 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/PatternOptionBuilder.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/PosixParser.html b/apidocs/org/apache/commons/clipatched/class-use/PosixParser.html new file mode 100644 index 0000000..bb2e9ac --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/PosixParser.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/TypeHandler.html b/apidocs/org/apache/commons/clipatched/class-use/TypeHandler.html new file mode 100644 index 0000000..0d6734a --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/TypeHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/class-use/UnrecognizedOptionException.html b/apidocs/org/apache/commons/clipatched/class-use/UnrecognizedOptionException.html new file mode 100644 index 0000000..96b753c --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/class-use/UnrecognizedOptionException.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AmbiguousOptionException
+Exception thrown when an option can't be identified from a partial name.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/package-frame.html b/apidocs/org/apache/commons/clipatched/package-frame.html new file mode 100644 index 0000000..1e9273e --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/package-frame.html @@ -0,0 +1,47 @@ + + + + + + +| Interface | +Description | +
|---|---|
| CommandLineParser | +
+ A class that implements the
+CommandLineParser interface
+ can parse a String array according to the Options specified
+ and return a CommandLine. |
+
| Class | +Description | +
|---|---|
| BasicParser | +Deprecated
+ since 1.3, use the
+DefaultParser instead |
+
| CommandLine | +
+ Represents list of arguments parsed against a
+Options descriptor. |
+
| DefaultParser | +
+ Default parser.
+ |
+
| GnuParser | +Deprecated
+ since 1.3, use the
+DefaultParser instead |
+
| HelpFormatter | +
+ A formatter of help messages for command line options.
+ |
+
| Option | +
+ Describes a single command-line option.
+ |
+
| Option.Builder | +
+ A nested builder class to create
+Option instances
+ using descriptive methods. |
+
| OptionBuilder | +Deprecated
+ since 1.3, use
+Option.builder(String) instead |
+
| OptionGroup | +
+ A group of mutually exclusive options.
+ |
+
| Options | +
+ Main entry-point into the library.
+ |
+
| Parser | +Deprecated
+ since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases
+ |
+
| PatternOptionBuilder | +
+ Allows Options to be created from a single String.
+ |
+
| PosixParser | +Deprecated
+ since 1.3, use the
+DefaultParser instead |
+
| TypeHandler | +
+ This is a temporary implementation.
+ |
+
| Exception | +Description | +
|---|---|
| AlreadySelectedException | +
+ Thrown when more than one option in an option group
+ has been provided.
+ |
+
| AmbiguousOptionException | +
+ Exception thrown when an option can't be identified from a partial name.
+ |
+
| MissingArgumentException | +
+ Thrown when an option requiring an argument
+ is not provided with an argument.
+ |
+
| MissingOptionException | +
+ Thrown when a required option has not been provided.
+ |
+
| ParseException | +
+ Base for Exceptions thrown during parsing of a command-line.
+ |
+
| UnrecognizedOptionException | +
+ Exception thrown during parsing signalling an unrecognized
+ option was seen.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/package-tree.html b/apidocs/org/apache/commons/clipatched/package-tree.html new file mode 100644 index 0000000..ea6670f --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/package-tree.html @@ -0,0 +1,179 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/org/apache/commons/clipatched/package-use.html b/apidocs/org/apache/commons/clipatched/package-use.html new file mode 100644 index 0000000..f9210c3 --- /dev/null +++ b/apidocs/org/apache/commons/clipatched/package-use.html @@ -0,0 +1,227 @@ + + + + + + +| Package | +Description | +
|---|---|
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
| Class and Description | +
|---|
| AlreadySelectedException
+ Thrown when more than one option in an option group
+ has been provided.
+ |
+
| CommandLine
+ Represents list of arguments parsed against a
+Options descriptor. |
+
| CommandLineParser
+ A class that implements the
+CommandLineParser interface
+ can parse a String array according to the Options specified
+ and return a CommandLine. |
+
| MissingOptionException
+ Thrown when a required option has not been provided.
+ |
+
| Option
+ Describes a single command-line option.
+ |
+
| Option.Builder
+ A nested builder class to create
+Option instances
+ using descriptive methods. |
+
| OptionBuilder
+ Deprecated.
+
+since 1.3, use
+Option.builder(String) instead |
+
| OptionGroup
+ A group of mutually exclusive options.
+ |
+
| Options
+ Main entry-point into the library.
+ |
+
| ParseException
+ Base for Exceptions thrown during parsing of a command-line.
+ |
+
| Parser
+ Deprecated.
+
+since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases
+ |
+
| UnrecognizedOptionException
+ Exception thrown during parsing signalling an unrecognized
+ option was seen.
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/overview-frame.html b/apidocs/overview-frame.html new file mode 100644 index 0000000..f70d068 --- /dev/null +++ b/apidocs/overview-frame.html @@ -0,0 +1,34 @@ + + + + + + ++ + diff --git a/apidocs/overview-summary.html b/apidocs/overview-summary.html new file mode 100644 index 0000000..9e0a52a --- /dev/null +++ b/apidocs/overview-summary.html @@ -0,0 +1,190 @@ + + + + + + +
| Package | +Description | +
|---|---|
| gate.lib.interaction.data | ++ |
| gate.lib.interaction.process | ++ |
| gate.plugin.learningframework | ++ |
| gate.plugin.learningframework.data | ++ |
| gate.plugin.learningframework.engines | ++ |
| gate.plugin.learningframework.export | ++ |
| gate.plugin.learningframework.features | ++ |
| gate.plugin.learningframework.mallet | ++ |
| gate.plugin.learningframework.mbstats | ++ |
| gate.plugin.learningframework.pipelines | ++ |
| gate.plugin.learningframework.stats | ++ |
| gate.resources.img.svg | ++ |
| org.apache.commons.clipatched | +
+ Commons CLI 1.3
+ |
+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/overview-tree.html b/apidocs/overview-tree.html new file mode 100644 index 0000000..19ac59f --- /dev/null +++ b/apidocs/overview-tree.html @@ -0,0 +1,453 @@ + + + + + + +Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/package-list b/apidocs/package-list new file mode 100644 index 0000000..6d5f224 --- /dev/null +++ b/apidocs/package-list @@ -0,0 +1,13 @@ +gate.lib.interaction.data +gate.lib.interaction.process +gate.plugin.learningframework +gate.plugin.learningframework.data +gate.plugin.learningframework.engines +gate.plugin.learningframework.export +gate.plugin.learningframework.features +gate.plugin.learningframework.mallet +gate.plugin.learningframework.mbstats +gate.plugin.learningframework.pipelines +gate.plugin.learningframework.stats +gate.resources.img.svg +org.apache.commons.clipatched diff --git a/apidocs/script.js b/apidocs/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/apidocs/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/apidocs/serialized-form.html b/apidocs/serialized-form.html new file mode 100644 index 0000000..bad8278 --- /dev/null +++ b/apidocs/serialized-form.html @@ -0,0 +1,1762 @@ + + + + + + +int[] indices+
double[] values+
double instanceWeight+
org.apache.log4j.Logger LOGGER+
AtomicInteger seenDocuments+
AtomicInteger seenDocumentsThisDuplicate+
gate.Controller controller+
AtomicInteger nDuplicates+
AtomicInteger remainingDuplicates+
Throwable lastError+
ConcurrentHashMap<K,V> sharedData+
Object syncObject+
int duplicateId+
String benchmarkId+
URL dataDirectory+
String outputASName+
Double confidenceThreshold+
String sequenceSpan+
URL dataDir+
URL dataDirectory+
URL oldDataDirectory+
String outputASName+
Double confidenceThreshold+
String targetFeature+
String sequenceSpan+
String serverUrl+
String targetFeatureToUse+
org.apache.log4j.Logger logger+
URL featureSpecURL+
AlgorithmClassification trainingAlgorithm+
ScalingMethod scaleFeatures+
String targetFeature+
String sequenceSpan+
EvaluationMethod evaluationMethod+
int numberOfFolds+
double trainingFraction+
int numberOfRepeats+
String classAnnotationType+
String instanceWeightFeature+
URL dataDirURL+
org.apache.log4j.Logger logger+
URL featureSpecURL+
AlgorithmRegression trainingAlgorithm+
ScalingMethod scaleFeatures+
String targetFeature+
CorpusRepresentation corpusRepresentation+
FeatureSpecification featureSpec+
Engine engine+
String sequenceSpan+
EvaluationMethod evaluationMethod+
int numberOfFolds+
double trainingFraction+
int numberOfRepeats+
String instanceWeightFeature+
URL dataDirURL+
org.apache.log4j.Logger logger+
URL dataDirectory+
String instanceWeightFeature+
URL featureSpecURL+
ScalingMethod scaleFeatures+
String targetFeature+
List<E> classAnnotationTypes+
Set<E> classAnnotationTypesSet+
TargetType targetType+
CorpusRepresentation corpusRepresentation+
FeatureSpecification featureSpec+
String sequenceSpan+
Exporter exporter+
SeqEncoderEnum seqEncoderEnum+
SeqEncoder seqEncoder+
boolean haveSequenceProblem+
boolean haveSequenceAlg+
boolean haveClusteringProblem+
boolean haveClusteringAlg+
CorpusExporter corpusExporter+
URL dataDirectory+
String inputASName+
String containingAnnotation+
String tokenAnnotation+
Boolean includeDocumentId+
String tokenFeature+
String targetFeature+
int ndocs+
int nwritten+
ExporterText exporter+
org.apache.log4j.Logger logger+
Boolean genPrefixes+
String prefixFeatureName+
Integer minPrefixLength+
Integer maxPrefixLength+
Integer minNonPrefixLength+
Boolean genSuffixes+
String suffixFeatureName+
Integer minSuffixLength+
Integer maxSuffixLength+
Integer minNonSuffixLength+
String inputASName+
String instanceType+
String stringFeature+
Boolean mapToUpper+
String mappingLanguage+
Locale mappingLocale+
org.apache.log4j.Logger LOGGER+
URL dataDirectory+
URL featureSpecURL+
AlgorithmClassification trainingAlgorithm+
SeqEncoderEnum seqEncoderEnum+
SeqEncoder seqEncoder+
ScalingMethod scaleFeatures+
String sequenceSpan+
List<E> classAnnotationTypes+
Set<E> classAnnotationTypesSet+
boolean haveSequenceTagger+
FeatureSpecification featureSpec+
File dataDirFile+
Engine engine+
CorpusRepresentation corpusRepresentation+
org.apache.log4j.Logger logger+
URL dataDirectory+
String instanceWeightFeature+
URL featureSpecURL+
AlgorithmClassification trainingAlgorithm+
ScalingMethod scaleFeatures+
String targetFeature+
CorpusRepresentation corpusRepresentation+
FeatureSpecification featureSpec+
Engine engine+
String sequenceSpan+
File dataDirFile+
org.apache.log4j.Logger logger+
URL dataDirectory+
String instanceWeightFeature+
URL featureSpecURL+
AlgorithmRegression trainingAlgorithm+
ScalingMethod scaleFeatures+
String targetFeature+
CorpusRepresentation corpusRepresentation+
FeatureSpecification featureSpec+
Engine engine+
File dataDirFile+
URL dataDirectory+
String tokenAnnotationType+
String tokenFeature+
AlgorithmClustering trainingAlgorithm+
boolean applyAfterTraining+
String featurePrefix+
File dataDirFile+
boolean growthStopped+
List<E> featureSpecs+
ScalingMethod globalScalingMethod+
String annType+
String feature+
String name+
int featureId+
String missingValueValue+
Datatype datatype+
String listsep+
String featureCode+
String emb_file+
String emb_id+
Integer emb_dims+
String emb_train+
Integer emb_minfreq+
int from+
int to+
int number+
String featureName4Value+
CodeAs codeas+
MissingValueTreatment missingValueTreatment+
LFAlphabet alphabet+
String withinType+
String featureName4Value+
FeatureInfo featureInfo+
double[] means+
double[] variances+
boolean[] normalize+
double[] min+
double[] max+
boolean[] normalize+
OptionGroup group+
Option option+
Collection<E> matchingOptions+
Option option+
String opt+
String longOpt+
String argName+
String description+
boolean required+
boolean optionalArg+
int numberOfArgs+
Class<T> type+
List<E> values+
char valuesep+
String option+
Copyright © 2019 GATE Team. All rights reserved.
+ + diff --git a/apidocs/stylesheet.css b/apidocs/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/apidocs/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 0000000..e73a788 --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,29 @@ +--- +--- + +@import "{{ site.theme }}"; + +.page-header { + color: $header-heading-color; + text-align: center; + background-color: $header-bg-color; + background-image: linear-gradient(120deg, $header-bg-color-secondary, $header-bg-color); + a:visited { + color: white !important; + } + a { + color: white !important; + } + + @include large { + padding: 2rem 3rem; + } + + @include medium { + padding: 2rem 3rem; + } + + @include small { + padding: 1rem 1rem; + } +} diff --git a/bin/changeAlgoNames.sh b/bin/changeAlgoNames.sh deleted file mode 100755 index 1e1b30e..0000000 --- a/bin/changeAlgoNames.sh +++ /dev/null @@ -1,48 +0,0 @@ -#!/bin/bash - -file="$1" -if [[ "x$file" == "x" ]] -then - echo 'need filename' - exit 1 -fi - -sed -i.bak ' -s/PYTORCH_CL_WRAPPER_DENSE/PytorchWrapper_CL_DR/g -s/PYTORCH_SEQ_WRAPPER_DENSE/PytorchWrapper_SEQ_DR/g -s/KERAS_CL_WRAPPER_DENSE/KerasWrapper_CL_DR/g -s/KERAS_SEQ_WRAPPER_DENSE/KerasWrapper_SEQ_DR/g -s/MALLET_CL_BALANCED_WINNOW/MalletBalancedWinnow_CL_MR/g -s/MALLET_CL_C45/MalletC45_CL_MR/g -s/MALLET_CL_DECISION_TREE/MalletDecisionTree_CL_MR/g -s/MALLET_CL_MAX_ENT/MalletMaxEnt_CL_MR/g -s/MALLET_CL_NAIVE_BAYES_EM/MalletNaiveBayesEM_CL_MR/g -s/MALLET_CL_NAIVE_BAYES/MalletNaiveBayes_CL_MR/g -s/MALLET_CL_WINNOW/MalletWinnow_CL_MR/g -s/MALLET_SEQ_CRF_SG/MalletCRFSG_SEQ_MR/g -s/MALLET_SEQ_CRF_VG/MalletCRFVG_SEQ_MR/g -s/MALLET_SEQ_CRF/MalletCRF_SEQ_MR/g -s/COSTCLA_CL_WRAPPER/CostclaWrapper_CL_MR/g -s/MALLET_SEQ_MEMM/MalletMEMM_SEQ_MR/g -s/WEKA_CL_WRAPPER/WekaWrapper_CL_MR/g -s/SKLEARN_CL_WRAPPER/SklearnWrapper_CL_MR/g -s/KERAS_CL_WRAPPER/KerasWrapper_CL_MR/g -s/LIBSVM_RG/LibSVM_RG_MR/g -s/WEKA_RG_WRAPPER/WekaWrapper_RG_MR/g -s/PYTORCH_RG_WRAPPER_Dense/PytorchWrapper_RG_DR/g -s/SKLEARN_RG_WRAPPER/SklearnWrapper_RG_MR/g -s/KERAS_RG_WRAPPER/WekaWrapper_RG_MR/g -s/EXPORTER_ARFF_CLASS/ARFF_CL_MR/g -s/EXPORTER_ARFF_REGRESSION/ARFF_RG_MR/g -s/EXPORTER_CSV_CLASS/CSV_CL_MR/g -s/EXPORTER_CSV_REGRESSION/CSV_RG_MR/g -s/EXPORTER_JSON_SEQ/JSON_CL_MR/g -s/EXPORTER_JSON_REGRESSION/JSON_RG_MR/g -s/EXPORTER_JSON_CLASS/JSON_SEQ_MR/g -s/EXPORTER_LIBSVM_CLASS/LibSVM_CL_MR/g -s/EXPORTER_LIBSVM_REGRESSION/LibSVM_RG_MR/g -s/EXPORTER_MATRIXMARKET2_CLASS/MatrixMarket2_CL_MR/g -s/EXPORTER_MATRIXMARKET2_REGRESSION/MatrixMatket2_RG_MR/g -s/LIBSVM_CL/LibSVM_CL_MR/g -s/learningframework.Exporter/learningframework.export.Exporter/g -' $file diff --git a/bin/upgrade-pipelines-3_0-4_0.sh b/bin/upgrade-pipelines-3_0-4_0.sh deleted file mode 100755 index df52e6f..0000000 --- a/bin/upgrade-pipelines-3_0-4_0.sh +++ /dev/null @@ -1,51 +0,0 @@ -#!/bin/bash - -dir="$1" -if [[ "x$dir" == "x" ]] -then - dir="." -fi - -find "$dir" -name '*.gapp' -o -name '*.xgapp' | while read f -do - echo "Updating file $f" - sed -i.bak ' -s/PYTORCH_CL_WRAPPER_DENSE/PytorchWrapper_CL_DR/g -s/PYTORCH_SEQ_WRAPPER_DENSE/PytorchWrapper_SEQ_DR/g -s/KERAS_CL_WRAPPER_DENSE/KerasWrapper_CL_DR/g -s/KERAS_SEQ_WRAPPER_DENSE/KerasWrapper_SEQ_DR/g -s/MALLET_CL_BALANCED_WINNOW/MalletBalancedWinnow_CL_MR/g -s/MALLET_CL_C45/MalletC45_CL_MR/g -s/MALLET_CL_DECISION_TREE/MalletDecisionTree_CL_MR/g -s/MALLET_CL_MAX_ENT/MalletMexEnt_CL_MR/g -s/MALLET_CL_NAIVE_BAYES_EM/MalletNaiveBayesEM_CL_MR/g -s/MALLET_CL_NAIVE_BAYES/MalletNaiveBayes_CL_MR/g -s/MALLET_CL_WINNOW/MalletWinnow_CL_MR/g -s/MALLET_SEQ_CRF_SG/MalletCRFSG_SEQ_MR/g -s/MALLET_SEQ_CRF_VG/MalletCRFVG_SEQ_MR/g -s/MALLET_SEQ_CRF/MalletCRF_SEQ_MR/g -s/COSTCLA_CL_WRAPPER/CostclaWrapper_CL_MR/g -s/MALLET_SEQ_MEMM/MalletMEMM_SEQ_MR/g -s/WEKA_CL_WRAPPER/WekaWrapper_CL_MR/g -s/SKLEARN_CL_WRAPPER/SklearnWrapper_CL_MR/g -s/KERAS_CL_WRAPPER/KerasWrapper_CL_MR/g -s/LIBSVM_RG/LibSVM_RG_MR/g -s/WEKA_RG_WRAPPER/WekaWrapper_RG_MR/g -s/PYTORCH_RG_WRAPPER_Dense/PytorchWrapper_RG_DR/g -s/SKLEARN_RG_WRAPPER/SklearnWrapper_RG_MR/g -s/KERAS_RG_WRAPPER/WekaWrapper_RG_MR/g -s/EXPORTER_ARFF_CLASS/ARFF_CL_MR/g -s/EXPORTER_ARFF_REGRESSION/ARFF_RG_MR/g -s/EXPORTER_CSV_CLASS/CSV_CL_MR/g -s/EXPORTER_CSV_REGRESSION/CSV_RG_MR/g -s/EXPORTER_JSON_SEQ/JSON_CL_MR/g -s/EXPORTER_JSON_REGRESSION/JSON_RG_MR/g -s/EXPORTER_JSON_CLASS/JSON_SEQ_MR/g -s/EXPORTER_LIBSVM_CLASS/LibSVM_CL_MR/g -s/EXPORTER_LIBSVM_REGRESSION/LibSVM_RG_MR/g -s/EXPORTER_MATRIXMARKET2_CLASS/MatrixMarket2_CL_MR/g -s/EXPORTER_MATRIXMARKET2_REGRESSION/MatrixMatket2_RG_MR/g -s/LIBSVM_CL/LibSVM_CL_MR/g -s/learningframework.Exporter/learningframework.export.Exporter/g -' $f -done diff --git a/bin/upgrade-pipelines-3_0-4_1.sh b/bin/upgrade-pipelines-3_0-4_1.sh deleted file mode 100755 index c7974bf..0000000 --- a/bin/upgrade-pipelines-3_0-4_1.sh +++ /dev/null @@ -1,51 +0,0 @@ -#!/bin/bash - -dir="$1" -if [[ "x$dir" == "x" ]] -then - dir="." -fi - -find "$dir" -name '*.gapp' -o -name '*.xgapp' | while read f -do - echo "Updating file $f" - sed -i.bak ' -s/PYTORCH_CL_WRAPPER_DENSE/PytorchWrapper_CL_DR/g -s/PYTORCH_SEQ_WRAPPER_DENSE/PytorchWrapper_SEQ_DR/g -s/KERAS_CL_WRAPPER_DENSE/KerasWrapper_CL_DR/g -s/KERAS_SEQ_WRAPPER_DENSE/KerasWrapper_SEQ_DR/g -s/MALLET_CL_BALANCED_WINNOW/MalletBalancedWinnow_CL_MR/g -s/MALLET_CL_C45/MalletC45_CL_MR/g -s/MALLET_CL_DECISION_TREE/MalletDecisionTree_CL_MR/g -s/MALLET_CL_MAX_ENT/MalletMaxEnt_CL_MR/g -s/MALLET_CL_NAIVE_BAYES_EM/MalletNaiveBayesEM_CL_MR/g -s/MALLET_CL_NAIVE_BAYES/MalletNaiveBayes_CL_MR/g -s/MALLET_CL_WINNOW/MalletWinnow_CL_MR/g -s/MALLET_SEQ_CRF_SG/MalletCRFSG_SEQ_MR/g -s/MALLET_SEQ_CRF_VG/MalletCRFVG_SEQ_MR/g -s/MALLET_SEQ_CRF/MalletCRF_SEQ_MR/g -s/COSTCLA_CL_WRAPPER/CostclaWrapper_CL_MR/g -s/MALLET_SEQ_MEMM/MalletMEMM_SEQ_MR/g -s/WEKA_CL_WRAPPER/WekaWrapper_CL_MR/g -s/SKLEARN_CL_WRAPPER/SklearnWrapper_CL_MR/g -s/KERAS_CL_WRAPPER/KerasWrapper_CL_MR/g -s/LIBSVM_RG/LibSVM_RG_MR/g -s/WEKA_RG_WRAPPER/WekaWrapper_RG_MR/g -s/PYTORCH_RG_WRAPPER_Dense/PytorchWrapper_RG_DR/g -s/SKLEARN_RG_WRAPPER/SklearnWrapper_RG_MR/g -s/KERAS_RG_WRAPPER/WekaWrapper_RG_MR/g -s/EXPORTER_ARFF_CLASS/ARFF_CL_MR/g -s/EXPORTER_ARFF_REGRESSION/ARFF_RG_MR/g -s/EXPORTER_CSV_CLASS/CSV_CL_MR/g -s/EXPORTER_CSV_REGRESSION/CSV_RG_MR/g -s/EXPORTER_JSON_SEQ/JSON_CL_MR/g -s/EXPORTER_JSON_REGRESSION/JSON_RG_MR/g -s/EXPORTER_JSON_CLASS/JSON_SEQ_MR/g -s/EXPORTER_LIBSVM_CLASS/LibSVM_CL_MR/g -s/EXPORTER_LIBSVM_REGRESSION/LibSVM_RG_MR/g -s/EXPORTER_MATRIXMARKET2_CLASS/MatrixMarket2_CL_MR/g -s/EXPORTER_MATRIXMARKET2_REGRESSION/MatrixMatket2_RG_MR/g -s/LIBSVM_CL/LibSVM_CL_MR/g -s/learningframework.Exporter/learningframework.export.Exporter/g -' $f -done diff --git a/blog/index.html b/blog/index.html new file mode 100644 index 0000000..1a0929e --- /dev/null +++ b/blog/index.html @@ -0,0 +1,27 @@ +--- +layout: default +title: Blog +--- + +{% if site.posts.size > 0 %} +{{ post.title }} ({{ post.date | date_to_string }}) +{% if post.description %} +{{ post.description }} +{% endif %} +{% endfor %} +{% if paginator.total_pages > 1 %} +
+Navigation: +{% if paginator.previous_page %} +[<-- Older Posts] +{% endif %} +{% if paginator.next_page %} +[Newer Posts -->] +{% endif %} +{% endif %} +{% else %} +
- * Note: if the dirURL contains a query and/or a fragment, those parts are
- * lost in the resulting URL.
- * @param dirURL directory URL
- * @param fileName file name
- * @return the URL
- */
- public static URL newURL(URL dirURL, String fileName) {
- URI dirURI;
- try {
- dirURI = dirURL.toURI();
- } catch (URISyntaxException ex) {
- throw new GateRuntimeException("Cannot convert URL to URI: "+dirURL);
- }
- // NOTE: adding the slash should not really be necessary if we really
- // always get a URL with a trailing slash if the URL refers to something
- // that should be a directory. However, this is not always the case,
- // e.g. a directory URL stored in a xgapp file can sometimes miss the
- // trailing slash.
- // /*
- String path = dirURI.getPath();
- if(!path.endsWith("/")) {
- path += "/";
- }
- try {
- dirURI = new URI(
- dirURI.getScheme(),
- dirURI.getUserInfo(),
- dirURI.getHost(),
- dirURI.getPort(),
- path,
- dirURI.getQuery(),
- dirURI.getFragment());
- } catch (URISyntaxException ex) {
- throw new GateRuntimeException("Cannot conver URL to URI: "+dirURL);
- }
- // */
- try {
- URL ret = new URL(dirURI.toURL(),fileName);
- return ret;
- } catch (MalformedURLException ex) {
- throw new GateRuntimeException("Could not create URL for "+dirURL+"fileName");
- }
- }
-
- /**
- * Return the last path component of a hierarchical path of URL.
- * @param url the URL
- * @return the string representation of the last path component
- */
- public static String getName(URL url) {
- URI uri;
- try {
- uri = url.toURI();
- } catch (URISyntaxException ex) {
- throw new GateRuntimeException("Cannot convert URL to URI: "+url);
- }
- URL parentURL;
- try {
- parentURL = new URL(url,".");
- } catch (MalformedURLException ex) {
- throw new GateRuntimeException("Cannot find parent URL for URL "+url);
- }
- URI parentURI = null;
- try {
- parentURI = parentURL.toURI();
- } catch (URISyntaxException ex) {
- throw new GateRuntimeException("Cannot convert URL to URI: "+parentURL);
- }
- URI relative = parentURI.relativize(uri);
- return relative.toString();
- }
-
- /**
- * Return the parent path for a URL.
- * This is the path, with the last component of the path removed, i.e.
- * with that part removed that is returned by the getName() method.
- *
- * @param url the url
- * @return parent path url
- */
- public static URL getParentURL(URL url) {
- URL ret;
- try {
- ret = new URL(url,".");
- } catch (MalformedURLException ex) {
- throw new GateRuntimeException("Cannot convert URL to URI: "+url);
- }
- return ret;
- }
-
- /**
- * Return the parent path for a URL.
- * This is the path, with the last component of the path removed, i.e.
- * with that part removed that is returned by the getName() method.
- *
- * @param url the url
- * @return the parent path
- */
- public static String getParent(URL url) {
- return getParentURL(url).toString();
- }
-
- /**
- * Returns true if the URL can be opened for reading.
- *
- * @param url the url
- * @return true if can be opened
- */
- public static boolean exists(URL url) {
- boolean ret = true;
- try (InputStream is = url.openStream()) {
- is.read();
- // do nothing, we only want to check the opening and readability
- } catch (IOException ex) {
- ret = false;
- }
- return ret;
- }
-
- /**
- * Return truen if the URL is a file URL.
- * @param url the url
- * @return true if a file
- */
- public static boolean isFile(URL url) {
- return "file".equals(url.getProtocol());
- }
-
-
-
-
-
- /**
- * Return URL for the file inside the dir URL.
- * This makes sure that the dirURL ends with a slash before creating the final URL,
- * since the constructor new URL(url1, "file") will remove the last part of the
- * path of url1 if it does not end in a slash.
- * @param dirURL URL
- * @param fileName filename
- * @return url
- */
- public static URL newURLOld(URL dirURL, String fileName) {
- String s = dirURL.toExternalForm();
- if(!s.endsWith("/")) {
- try {
- dirURL = new URL(s+"/");
- } catch (MalformedURLException ex) {
- throw new GateRuntimeException("Could not create URL for "+s+"/",ex);
- }
- }
- try {
- URL ret = new URL(dirURL,fileName);
- return ret;
- } catch (MalformedURLException ex) {
- throw new GateRuntimeException("Could not create URL for "+dirURL+"fileName");
- }
- }
-
-}
diff --git a/src/main/java/gate/plugin/learningframework/LF_ApplyChunking.java b/src/main/java/gate/plugin/learningframework/LF_ApplyChunking.java
deleted file mode 100644
index 454d617..0000000
--- a/src/main/java/gate/plugin/learningframework/LF_ApplyChunking.java
+++ /dev/null
@@ -1,200 +0,0 @@
-/*
- * Copyright (c) 2015-2016 The University Of Sheffield.
- *
- * This file is part of gateplugin-LearningFramework
- * (see https://github.com/GateNLP/gateplugin-LearningFramework).
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 2.1 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this software. If not, see
- * Training, evaluation and application of ML in GATE.
- */ -@CreoleResource(name = "LF_ApplyChunking", - helpURL = "https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyChunking", - comment = "Apply a trained chunking model to documents") -public class LF_ApplyChunking extends LearningFrameworkPRBase { - - - static final Logger LOGGER = Logger.getLogger(LF_ApplyClassification.class.getCanonicalName()); - private static final long serialVersionUID = -5955373184542660323L; - - protected URL dataDirectory = null; - - @RunTime - @CreoleParameter(comment = "The directory where all data will be stored and read from") - public void setDataDirectory(URL output) { - dataDirectory = output; - } - - public URL getDataDirectory() { - return this.dataDirectory; - } - - - - protected String outputASName; - - @RunTime - @Optional - @CreoleParameter(defaultValue = "LearningFramework") - public void setOutputASName(String oasn) { - this.outputASName = oasn; - } - - public String getOutputASName() { - return this.outputASName; - } - - /** - * The confidence threshold for applying an annotation. In the case of NER, the confidence - * threshold is applied to the average for the entire entity. - * - */ - private Double confidenceThreshold; - - @RunTime - @Optional - @CreoleParameter(comment = "The minimum " - + "confidence/probability for including " - + "an annotation at application time. In the case of NER, the confidence " - + "threshold is applied to the average for the entire entity. If empty, ignore.") - public void setConfidenceThreshold(Double confidenceThreshold) { - this.confidenceThreshold = confidenceThreshold; - } - - public Double getConfidenceThreshold() { - return this.confidenceThreshold; - } - - - protected String sequenceSpan; - - @RunTime - @Optional - @CreoleParameter(comment = "For sequence learners, an annotation type " - + "defining a meaningful sequence span. Ignored by non-sequence " - + "learners. Needs to be in the input AS.") - public void setSequenceSpan(String seq) { - sequenceSpan = seq; - } - - public String getSequenceSpan() { - return sequenceSpan; - } - - private transient SeqEncoder seqEncoder = null; - - -//////////////////////////////////////////////////////////////////////////// - - private transient Engine engine = null; - - @Override - public void process(Document doc) { - if(isInterrupted()) { - interrupted = false; - throw new GateRuntimeException("Execution was requested to be interrupted"); - } - // extract the required annotation sets, - AnnotationSet inputAS = doc.getAnnotations(getInputASName()); - AnnotationSet instanceAS = inputAS.get(getInstanceType()); - // the classAS must be null for classification - // the sequenceAS must be specified for a sequence tagging algorithm and most not be specified - // for a non-sequence tagging algorithm! - AnnotationSet sequenceAS = null; - if(engine.getAlgorithm().getAlgorithmKind()==AlgorithmKind.SEQUENCE_TAGGER) { - // NOTE: we already have checked earlier, that in that case, the sequenceSpan parameter is - // given! - sequenceAS = inputAS.get(getSequenceSpan()); - } - //System.err.println("instanceAS.size="+instanceAS.size()+", inputAS.size="+inputAS.size()+"sequenceAS.size="+ - // sequenceAS.size()); - List- * Training, evaluation and application of ML in GATE.
- */ -@CreoleResource(name = "LF_ApplyClassification", - helpURL = "https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyClassification", - comment = "Apply a trained classification model to documents") -public class LF_ApplyClassification extends LearningFrameworkPRBase { - - static final Logger LOGGER = Logger.getLogger(LF_ApplyClassification.class.getCanonicalName()); - private static final long serialVersionUID = -754439854542759988L; - - protected URL dataDirectory; - protected URL oldDataDirectory; - - @RunTime - @CreoleParameter(comment = "The directory where all data will be stored and read from") - public void setDataDirectory(URL output) { - dataDirectory = output; - } - - public URL getDataDirectory() { - return this.dataDirectory; - } - - protected String outputASName; - - @RunTime - @Optional - @CreoleParameter(comment = "If identical to the input AS, existing annotations are updated", - defaultValue = "LearningFramework") - public void setOutputASName(String oasn) { - this.outputASName = oasn; - } - - public String getOutputASName() { - return this.outputASName; - } - - /** - * The confidence threshold for applying an annotation. In the case of NER, the confidence - * threshold is applied to the average for the entire entity. - * - */ - private Double confidenceThreshold; - - @RunTime - @Optional - @CreoleParameter(comment = "The minimum " - + "confidence/probability for including " - + "an annotation at application time. If empty, ignore.") - public void setConfidenceThreshold(Double confidenceThreshold) { - this.confidenceThreshold = confidenceThreshold; - } - - public Double getConfidenceThreshold() { - return this.confidenceThreshold; - } - - protected String targetFeature; - - @RunTime - @Optional - @CreoleParameter(comment = "Name of class feature to add to the original " - + "instance annotations. Default is the name that was used for training.", - defaultValue = "") - public void setTargetFeature(String name) { - targetFeature = name; - } - - public String getTargetFeature() { - return targetFeature; - } - - private String sequenceSpan; - - @RunTime - @Optional - @CreoleParameter(comment = "For sequence learners, an annotation type " - + "defining a meaningful sequence span. Ignored by non-sequence " - + "learners. ") - public void setSequenceSpan(String seq) { - sequenceSpan = seq; - } - - public String getSequenceSpan() { - return sequenceSpan; - } - - protected String serverUrl; - - @RunTime - @Optional - @CreoleParameter(comment = "Classify from a server instead of a stored model") - public void setServerUrl(String url) { - serverUrl = url; - } - - public String getServerUrl() { - return serverUrl; - } - -//////////////////////////////////////////////////////////////////////////// - private transient Engine engine; - - // this is either what the user specifies as the PR parameter, or what we have stored - // with the saved model. - private String targetFeatureToUse; - - @Override - public void process(Document doc) { - if (isInterrupted()) { - interrupted = false; - throw new GateRuntimeException("Execution was requested to be interrupted"); - } - // extract the required annotation sets, - AnnotationSet inputAS = doc.getAnnotations(getInputASName()); - AnnotationSet instanceAS = inputAS.get(getInstanceType()); - // the classAS must be null for classification - // the sequenceAS must be specified for a sequence tagging algorithm and most not be specified - // for a non-sequence tagging algorithm! - AnnotationSet sequenceAS = null; - if (engine.getAlgorithm().getAlgorithmKind() == AlgorithmKind.SEQUENCE_TAGGER) { - // NOTE: we already have checked earlier, that in that case, the sequenceSpan parameter is - // given! - sequenceAS = inputAS.get(getSequenceSpan()); - } - - //System.out.println("LF_ApplyClassification debug: instanceAS="+instanceAS.size()+", inputAS="+inputAS.size()+ - // ", sequenceAS="+sequenceAS); - //if(sequenceAS == null) { - // System.err.println("DEBUG: classifying doc "+doc.getName()+" instanceAS:"+instanceAS.size()+", inputAS:"+inputAS.size()); - //} else { - // System.err.println("DEBUG: classifying doc "+doc.getName()+" instanceAS:"+instanceAS.size()+", inputAS:"+inputAS.size()+", sequenceAS:"+sequenceAS.size()); - //} - List- * Training, evaluation and application of ML in GATE.
- */ -@CreoleResource(name = "LF_ApplyRegression", - helpURL = "https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyRegression", - comment = "Apply a trained regression model to documents") -public class LF_ApplyRegression extends LearningFrameworkPRBase { - - static final Logger LOGGER = Logger.getLogger(LF_ApplyRegression.class.getCanonicalName()); - private static final long serialVersionUID = 5851732674711579672L; - - protected URL dataDirectory; - - @RunTime - @CreoleParameter(comment = "The directory where all data will be stored and read from") - public void setDataDirectory(URL output) { - dataDirectory = output; - } - - public URL getDataDirectory() { - return this.dataDirectory; - } - - - - protected String outputASName; - - @RunTime - @Optional - @CreoleParameter(comment="If identical to the input AS, existing annotations are updated", - defaultValue = "LearningFramework") - public void setOutputASName(String oasn) { - this.outputASName = oasn; - } - - public String getOutputASName() { - return this.outputASName; - } - - - protected String targetFeature; - - @RunTime - @Optional - @CreoleParameter(comment = "Name of class feature to add to the original " - + "instance annotations", - defaultValue = "") - public void setTargetFeature(String name) { - targetFeature = name; - } - - public String getTargetFeature() { - return targetFeature; - } - - private String serverUrl; - - @RunTime - @Optional - @CreoleParameter(comment = "Classify from a server instead of a stored model") - public void setServerUrl(String url) { - serverUrl = url; - } - - public String getServerUrl() { - return serverUrl; - } - - -//////////////////////////////////////////////////////////////////////////// - - private transient Engine engine; - - // this is either what the user specifies as the PR parameter, or what we have stored - // with the saved model. - private String targetFeatureToUse; - - @Override - public void process(Document doc) { - if(isInterrupted()) { - interrupted = false; - throw new GateRuntimeException("Execution was requested to be interrupted"); - } - // extract the required annotation sets, - AnnotationSet inputAS = doc.getAnnotations(getInputASName()); - AnnotationSet instanceAS = inputAS.get(getInstanceType()); - - List- * Training, evaluation and application of ML in GATE.
- */ -@CreoleResource(name = "LF_ApplyTopicModel", - helpURL = "https://gatenlp.github.io/gateplugin-LearningFramework/LF_ApplyTopicModel", - comment = "Apply a trained topic model to document annotations") -public class LF_ApplyTopicModel extends LearningFrameworkPRBase { - - static final Logger LOGGER = Logger.getLogger(LF_ApplyTopicModel.class.getCanonicalName()); - private static final long serialVersionUID = 5851732674711579672L; - - protected URL dataDirectory; - - @RunTime - @CreoleParameter(comment = "The directory where all data will be stored and read from") - public void setDataDirectory(URL output) { - dataDirectory = output; - } - - public URL getDataDirectory() { - return this.dataDirectory; - } - - private String tokenAnnotationType = "Token"; - - @RunTime - @CreoleParameter(comment = "The annotation type representing the words/tokens to use", - defaultValue = "Token") - public void setTokenAnnotationType(String val) { - tokenAnnotationType = val; - } - - public String getTokenAnnotationType() { - return tokenAnnotationType; - } - - private String tokenFeature = "string"; - - @RunTime - @Optional - @CreoleParameter(comment = "The feature containing the token string to use, if empty, use document content", - defaultValue = "string") - public void setTokenFeature(String val) { - tokenFeature = val; - } - - public String getTokenFeature() { - return tokenFeature; - } - - - private String featurePrefix; - - @RunTime - @Optional - @CreoleParameter(comment="Prefix of the feature names written to the instance annotations", - defaultValue="LDA_") - public void setFeaturePrefix(String val) { - featurePrefix = val; - } - - public String getFeaturePrefix() { - return featurePrefix; - } - -//////////////////////////////////////////////////////////////////////////// - - private transient Engine engine; - - private URL savedModelDirectoryURL; - - @Override - public void process(Document doc) { - if(isInterrupted()) { - interrupted = false; - throw new GateRuntimeException("Execution was requested to be interrupted"); - } - // extract the required annotation sets - AnnotationSet inputAS = doc.getAnnotations(getInputASName()); - AnnotationSet tokenAS; - if(getTokenAnnotationType()==null || getTokenAnnotationType().isEmpty()) { - tokenAS = inputAS.get("Token"); - } else { - tokenAS = inputAS.get(getTokenAnnotationType()); - } - AnnotationSet instanceAS; - if (getInstanceType()!=null && !getInstanceType().isEmpty()) { - instanceAS = inputAS.get(getInstanceType()); - } else { - // if the instance annotation set has not been specified, we put a Document annotation - // into the default set for now, unless we already have one or more. - instanceAS = document.getAnnotations().get("Document"); - if(instanceAS.isEmpty()) { - gate.Utils.addAnn(inputAS, 0, doc.getContent().size(), "Document", Factory.newFeatureMap()); - instanceAS = document.getAnnotations().get("Document"); - } - } - EngineMBTopicsLDA engineLDA = (EngineMBTopicsLDA)engine; - engineLDA.applyTopicModel( - instanceAS, tokenAS, - getTokenFeature(), - getFeaturePrefix(), - getAlgorithmParameters()); - - } - - - @Override - public void controllerStarted(Controller controller) { - if (dataDirectory == null) { - throw new GateRuntimeException("Parameter dataDirectory not set!"); - } - if (savedModelDirectoryURL == null || !savedModelDirectoryURL.toExternalForm().equals(dataDirectory.toExternalForm())) { - savedModelDirectoryURL = dataDirectory; - } - // Restore the Engine - engine = Engine.load(savedModelDirectoryURL, getAlgorithmParameters()); - System.out.println("LF-Info: model loaded is now " + engine); - - if (engine.getModel() == null) { - throw new GateRuntimeException("Do not have a model, something went wrong."); - // System.err.println("WARNING: no internal model to apply, this is ok if an external model is used"); - } else { - System.out.println("LearningFramework: Applying model " - + engine.getModel().getClass() + " ..."); - } - - } - - -} diff --git a/src/main/java/gate/plugin/learningframework/LF_EvaluateClassification.java b/src/main/java/gate/plugin/learningframework/LF_EvaluateClassification.java deleted file mode 100644 index 0ab27fd..0000000 --- a/src/main/java/gate/plugin/learningframework/LF_EvaluateClassification.java +++ /dev/null @@ -1,318 +0,0 @@ -/* - * Copyright (c) 2015-2016 The University Of Sheffield. - * - * This file is part of gateplugin-LearningFramework - * (see https://github.com/GateNLP/gateplugin-LearningFramework). - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 2.1 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this software. If not, see- * TODO/NOTE: we should really also get the sequence annotation and limit - * resolving BIO to within each sequence. - *
- * NOTE: originally, this was just using B/I/O, we now changed to using
- * Type|B, Type|I and O. However, this should really get moved to the
- * corresponding SeqEncode subclass.
- *
- * @param instanceAS instance annotation set
- * @param outputAS output annotation set
- * @param minConfidence minimum confidence for making prediction, if null always
- */
- public static void addSurroundingAnnotations(
- AnnotationSet instanceAS, AnnotationSet outputAS, Double minConfidence) {
-
-
- // TODO!! we need to delegate this to the proper method of seqEncoder, in a way
- // that abstracts away a little from annotations etc., ideally!!!
- // Probably best to process a whole sequence everytime we call the seqEncoder method,
- // if we do not have a sequence, then a whole document.
-
- // map of open annotations, per sequence annotation type
- Map
- * This tries to handle both sequence and non-sequence corpora.
- *
- * @author Johann Petrak
- */
-public class CorpusRepresentationVolatileDense2JsonStream extends CorpusRepresentationVolatileBase {
-
- public static final String DATA_FILE_NAME = "crvd.data.json";
- public static final String META_FILE_NAME = "crvd.meta.json";
-
- private Logger LOGGER = org.apache.log4j.Logger.getLogger(CorpusRepresentationVolatileDense2JsonStream.class);
-
- private FileOutputStream outStream;
- private File outDir;
- private File outDataFile;
- private File outMetaFile;
- private FeatureInfo featureInfo; // the feature info from the feauture specification
- private List
- * NOTE: this method is automatically synchronized and should be save to use
- * from multiple threads
- *
- * !!!TODO: explain which methods are used by this to convert to dense
- * internal instance representation and then to the final output format.
- *
- * @param instancesAS instance annotation set
- * @param sequenceAS sequence annotation set
- * @param inputAS input annotation set
- * @param classAS class annotation set
- * @param targetFeatureName target feature name
- * @param targetType type of target
- * @param instanceWeightFeature weight feature name
- * @param nameFeatureName name feature name
- * @param seqEncoder sequence encoder instance
- */
- @Override
- public void add(
- AnnotationSet instancesAS,
- AnnotationSet sequenceAS,
- AnnotationSet inputAS,
- AnnotationSet classAS,
- String targetFeatureName,
- TargetType targetType,
- String instanceWeightFeature,
- String nameFeatureName,
- SeqEncoder seqEncoder) {
- // first of all, distinguish between processing for sequences and for non-sequences
- // if the sequenceAS parameter is non-null we process sequences of instances, otherwise we process plain instances
- setTargetType(targetType);
- String json;
- if (sequenceAS == null) {
- if (isSequence == null) {
- isSequence = false;
- } else if (isSequence) {
- throw new GateRuntimeException("Trying to add non-sequence after sequence has already been added");
- }
- // processing plain instances
- // For each instance, do this:
- List