Commit fb700924 authored by Grzegorz Kostkowski's avatar Grzegorz Kostkowski

Update README

parent ceab8709
1. DESCRIPTION
# DESCRIPTION
This tool annotates a document with URLs of corresponidng entities.
Linker parses annotated tokens/groups of tokens to spot expressions which
......@@ -18,15 +18,13 @@ of whole expression.
As a result, *.ccl document is returned with included URL annotations.
2. DEPENDENCIES
- python 2.x
- py2neo
# DEPENDENCIES
All dependencies included in [requirements.txt](requirements.txt).
All dependencies included in requirements.txt.
# USAGE
3. USAGE
elinker path/to/ccl/doc.xml path/for/results/output_doc.xml
For help and detailed description type: elkr "--help".
```bash
elinker -d path/to/ccl/doc.xml -o path/for/results/output_doc.xml
```
For help and detailed description type: ```elinker --help```.
1. DESCRIPTION
This tool annotates a document with URLs of corresponidng entities.
Linker parses annotated tokens/groups of tokens to spot expressions which
have to be described by mentioned URL.
URLs are taken from semantic graph of connected resources.
Linker accepts *.ccl file with annotations of following type:
- mwe (multi-word expressions)
- ne (named entities)
- wsd (word sense disambiguation - annottated with syn_id)
Note: in current version, multi-word expressions (including named entity)
have precedence over disambiguated words. It's the case when
word annotated with wsd have been included in multi-word expression.
Then in many cases sesnse of this single word will differ from sense
of whole expression.
As a result, *.ccl document is returned with included URL annotations.
2. DEPENDENCIES
- python 2.x
- py2neo
All dependencies included in requirements.txt.
3. USAGE
elinker path/to/ccl/doc.xml path/for/results/output_doc.xml
For help and detailed description type: elkr "--help".
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