Commit e4bc4a3d authored by kristian.noullet's avatar kristian.noullet

Removed .java extensions for beautification

parent baa16e66
......@@ -3,7 +3,7 @@
<ol start="0">
<li>Clone Repository</li>
<li>
Add wanted Knowledge Graph (KG) as an enum item to <i>structure/config/kg/EnumModelType.java</i>
Add wanted Knowledge Graph (KG) as an enum item to <i>structure/config/kg/EnumModelType</i>
<br>e.g. MY_KNOWLEDGE_GRAPH("./my_kg/") - henceforth we will denote the chosen KG's root path as $KG$.
<br><b>Note</b>: This will allow
<ol>
......@@ -20,7 +20,7 @@
</li>
<br>
<li>
Run install/BuildFiletree.java - as the name implies, it simply creates the file tree to make it easier to place wanted required files
Run install/BuildFiletree - as the name implies, it simply creates the file tree to make it easier to place wanted required files
</li>
<li>
Load KG into an RDF Store by defining the location of your RDF-based KG within <i>install.LauncherSetupTDB:KGpath</i> and running it for your defined KG (in <i>install.LauncherSetupTDB:KG</i>).
......@@ -39,8 +39,8 @@
<li>
Put SPARQL Queries to be executed on loaded KG for surface form extraction into appropriate folders.
<br>If you already have a file containing surface forms and their related resources,
<br>please put it in $KG$/resources/data/links_surfaceForms.txt (the filepath may be changed in <i>structure.config.FilePaths.java:FILE_ENTITY_SURFACEFORM_LINKING</i>.
<br>The line-wise split delimiter may be defined under <i>structure.config.Strings.java:ENTITY_SURFACE_FORM_LINKING_DELIM</i>, where the resource is in first position and the defined literal in second.
<br>please put it in $KG$/resources/data/links_surfaceForms.txt (the filepath may be changed in <i>structure.config.FilePaths:FILE_ENTITY_SURFACEFORM_LINKING</i>.
<br>The line-wise split delimiter may be defined under <i>structure.config.Strings:ENTITY_SURFACE_FORM_LINKING_DELIM</i>, where the resource is in first position and the defined literal in second.
</li>
<li>
Define <i>install.LauncherExecuteQueries:KG</i> with the defined KG and run it. The program will extract appropriate surface forms from your defined KG, outputting them appropriately for the system to process.
......@@ -56,20 +56,20 @@
</ol>
<h1>Running Agnos</h1>
Post-configuration, you may run Agnos by executing <i>launcher.LauncherLinking.java</i>
Post-configuration, you may run Agnos by executing <i>launcher.LauncherLinking</i>
<br>It takes a string input, applies exact case-insensitive mention detection on it, followed by candidate generation and default disambiguation behaviour.
<br>Results are output to the console.
<br>There also exists launcher.LauncherLinkingSample.java - an easily modifiable sample on how the annotation code process looks like.
<br>There also exists launcher.LauncherLinkingSample - an easily modifiable sample on how the annotation code process looks like.
<br>
<br><h1>API</h1>
<br>Code for NIF-format-based queries (<i>api.NIFAPIAnnotator.java</i>) as well as calls through JSON (<i>api.JSONAPIAnnotator.java</i>) are provided mainly for API-usage.
<br>Code for NIF-format-based queries (<i>api.NIFAPIAnnotator</i>) as well as calls through JSON (<i>api.JSONAPIAnnotator</i>) are provided mainly for API-usage.
<br>A very basic API front-end page may be downloaded from <a href="https://km.aifb.kit.edu/sites/agnos-demo/">Agnos</a> and used locally.
<h1>Mention Detection</h1>
<br>Out-of-the-box Agnos provides users with 2 main mention detection mechanisms:
<ul>
<li>linking.mentiondetection.exact.MentionDetectorMap (Exact matching)</li>
<li>linking.mentiondetection.fuzzy.MentionDetectorLSH (Fuzzy matching)</li>
<li><i>linking.mentiondetection.exact.MentionDetectorMap</i> (Exact matching)</li>
<li><i>linking.mentiondetection.fuzzy.MentionDetectorLSH</i> (Fuzzy matching)</li>
</ul>
<br>Former performs mention detection by checking whether a possible input is contained within a passed map instance.
<br>Latter utilizes locality-sensitive hashing techniques (MinHash), allowing detection with a user-defined grade of fuzziness.
......@@ -91,6 +91,6 @@ Post-configuration, you may run Agnos by executing <i>launcher.LauncherLinking.j
<br>Among others, through use of its <i>structure.interfaces.Scorer</i> and <i>structure.interfaces.PostScorer</i> interfaces.
<br>The difference between the two is that <i>structure.interfaces.Scorer</i> is assumed to be a so-called apriori scoring mechanism (meaning single candidate scores are independant of other candidates), whereas <i>structure.interfaces.PostScorer</i> instances attribute different scores to candidate entities, depending on other candidate entities they are detected with, therewith allowing for the notion of "context" to play a role.
<br>An example of a <i>structure.interfaces.Scorer</i> instance would be our PageRankScorer.
<br>For <i>structure.interfaces.PostScorer</i> instances, we provide <i>linking.disambiguation.scorers.GraphWalkEmbeddingScorer.java</i> and <i>VicinityScorerDirectedSparseGraph.java</i>, among others.
<br>For <i>structure.interfaces.PostScorer</i> instances, we provide <i>linking.disambiguation.scorers.GraphWalkEmbeddingScorer</i> and <i>VicinityScorerDirectedSparseGraph</i>, among others.
<br>Defining which scoring mechanisms may be used for disambiguation is configurable through the defined <i>linking.disambiguation.Disambiguator</i> instance by calling the <i>addScorer(...)</i> and <i>addPostScorer(...)</i> methods, respectively.
<br>How single scorers' scores are combined may be defined within their own implementation which is then applied through our consolidation mechanism <i>linking.disambiguation.ScoreCombines.java</i>.
\ No newline at end of file
<br>How single scorers' scores are combined may be defined within their own implementation which is then applied through our consolidation mechanism <i>linking.disambiguation.ScoreCombines</i>.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment