[DL-Learner SVN] SF.net SVN: dl-learner: [746] trunk/doc/configOptions.txt

[<ku...@us...>]

Revision: 746
          http://dl-learner.svn.sourceforge.net/dl-learner/?rev=746&view=rev
Author:   kurzum
Date:     2008-04-01 03:24:36 -0700 (Tue, 01 Apr 2008)

Log Message:
-----------
updated docs

Modified Paths:
--------------
    trunk/doc/configOptions.txt

Modified: trunk/doc/configOptions.txt
===================================================================
--- trunk/doc/configOptions.txt	2008-04-01 10:23:30 UTC (rev 745)
+++ trunk/doc/configOptions.txt	2008-04-01 10:24:36 UTC (rev 746)
@@ -7,6 +7,9 @@
 component: KB file (org.dllearner.kb.KBFile)
 ============================================
 
+Usage:
+import("kbFileName.kb");
+
 option name: filename
 description: pointer to the KB file on local file system
 values: class org.dllearner.core.config.StringConfigOption
@@ -20,6 +23,9 @@
 component: OWL file (org.dllearner.kb.OWLFile)
 ==============================================
 
+Usage:
+import("owlFileName.owl");
+
 option name: url
 description: URL pointing to the OWL file
 values: class org.dllearner.core.config.StringConfigOption
@@ -28,6 +34,9 @@
 component: SPARQL Endpoint (org.dllearner.kb.sparql.SparqlKnowledgeSource)
 ==========================================================================
 
+Usage:
+Example: import("http://dbpedia.openlinksw.com:8890/sparql","SPARQL");
+
 option name: url
 description: URL of SPARQL Endpoint
 values: class org.dllearner.core.config.StringConfigOption
@@ -160,6 +169,9 @@
 component: DIG reasoner (org.dllearner.reasoning.DIGReasoner)
 =============================================================
 
+Usage:
+reasoner = dig;
+
 option name: reasonerUrl
 description: URL of the DIG reasoner
 values: class org.dllearner.core.config.StringConfigOption
@@ -175,12 +187,24 @@
 values: class org.dllearner.core.config.StringConfigOption
 default value: log/digProtocol.txt
 
+component: fast instance checker (org.dllearner.reasoning.FastInstanceChecker)
+==============================================================================
+
+Usage:
+reasoner = fastInstanceChecker;
+
 component: fast retrieval reasoner (org.dllearner.reasoning.FastRetrievalReasoner)
 ==================================================================================
 
+Usage:
+reasoner = XXX;
+
 component: OWL API reasoner (org.dllearner.reasoning.OWLAPIReasoner)
 ====================================================================
 
+Usage:
+reasoner = owlAPI;
+
 option name: reasonerType
 description: FaCT++ or Pellet
 values: class org.dllearner.core.config.StringConfigOption
@@ -193,6 +217,9 @@
 component: two valued definition learning problem (org.dllearner.learningproblems.PosNegDefinitionLP)
 =====================================================================================================
 
+Usage:
+problem = XXX DEFAULT
+
 option name: positiveExamples
 description: positive examples
 values: class org.dllearner.core.config.StringSetConfigOption
@@ -221,6 +248,9 @@
 component: inclusion learning problem (org.dllearner.learningproblems.PosNegInclusionLP)
 ========================================================================================
 
+Usage:
+problem = posNegInclusion;
+
 option name: positiveExamples
 description: positive examples
 values: class org.dllearner.core.config.StringSetConfigOption
@@ -249,6 +279,9 @@
 component: positive only definition learning problem (org.dllearner.learningproblems.PosOnlyDefinitionLP)
 =========================================================================================================
 
+Usage:
+problem = posOnlyDefinition;
+
 option name: positiveExamples
 description: positive examples
 values: class org.dllearner.core.config.StringSetConfigOption
@@ -261,6 +294,9 @@
 component: brute force learning algorithm (org.dllearner.algorithms.BruteForceLearner)
 ======================================================================================
 
+Usage:
+null
+
 option name: maxLength
 description: maximum length of generated concepts
 values: class org.dllearner.core.config.IntegerConfigOption
@@ -274,6 +310,9 @@
 component: random guesser learning algorithm (org.dllearner.algorithms.RandomGuesser)
 =====================================================================================
 
+Usage:
+null
+
 option name: numberOfTrees
 description: number of randomly generated concepts/trees
 values: class org.dllearner.core.config.IntegerConfigOption
@@ -287,6 +326,9 @@
 component: genetic programming learning algorithm (org.dllearner.algorithms.gp.GP)
 ==================================================================================
 
+Usage:
+null
+
 option name: selectionType
 description: selection type
 values: class org.dllearner.core.config.StringConfigOption
@@ -370,6 +412,9 @@
 component: example driven refinement operator based learning algorithm (org.dllearner.algorithms.refexamples.ExampleBasedROLComponent)
 ======================================================================================================================================
 
+Usage:
+algorithm = refexamples;
+
 option name: writeSearchTree
 description: specifies whether to write a search tree
 values: class org.dllearner.core.config.BooleanConfigOption
@@ -460,14 +505,27 @@
 values: class org.dllearner.core.config.BooleanConfigOption
 default value: null
 
+option name: useBooleanDatatypes
+description: specifies whether boolean datatypes are used in the learning algorothm
+values: class org.dllearner.core.config.BooleanConfigOption
+default value: null
+
 option name: noisePercentage
 description: the (approximated) percentage of noise within the examples
-values: class org.dllearner.core.config.DoubleConfigOption min 0.0 max 1.0
+values: class org.dllearner.core.config.DoubleConfigOption min 0.0 max 100.0
 default value: null
 
+option name: startClass
+description: the named class which should be used to start the algorithm (GUI: needs a widget for selecting a class)
+values: class org.dllearner.core.config.StringConfigOption
+default value: null
+
 component: refinement operator based learning algorithm (org.dllearner.algorithms.refinement.ROLearner)
 =======================================================================================================
 
+Usage:
+algorithm = refinement;
+
 option name: writeSearchTree
 description: specifies whether to write a search tree
 values: class org.dllearner.core.config.BooleanConfigOption
@@ -563,3 +621,8 @@
 values: class org.dllearner.core.config.BooleanConfigOption
 default value: null
 
+option name: useBooleanDatatypes
+description: specifies whether boolean datatypes are used in the learning algorothm
+values: class org.dllearner.core.config.BooleanConfigOption
+default value: null
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.