Update README and co

Author: VictorSanh

README.md

@@ -1,6 +1,6 @@
 # HMTL (Hierarchical Multi-Task Learning model) 
 
-*A Hierarchical Multi-Task Approach for Learning Embeddings from Semantic Tasks*\
+__A Hierarchical Multi-Task Approach for Learning Embeddings from Semantic Tasks__\
 Victor SANH, Thomas WOLF, Sebastian RUDER\
 AAAI 2019
 

demo/HMTL_demo.png

@@ -2,33 +2,29 @@
 
 ## Introduction
 
-HuggingNLP is an open-source library for resolving four fundamental tasks in NLP, namely Named Entity Recognition, Entity Mention Detection, Relation Extraction and Coreference Resolution.
+HMTL is an open-source library for resolving four fundamental tasks in NLP, namely Named Entity Recognition, Entity Mention Detection, Relation Extraction and Coreference Resolution using multi-task learning.
 
-## Setup
+For a brief introduction to multi-task learning, you can refer to our blog post (LINK TO COME). Each of the four tasks considered is detailed in the following section. 
 
-Adapt and launch `machine_setup.sh`.
+The web interface for the demo can be found here () for you to try and play with it. HMTL comes with the web visualization client if you prefer to run it on your own.
 
-## Launch a server
+<img src="https://github.com/huggingface/hmtl/demo/blob/master/HMTL_demo.png" alt="HMTL Demo" width="600"/>
 
-We also release three pre-trained HMTL models.
+## Setup
 
-| Model Name | NER (F1) | EMD (F1) | RE (F1) | CR(F1 on CoNLL2012) |
-| --- | --- | --- | --- | --- |
-| conll_small_elmo | 85.73 | 83.51 | 58.40 | 62.85 |
-| conll_medium_elmo | 86.41 | 84.02 | 58.78 | 61.62 |
-| conll_full_elmo _(default model)_ | 86.40 | 85.59 | 61.37 | 62.26 |
+The demo (LINK TO COME) is based on Python 3.6 and [AllenNLP](https://github.com/allenai/allennlp).
 
-To launch a specific model (please make sure to be in a valid environment before: `source pyhuggingnlp/bin/activate`):
+The easiest way to setup a clean and working environment with the necessary dependencies is to refer to the setup section in the [parent folder](https://github.com/huggingface/hmtl#dependecies-and-installation).
+A few supplementary dependecies are listed in `requirements.txt`  and are required to run the demo.
 
-```bash
-gunicorn -w 2 -b:8000 'server:build_app(model_name="<model_name>", mode="<demo_or_prod>")'
-```
+We also release three pre-trained HMTL models.
 
-or launching the default model and mode:
+| Model Name | NER (F1) | EMD (F1) | RE (F1) | CR(F1 on CoNLL2012) | Description |
+| --- | --- | --- | --- | --- | --- |
+| conll_small_elmo | 85.73 | 83.51 | 58.40 | 62.85 | Small version of ELMo |
+| conll_medium_elmo | 86.41 | 84.02 | 58.78 | 61.62 | Medium version of ELMo |
+| conll_full_elmo _(default model)_ | 86.40 | 85.59 | 61.37 | 62.26 | Original version of ELMo |
 
-```bash
-gunicorn -w 2 -b:8000 'server:build_app()'
-```
 
 ## Description of the tasks
 
@@ -40,7 +36,7 @@ The different types of relation are the following:
 
 | Shortname | Full Name | Description | Example |
 | --- | --- | -- | -- |
-| ART | Artifact | User-Owner-Inventor-Manufacturer | {Pablo Picasso painted the Joconde., ARG1 = Pablo Picasso, ARG2 = Joconde} |
+| ART | Artifact | User-Owner-Inventor-Manufacturer | {Leonard de Vinci painted the Joconde., ARG1 = Leonard de Vinci, ARG2 = Joconde} |
 | GEN-AFF | Gen-Affiliation | Citizen-Resident-Religion-Ethnicity, Org-Location | {The people of Iraq., ARG1 =  The people, ARG2 = Iraq} |
 | ORG-AFF | Org-Affiliation | Employment, Founder, Ownership, Student-Alum, Sports-Affiliation, Investor-Shareholder, Membership | {Martin Geisler, ITV News, Safwan southern Iraq., ARG1 = Martin Geisler, ARG2 = ITV News} |
 | PART-WHOLE | Part-whole | Artifact, Geographical, Subsidiary | {They could safeguard the fields in Iraq., ARG1 = the fields, ARG2 = Iraq} |
@@ -53,8 +49,23 @@ For more details, please refer to the [dataset release notes](https://pdfs.seman
 ### Coreference Resolution (CR)
 
 
-## Performance of the model
+## Using HMTL as a server
+
+To launch a specific model (please make sure to be in a valid environment before: `source .env/bin/activate`):
 
-| NER | EMD | RE | CR |
-| --- | --- | -- | ---|
-|     |     |    |    | 
+```bash
+gunicorn -w 2 -t 60 -b:8000 'server:build_app(model_name="<model_name>")'
+```
+
+or launching the default model:
+
+```bash
+gunicorn -w 2 -b:8000 'server:build_app()'
+```
+
+## References
+
+```
+@article{
+}
+```

demo/README.md

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-### Install git-lfs ###
+### Install git-lfs (only necessary to download pre-trained models) ###
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
 sudo apt-get install git-lfs
 git lfs install