updated readme

Author: mommi84

README.md

@@ -1,15 +1,17 @@
-Mandolin
+![logo](https://github.com/mommi84/Mandolin/raw/master/mandolin-400px.png "Mandolin logo")
+
+MANDOLIN
 ========
 
-*Markov Logic Networks for Discovering Links.*
+*Markov Logic Networks for the Discovery of Links.*
 
 ## Requirements
 
 * Java 1.8+
-* Maven
 * PostgreSQL 9.4.x
-* Gurobi solver - [Get academic license](http://www.gurobi.com/academia/academia-center)
-* Unzip
+* Gurobi solver
+* Maven
+* Wget, Unzip
 
 ## Quick start
 
@@ -18,24 +20,28 @@ Mandolin
 
 ## Experiments
 
-The following command will discover new links of any predicate (`--aim`) on the WordNet dataset (`--input`) with mining threshold 0.9 (`--mining`) and 1 million Gibbs sampling iterations (`--sampling`).
+The following command will discover new links of any predicate (`--aim`) on the WordNet dataset (`--input`) with mining threshold 0.8 (`--mining`) and 1 million Gibbs sampling iterations (`--sampling`).
 
 ```bash
-java -Xmx1g -jar target/Mandolin-0.4.0-jar-with-dependencies.jar plain --input data/benchmark/wn18/wordnet-mlj12-train.nt,data/benchmark/wn18/wordnet-mlj12-valid.nt --output eval/wn18 --mining 0.9 --sampling 1000000 --aim "*"
+java -Xmx1g -jar target/Mandolin-0.4.0-jar-with-dependencies.jar plain --input data/benchmark/wn18/wordnet-mlj12-train.nt,data/benchmark/wn18/wordnet-mlj12-valid.nt --output eval/wn18 --mining 0.8 --sampling 1000000 --aim "*"
 ```
 
-Discovered links can be found in the `--output` folder at `./eval/wn18/discovered_X.nt`, where `X` is the output threshold.
+Discovered links can be found in the `--output` folder at `./eval/wn18/discovered_X.nt`, where `X` is the output threshold, meaning that a file contains all links whose confidence is greater or equal than `X`.
 
-An excerpt of the discovered **rules and weights** for this execution.
+An excerpt of the discovered **rules and weights**:
 
 ```text
-0.990517419		wn18:\_part\_of(b, a) => \_has\_part(a, b)
+0.990517419  wn18:_part_of(b, a) => wn18:_has_part(a, b)
+0.862068966  wn18:_instance_hypernym(a, c) AND wn18:_synset_domain_topic_of(f, b) => wn18:_synset_domain_topic_of(a, b)
 ```
 
-An excerpt of the discovered **links** for this execution:
+An excerpt of the discovered **links** with confidence > 0.9:
 
 ```text
-
+wn18:08131530 wn18:_has_part wn18:08132046 .
+wn18:09189411 wn18:_has_part wn18:08707917 .
+wn18:10484858 wn18:_synset_domain_topic_of wn18:08441203 .
+wn18:01941987 wn18:_synset_domain_topic_of wn18:00300441 .
 ```
 
 ### Basic documentation
@@ -62,7 +68,7 @@ Parameters for `plain` goal:
 `--input`|Comma-separated N-Triple files.|`data1.nt,data2.nt`
 `--output`|Workspace and output folder.|`eval/experiment1`
 `--aim`|Aim predicate. For all predicates use wildcard `*`.|`http://www.w3.org/2002/07/owl#sameAs`
-`--mining`|Rule mining threshold.|`0.9` (default: `0.1`)
+`--mining`|Rule mining threshold.|`0.9` (default: `0.0` support)
 `--sampling`|Gibbs sampling iterations.|`1000000` (default: 100 x evidence size)
 `--rules`|Maximum number of rules.|`1500` (default: none)
 `--sim`|Enable similarity among literals as `min,step,max`.|`0.8,0.1,0.9` (default: none)
@@ -135,3 +141,4 @@ sh pgsql-start.sh
 **AMIE** is licensed under Creative Commons Attribution-NonComercial license v3.0.
 **ProbKB** is licensed under the BSD license.
 **RockIt** is licensed under the MIT License.
+**Gurobi** can be activated using a [free academic license](http://www.gurobi.com/academia/academia-center).