Commit 47a6d32a authored by kristian.noullet's avatar kristian.noullet

Read

Meeee
parent a98f2114
# Agnos_mini
<h1>Quick Start Guide Steps</h1>
<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>
e.g. MY_KNOWLEDGE_GRAPH("./my_kg/") - henceforth we will denote the chosen KG's root path as $KG$.
<b>Note</b>: This will allow
1) A user/developer to specify particular configurations for a specific KG (e.g. surface forms for mention detection, underlying caching structures etc.)
2) Agnos to create the file tree as required by the system in the defined location, in this case under the execution's current directory in a $KG$ folder.
3) KG isolation in order to avoid unexpected interactions on the user-side.
</li>
<li>Run install/BuildFiletree.java - 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>).
Note:
1) If you define an input folder, all including files will be added to the Jena TDB.
2) If you already have an existing Apache Jena(-compatible) RDF Store, simply put it into $KG$/resources/data/datasets/graph.dataset .
4.1. (Semi-OPTIONAL) : Put SPARQL Queries to be executed on loaded KG for surface form extraction into appropriate folders.
If you already have a file containing surface forms and their related resources,
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>.
The line-wise split delimiter may be defined under <i>structure.config.Strings.java:ENTITY_SURFACE_FORM_LINKING_DELIM</i>, where at the resource is in first position and the defined literal in second.
</li>
<li>
</li>
</ol>
<h1>API</h1>
Code for NIF-format-based queries as well as calls through JSON are provided in:
NIFAPIAnnotator and JSONAPIAnnotator respectively.
\ No newline at end of file
......@@ -35,7 +35,7 @@ Post configuration, you may run Agnos by executing <i>launcher.LauncherLinking</
<ol start="0">
<li>Clone Repository</li>
<li>
Add wanted Knowledge Graph (KG) as an enum item to <i>structure/config/kg/EnumModelType</i>
Add wanted Knowledge Graph (KG) as a new 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>
......@@ -51,7 +51,7 @@ Post configuration, you may run Agnos by executing <i>launcher.LauncherLinking</
</ol>
</li>
<li>
Run install/BuildFiletree - as the name implies, it simply creates the file tree to make it easier to place wanted required files
Run <i>install/BuildFiletree</i> - as the name implies, it simply creates the file tree to make it easier to place files appropriately
</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>).
......
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